Jump to content

Module:Progression rainbow

Permanently protected module
From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Izno (talk | contribs) at 00:12, 28 October 2020 (remove frame from category_count). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

--[[
This implements {{progression rainbow}}

]]
require ('Module:No globals')

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

-- 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 class_percent(param, divisor)
	return tostring(round(100 * param / divisor)) .. '%'
end

local function percent_remaining(sum, divisor)
	sum = sum - divisor
	if sum ~= 0 then -- find this a bit specious
		return tostring(round(-100 * sum / divisor)) .. '%'
	else
		return nil
	end
end

local function category_count(category, project)
	return mw.site.stats.pagesInCategory(
		category .. ' ' .. project .. ' articles',
		'pages'
	)
end

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args, frame)
		-- pretty sure that this call to extensionTag should be in _main
		-- since a caller from a module should get the associated styles also
end

function p._main(args, frame)
-- is there a way that I can avoid passing a reference to the parent frame?
-- I need to be able to access extensionTag in p._main
-- these are defined on frame

	local classes = {
		{count = 0, class = 'List', category = 'List-Class'},
		{count = 0, class = 'Stub', category = 'Stub-Class'},
		{count = 0, class = 'Start', category = 'Start-Class'},
		{count = 0, class = 'C', category = 'C-Class'},
		{count = 0, class = 'B', category = 'B-Class'},
		{count = 0, class = 'GA', category = 'GA-Class'},
		{count = 0, class = 'A', category = 'A-Class'},
		{count = 0, class = 'FA', category = 'FA-Class'}
	}
	
	local project_classes = {
		{count = 0, class = 'FL', category = 'FL-Class'},
		{count = 0, class = 'Unassessed', category = 'Unassessed'}
	}

	local project
	if args['project'] and args['project'] ~= '' then
		project = args['project']
	else
		project = nil
	end
	
	local sum_classes = 0
	if project then
		for i, class in pairs(classes) do
			class['count'] = category_count(class['category'], project)
			if class['class'] == 'FA' then
				class['count'] = class['count'] + category_count(
					project_classes[1]['category'],
					project
				)
			end
			sum_classes = sum_classes + class['count']
		end
	else
		for i, class in pairs(classes) do
			if args[i] then
				class['count'] = tonumber(args[i])
				sum_classes = sum_classes + class['count']
			end
		end
	end

	local divisor
	if project then
		divisor = sum_classes + category_count(
			project_classes[2]['category'],
			project
		)
	else
		divisor = args[9] or 100
	end
	
	local root = mw.html.create('table')
	root:addClass('progression-rainbow')
		:attr('role', 'presentation')

	for i, class in pairs(classes) do
		if class['count'] ~= 0 then
			local percentage = class_percent(class['count'], divisor)
			root:newline()
				:tag('td')
				:css('background', frame:expandTemplate{
					title = 'class/colour', args = { class['class'] }}
				)
				:css('width', percentage)
				:tag('span')
				:wikitext(percentage .. " " .. class['category'])
				:done()
				:done()
		end
	end
	root:newline()
	
	local remaining = percent_remaining(sum_classes, divisor)
	if remaining then
		root:tag('td')
		:addClass('remaining')
		:css('width', remaining)
		:tag('span')
		:wikitext(remaining .. " remaining")
		:done()
		:done()
		:newline()
	end
	-- not sure if I should be stringifying p._main return instead of returning
	-- a table
	return frame:extensionTag{
		name = 'templatestyles',
		args = { src = 'Progression rainbow/styles.css'}
	} .. '\n' .. tostring(root)
end

return p