Module:Progress box/sandbox - Revision history

Lemondoge: enhanced concision of overly verbose condition

2023-04-13T01:21:23Z

enhanced concision of overly verbose condition

← Previous revision		Revision as of 01:21, 13 April 2023
Line 129:		Line 129:

	-- Set data		-- Set data
	if not args.float or ~~(args.float and~~ (args.float == 'left' or args.float == '')) then		if not args.float or (args.float == 'left' or args.float == '') then
	self._float_class = 'maint-cat-progress-left'		self._float_class = 'maint-cat-progress-left'
	elseif args.float == 'right' then		elseif args.float == 'right' then

Izno: add -center

2023-03-01T04:16:45Z

add -center

← Previous revision		Revision as of 04:16, 1 March 2023
Line 133:		Line 133:
	elseif args.float == 'right' then		elseif args.float == 'right' then
	self._float_class = 'maint-cat-progress-right'		self._float_class = 'maint-cat-progress-right'
			elseif args.float == 'none' then
	-- none case not covered here as it's just the default class
			-- 'none' is actually 'center'ed
			self._float_class = 'maint-cat-progress-center'
	end		end

Izno: fix

2023-02-26T20:25:58Z

fix

← Previous revision		Revision as of 20:25, 26 February 2023
Line 307:		Line 307:
	:wikitext(self:getFormattedTotalCount())		:wikitext(self:getFormattedTotalCount())

	return mw.~~getParentFrame~~():extensionTag{		return mw.getCurrentFrame():extensionTag{
	name = 'templatestyles', args = {src = 'Module:Progress box/styles.css'}		name = 'templatestyles', args = {src = 'Module:Progress box/styles.css'}
	} .. tostring(root)		} .. tostring(root)

Izno: use divs

2023-02-26T20:22:36Z

use divs

← Previous revision		Revision as of 20:22, 26 February 2023
Line 129:		Line 129:

	-- Set data		-- Set data
	~~self._float~~ = args.float or 'left'		if not args.float or (args.float and (args.float == 'left' or args.float == '')) then
			self._float_class = 'maint-cat-progress-left'
	self._margin = args.float == 'none' and 'auto' or nil
			elseif args.float == 'right' then
			self._float_class = 'maint-cat-progress-right'
			-- none case not covered here as it's just the default class
			end

	self._header = args[1]		self._header = args[1]
	self._frame = mw.getCurrentFrame()		self._frame = mw.getCurrentFrame()
Line 240:		Line 245:
	function ProgressBox:__tostring()		function ProgressBox:__tostring()
	data = data or {}		data = data or {}
	local root = mw.html.create('~~table~~')		local root = mw.html.create('div')

	-- Base classes and styles		-- Base classes and styles
	root		root
	:addClass('~~infobox~~')		:addClass('maint-cat-progress')
	:~~css~~(~~'float',~~ self.~~_float~~)		:addClass(self._float_class)
	:css('clear', self._float)
	:css('margin', self._margin)
	:css('width', '22em')

	-- Header row		-- Header row
	root:tag('~~tr'):tag('th~~')		root:tag('div')
			:addClass('maint-cat-progress-header')
	:attr('colspan', 2)
	:addClass('navbox-title')
	:css('padding', '0.2em')
	:css('font-size', '125%')
	:wikitext(self._header)		:wikitext(self._header)

	-- Refresh row		-- Refresh row
	root:tag('~~tr'):tag('td~~')		root:tag('div')
			:addClass('maint-cat-progress-refresh')
	:attr('colspan', 2)
	:css('text-align', 'center')
	:wikitext(makePurgeLink{self:message('purge-link-display')})		:wikitext(makePurgeLink{self:message('purge-link-display')})

	-- Subtotals		-- Subtotals
	local subtotalTable = ~~root~~		local subtotalTable = mw.html.create('table')
⚫	:tag('tr')
	:tag('td')
	:attr('colspan', 2)
	:css('padding', 0)
	:tag('table')
⚫	:addClass('collapsible')
⚫	:addClass(self:isCollapsed() and 'collapsed' or nil)
	:css('width', '100%')
	:css('margin', 0)
	subtotalTable		subtotalTable
		⚫	:addClass('maint-cat-progress-subtotals mw-collapsible')
	:tag('tr')
		⚫	:addClass(self:isCollapsed() and 'mw-collapsed' or nil)
	:tag('th')
	:~~attr~~('~~colspan~~'~~, 2~~)		:tag('caption')
	:wikitext(self:message('subtotal-heading'))		:wikitext(self:message('subtotal-heading'))
		⚫
	for i, datedCategoryObj in ipairs(self._datedCategories) do		for i, datedCategoryObj in ipairs(self._datedCategories) do
	subtotalTable		subtotalTable
Line 289:		Line 279:
	:done()		:done()
	:tag('td')		:tag('td')
	:css('text-align', 'right')
	:wikitext(datedCategoryObj:getFormattedCount())		:wikitext(datedCategoryObj:getFormattedCount())
	end		end
Line 302:		Line 291:
	:done()		:done()
	:tag('td')		:tag('td')
	:css('text-align', 'right')
	:wikitext(self._baseCategoryObj:getFormattedCount())		:wikitext(self._baseCategoryObj:getFormattedCount())
			:allDone()

	-- Total		-- Total
	root		root
	:~~tag~~(~~'tr'~~)		:node(subtotalTable)
	:~~css~~('~~font-size', '110%~~')		:tag('div')
			:addClass('maint-cat-progress-total-row')
	:tag('td')
		⚫	:tag('div')
⚫	:wikitext(~~string.format("'''%s'''",~~ self:makeTotalLabel()))
			:addClass('maint-cat-progress-total-label')
		⚫	:wikitext(self:makeTotalLabel())
	:done()		:done()
	:tag('td')		:tag('div')
	:~~css~~('~~text~~-~~align', 'right~~')		:addClass('maint-cat-progress-total')
	:wikitext(~~string.format~~(		:wikitext(self:getFormattedTotalCount())
	"'''%s'''",
	self:getFormattedTotalCount()
⚫	))

	return ~~tostring~~(~~root~~)		return mw.getParentFrame():extensionTag{
			name = 'templatestyles', args = {src = 'Module:Progress box/styles.css'}
			} .. tostring(root)
	end		end

Mr. Stradivarius: typo

2016-01-20T10:20:23Z

typo

← Previous revision		Revision as of 10:20, 20 January 2016
Line 56:		Line 56:
	if not self._count then		if not self._count then
	local counts = mw.site.stats.pagesInCategory(self:getCategory(), '*')		local counts = mw.site.stats.pagesInCategory(self:getCategory(), '*')
	self._count = ~~count~~[self._whatToCount or 'pages']		self._count = counts[self._whatToCount or 'pages']
	if not self._count then		if not self._count then
	error("the count type must be one of 'pages', 'subcats', 'files' or 'all'")		error("the count type must be one of 'pages', 'subcats', 'files' or 'all'")

Mr. Stradivarius: add "count" parameter to allow counting subcats or files

2016-01-20T10:19:51Z

add "count" parameter to allow counting subcats or files

← Previous revision		Revision as of 10:19, 20 January 2016
Line 34:		Line 34:
	local self = setmetatable({}, Category)		local self = setmetatable({}, Category)
	self._cfg = data.cfg		self._cfg = data.cfg
			self._whatToCount = data.whatToCount
	self:setCategory(data.category)		self:setCategory(data.category)
	return self		return self
Line 54:		Line 55:
	function Category:getCount()		function Category:getCount()
	if not self._count then		if not self._count then
	~~self._count~~ = mw.site.stats.pagesInCategory(self:getCategory(), '~~pages~~')		local counts = mw.site.stats.pagesInCategory(self:getCategory(), '*')
			self._count = count[self._whatToCount or 'pages']
			if not self._count then
			error("the count type must be one of 'pages', 'subcats', 'files' or 'all'")
			end
	end		end
	return self._count		return self._count
Line 143:		Line 148:
	local cfg = self._cfg		local cfg = self._cfg
	local baseCategory = args[2] or self._baseCategoryObj:getCategory()		local baseCategory = args[2] or self._baseCategoryObj:getCategory()
			local whatToCount = args.count
	local from = args.from or self:message('dated-category-format-from')		local from = args.from or self:message('dated-category-format-from')
	local suffix = args.suffix		local suffix = args.suffix
Line 152:		Line 158:
	cfg = cfg,		cfg = cfg,
	baseCategory = baseCategory,		baseCategory = baseCategory,
			whatToCount = whatToCount,
	from = from,		from = from,
	suffix = suffix,		suffix = suffix,

Mr. Stradivarius: fix base category name bug

2015-05-18T02:19:24Z

fix base category name bug

← Previous revision		Revision as of 02:19, 18 May 2015
Line 130:		Line 130:

	-- Make the base category object		-- Make the base category object
		⚫	if not args[1] then
	do
		⚫	error('no base category specified', 3)
	local baseCategory = args[2] or args[1]
⚫	if not ~~baseCategory~~ then
⚫	error('no category specified', 3)
	end
⚫	self._baseCategoryObj = Category.new{
⚫	cfg = self._cfg,
⚫	category = ~~baseCategory~~,
	}
	end		end
		⚫	self._baseCategoryObj = Category.new{
		⚫	cfg = self._cfg,
		⚫	category = args[1],
			}

	-- Make datedCategory objects		-- Make datedCategory objects
Line 145:		Line 142:
	do		do
	local cfg = self._cfg		local cfg = self._cfg
	local baseCategory = self._baseCategoryObj:getCategory()		local baseCategory = args[2] or self._baseCategoryObj:getCategory()
	local from = args.from or self:message('dated-category-format-from')		local from = args.from or self:message('dated-category-format-from')
	local suffix = args.suffix		local suffix = args.suffix

Mr. Stradivarius: Create sandbox version of Module:Progress box

2015-05-18T02:08:11Z

Create sandbox version of Module:Progress box

New page

-- This module implements [[Template:Progress box]]

local makePurgeLink = require('Module:Purge')._main
local lang = mw.language.getContentLanguage()
local CONFIG_MODULE = 'Module:Progress box/config'

-------------------------------------------------------------------------------
-- Message mixin
--
-- This function is mixed into all of the other classes
-------------------------------------------------------------------------------

local function message(self, key, ...)
local msg = self._cfg[key]
if not msg then
error(string.format("no message found with key '%s'", tostring(key)), 2)
end
if select('#', ...) > 0 then
return mw.message.newRawMessage(msg, ...):plain()
else
return msg
end
end

-------------------------------------------------------------------------------
-- Category class
-------------------------------------------------------------------------------

local Category = {}
Category.__index = Category
Category.message = message

function Category.new(data)
local self = setmetatable({}, Category)
self._cfg = data.cfg
self:setCategory(data.category)
return self
end

function Category:setCategory(category)
self._category = category
end

function Category:getCategory()
return self._category
end

function Category:makeCategoryLink(display)
local cat = self:getCategory()
display = display or cat
return string.format('[[:Category:%s|%s]]', cat, display)
end

function Category:getCount()
if not self._count then
self._count = mw.site.stats.pagesInCategory(self:getCategory(), 'pages')
end
return self._count
end

function Category:getFormattedCount()
return lang:formatNum(self:getCount())
end

function Category:exists()
return mw.title.makeTitle(14, self:getCategory()).exists
end

-------------------------------------------------------------------------------
-- DatedCategory class
-- Inherits from Category
-------------------------------------------------------------------------------

local DatedCategory = {}
DatedCategory.__index = DatedCategory
setmetatable(DatedCategory, Category)

function DatedCategory.new(data)
local self = setmetatable(Category.new(data), {__index = DatedCategory})
self._date = data.date
self._dateFormat = data.dateFormat or self:message('date-format')
self._formattedDate = self:formatDate(self._date)
do
local category = self:message(
'dated-category-format',
data.baseCategory,
self._formattedDate,
data.from or self:message('dated-category-format-from'),
data.suffix or ''
)
category = category:match('^%s*(.-)%s*$') -- trim whitespace
self:setCategory(category)
end
return self
end

function DatedCategory:formatDate(date)
return lang:formatDate(self._dateFormat, date)
end

function DatedCategory:getDate()
return self._date
end

function DatedCategory:getFormattedDate()
return self._formattedDate
end

-------------------------------------------------------------------------------
-- ProgressBox class
-------------------------------------------------------------------------------

local ProgressBox = {}
ProgressBox.__index = ProgressBox
ProgressBox.message = message

function ProgressBox.new(args, cfg, title)
local self = setmetatable({}, ProgressBox)

-- Argument defaults
args = args or {}
self._cfg = cfg or mw.loadData(CONFIG_MODULE)
self._title = title or mw.title.getCurrentTitle()

-- Set data
self._float = args.float or 'left'
self._margin = args.float == 'none' and 'auto' or nil
self._header = args[1]
self._frame = mw.getCurrentFrame()

-- Make the base category object
do
local baseCategory = args[2] or args[1]
if not baseCategory then
error('no category specified', 3)
end
self._baseCategoryObj = Category.new{
cfg = self._cfg,
category = baseCategory,
}
end

-- Make datedCategory objects
self._datedCategories = {}
do
local cfg = self._cfg
local baseCategory = self._baseCategoryObj:getCategory()
local from = args.from or self:message('dated-category-format-from')
local suffix = args.suffix
local currentDate = lang:formatDate('Y-m')
local date = self:findEarliestCategoryDate()
local dateFormat = self:message('date-format')
while date <= currentDate do
local datedCategoryObj = DatedCategory.new{
cfg = cfg,
baseCategory = baseCategory,
from = from,
suffix = suffix,
date = date,
dateFormat = dateFormat,
}
if datedCategoryObj:getCount() > 0 then
table.insert(self._datedCategories, datedCategoryObj)
end
date = ProgressBox.incrementDate(date)
end
end

-- Make all-article category object
do
local allCategory
if args[3] then
allCategory = args[3]
else
allCategory = self:message(
'all-articles-category-format',
self._baseCategoryObj:getCategory()
)
allCategory = self._frame:preprocess(allCategory)
end
self._allCategoryObj = Category.new{
cfg = self._cfg,
category = allCategory,
}
end

return self
end

-- Increments a date in the format YYYY-MM
function ProgressBox.incrementDate(date)
local year, month = date:match('^(%d%d%d%d)%-(%d%d)$')
year = tonumber(year)
month = tonumber(month)
if not year or not month then
error(string.format("error parsing date '%s'", tostring(date)), 2)
end
month = month + 1
if month > 12 then
month = 1
year = year + 1
end
return string.format('%04d-%02d', year, month)
end

function ProgressBox:findEarliestCategoryDate()
return self:message('start-date')
end

function ProgressBox:isCollapsed()
return self._title.namespace ~= 10 -- is not in template namespace
end

function ProgressBox:makeTotalLabel()
local display = self:message('all-articles-label')
if self._allCategoryObj:exists() then
return self._allCategoryObj:makeCategoryLink(display)
else
return display
end
end

function ProgressBox:getTotalCount()
local count = 0
for i, obj in ipairs(self._datedCategories) do
count = count + obj:getCount()
end
count = count + self._baseCategoryObj:getCount()
return count
end

function ProgressBox:getFormattedTotalCount()
return lang:formatNum(self:getTotalCount())
end

function ProgressBox:__tostring()
data = data or {}
local root = mw.html.create('table')

-- Base classes and styles
root
:addClass('infobox')
:css('float', self._float)
:css('clear', self._float)
:css('margin', self._margin)
:css('width', '22em')

-- Header row
root:tag('tr'):tag('th')
:attr('colspan', 2)
:addClass('navbox-title')
:css('padding', '0.2em')
:css('font-size', '125%')
:wikitext(self._header)

-- Refresh row
root:tag('tr'):tag('td')
:attr('colspan', 2)
:css('text-align', 'center')
:wikitext(makePurgeLink{self:message('purge-link-display')})

-- Subtotals
local subtotalTable = root
:tag('tr')
:tag('td')
:attr('colspan', 2)
:css('padding', 0)
:tag('table')
:addClass('collapsible')
:addClass(self:isCollapsed() and 'collapsed' or nil)
:css('width', '100%')
:css('margin', 0)
subtotalTable
:tag('tr')
:tag('th')
:attr('colspan', 2)
:wikitext(self:message('subtotal-heading'))
for i, datedCategoryObj in ipairs(self._datedCategories) do
subtotalTable
:tag('tr')
:tag('td')
:wikitext(datedCategoryObj:makeCategoryLink(
datedCategoryObj:getFormattedDate()
))
:done()
:tag('td')
:css('text-align', 'right')
:wikitext(datedCategoryObj:getFormattedCount())
end

-- Undated articles
subtotalTable
:tag('tr')
:tag('td')
:wikitext(self._baseCategoryObj:makeCategoryLink(
self:message('undated-articles-label')
))
:done()
:tag('td')
:css('text-align', 'right')
:wikitext(self._baseCategoryObj:getFormattedCount())

-- Total
root
:tag('tr')
:css('font-size', '110%')
:tag('td')
:wikitext(string.format("'''%s'''", self:makeTotalLabel()))
:done()
:tag('td')
:css('text-align', 'right')
:wikitext(string.format(
"'''%s'''",
self:getFormattedTotalCount()
))

return tostring(root)
end

-------------------------------------------------------------------------------
-- Exports
-------------------------------------------------------------------------------

local p = {}

function p._exportClasses()
return {
Category = Category,
DatedCategory = DatedCategory,
ProgressBox = ProgressBox,
}
end

function p._main(args, cfg, title)
return tostring(ProgressBox.new(args, cfg, title))
end

function p.main(frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = 'Template:Progress box'
})
return p._main(args)
end

return p