Module:WikiProject assessment progression/sandbox: Difference between revisions

Module documentation[view] [edit] [history] [purge]

This module calculates the proportion of articles in a given WikiProject that have been assessed for quality ratings (i.e. any articles that are not tagged as "Unassessed"), and returns this as a simple number. It is used by {{WikiProject assessment progression}} to populate the value for a progress bar that updates automatically based on category memberships.

Usage

{{#invoke:WikiProject assessment progression|main}}

When invoked by a template that supplies a parameter called "project", it will use that parameter as a WikiProject name for class-rating categories, and return the percentage of articles in those categories that are not listed as "Unassessed". This value is a number (with one decimal place) returned as a string.

See also

• Module:Progression rainbow
• Template:WikiProject assessment progression

The above documentation is transcluded from Module:WikiProject assessment progression/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.

require('Module:No globals')

local assessedClasses = {
	'List','Stub','Start','C','B',
	'GA','A','FA','FL','FM',
	'Book','Category','Disambig','File',
	'Portal','Project','Redirect','Template',
}

local p = {}
local getArgs = require('Module:Arguments').getArgs
local errorMessage = require('Module:Error')

local function categoryCount(category, project)
	return mw.site.stats.pagesInCategory(
		string.format('%s %s articles', category, project),
		'pages'
	)
end

-- rounding to first decimal, from http://lua-users.org/wiki/SimpleRound
local function round(num)
	return math.floor(num * 10 + 0.5) / 10
end

local function percentComplete(sum, total)
	return tostring(round(100 * sum / total))
end

local function countCategoryArticles(classesToCount, project)
	local classCount = 0
	for _, class in ipairs(classesToCount) do
		classCount = classCount + categoryCount(class..'-Class', project)
	end
	return classCount
end

local function calculateProjectTotal(project)
	return countCategoryArticles(assessedClasses, project) + categoryCount('Unassessed', project)
end

local function setClasses(args)
	local classes = {}
	if args['class'] then
		classes = {args['class']}
	else
		classes = assessedClasses
	end
	return classes
end

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local project = args['project']
	local classes = setClasses(args)
	local classCount = countCategoryArticles(classes, project)
	local total = calculateProjectTotal(project)
	if total == 0 then
		return errorMessage('Error: project not found for project name "'..project..'"')
	else
		return percentComplete(classCount, total)
	end
end

return p