Module:Protection banner/documentation - Revision history

Jackmcbarn: Middleclass is way overkill here

2016-03-21T01:07:12Z

Middleclass is way overkill here

← Previous revision		Revision as of 01:07, 21 March 2016
Line 1:		Line 1:
	-- This module generates documentation for [[Module:Protection banner]].		-- This module generates documentation for [[Module:Protection banner]].

	local class = require('Module:Middleclass').class

	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
Line 7:		Line 5:
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

	local Documentation = ~~class('Documentation')~~		local Documentation = {}
			Documentation.__index = Documentation

	function Documentation:~~initialize~~(mainCfg, docCfg)		function Documentation:new(mainCfg, docCfg)
			return setmetatable({
	~~self.~~_mainCfg = mainCfg		_mainCfg = mainCfg,
	~~self.~~_docCfg = docCfg		_docCfg = docCfg
			}, self)
	end		end

Mr. Stradivarius: use require instead of mw.loadData

2014-07-04T04:23:12Z

use require instead of mw.loadData

← Previous revision		Revision as of 04:23, 4 July 2014
Line 78:		Line 78:

	function p.reasonTable()		function p.reasonTable()
	local mainCfg = ~~mw.loadData~~('Module:Protection banner/config')		local mainCfg = require('Module:Protection banner/config')
	local docCfg = ~~mw.loadData~~('Module:Protection banner/documentation/config')		local docCfg = require('Module:Protection banner/documentation/config')
	local documentationObj = Documentation:new(mainCfg, docCfg)		local documentationObj = Documentation:new(mainCfg, docCfg)
	return documentationObj:makeReasonTable()		return documentationObj:makeReasonTable()

Mr. Stradivarius: load both the main config and the documentation config, and use the documentation config where we can

2014-07-03T06:48:00Z

load both the main config and the documentation config, and use the documentation config where we can

← Previous revision		Revision as of 06:48, 3 July 2014
Line 9:		Line 9:
	local Documentation = class('Documentation')		local Documentation = class('Documentation')

	function Documentation:initialize(~~cfg~~)		function Documentation:initialize(mainCfg, docCfg)
	self.~~_cfg~~ = ~~cfg~~		self._mainCfg = mainCfg
			self._docCfg = docCfg
	end		end

Line 16:		Line 17:
	-- Get the data from the cfg.banners table.		-- Get the data from the cfg.banners table.
	local rowData = {}		local rowData = {}
	for action, reasonTables in pairs(self.~~_cfg~~.banners) do		for action, reasonTables in pairs(self._mainCfg.banners) do
	for reason, t in pairs(reasonTables) do		for reason, t in pairs(reasonTables) do
	rowData[#rowData + 1] = {		rowData[#rowData + 1] = {
Line 37:		Line 38:

	-- Assemble a wikitable of the data.		-- Assemble a wikitable of the data.
	local msg = self._cfg.msg
	local ret = {}		local ret = {}
	ret[#ret + 1] = '{\| class="wikitable"'		ret[#ret + 1] = '{\| class="wikitable"'
Line 44:		Line 44:
	ret[#ret + 1] = string.format(		ret[#ret + 1] = string.format(
	'\| colspan="3" \| %s',		'\| colspan="3" \| %s',
	~~msg~~['documentation-blurb-noreasons']		self._docCfg['documentation-blurb-noreasons']
	)		)
	else		else
Line 51:		Line 51:
	ret[#ret + 1] = string.format(		ret[#ret + 1] = string.format(
	'! %s\n! %s\n! %s',		'! %s\n! %s\n! %s',
	~~msg~~['documentation-heading-reason'],		self._docCfg['documentation-heading-reason'],
	~~msg~~['documentation-heading-action'],		self._docCfg['documentation-heading-action'],
	~~msg~~['documentation-heading-description']		self._docCfg['documentation-heading-description']
	)		)
	-- Rows		-- Rows
Line 78:		Line 78:

	function p.reasonTable()		function p.reasonTable()
	local ~~cfg~~ = mw.loadData('Module:Protection banner/config')		local mainCfg = mw.loadData('Module:Protection banner/config')
			local docCfg = mw.loadData('Module:Protection banner/documentation/config')
	local documentationObj = Documentation:new(~~cfg~~)		local documentationObj = Documentation:new(mainCfg, docCfg)
	return documentationObj:makeReasonTable()		return documentationObj:makeReasonTable()
	end		end

Mr. Stradivarius: allow nil descriptions

2014-07-01T03:20:41Z

allow nil descriptions

← Previous revision		Revision as of 03:20, 1 July 2014
Line 62:		Line 62:
	t.reason,		t.reason,
	t.action,		t.action,
	t.description		t.description or ''
	)		)
	end		end

Mr. Stradivarius: load Module:Middleclass

2014-07-01T03:17:49Z

load Module:Middleclass

← Previous revision		Revision as of 03:17, 1 July 2014
Line 1:		Line 1:
	-- This module generates documentation for [[Module:Protection banner]].		-- This module generates documentation for [[Module:Protection banner]].

			local class = require('Module:Middleclass').class

	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

Mr. Stradivarius: move documentation class and export function from Module:Protection banner

2014-07-01T03:14:21Z

move documentation class and export function from Module:Protection banner

New page

-- This module generates documentation for [[Module:Protection banner]].

--------------------------------------------------------------------------------
-- Documentation class
--------------------------------------------------------------------------------

local Documentation = class('Documentation')

function Documentation:initialize(cfg)
self._cfg = cfg
end

function Documentation:makeReasonTable()
-- Get the data from the cfg.banners table.
local rowData = {}
for action, reasonTables in pairs(self._cfg.banners) do
for reason, t in pairs(reasonTables) do
rowData[#rowData + 1] = {
reason = reason,
action = action,
description = t.description
}
end
end

-- Sort the table into alphabetical order, first by action and then by
-- reason.
table.sort(rowData, function (t1, t2)
if t1.action == t2.action then
return t1.reason < t2.reason
else
return t1.action < t2.action
end
end)

-- Assemble a wikitable of the data.
local msg = self._cfg.msg
local ret = {}
ret[#ret + 1] = '{| class="wikitable"'
if #rowData < 1 then
ret[#ret + 1] = '|-'
ret[#ret + 1] = string.format(
'| colspan="3" | %s',
msg['documentation-blurb-noreasons']
)
else
-- Header
ret[#ret + 1] = '|-'
ret[#ret + 1] = string.format(
'! %s\n! %s\n! %s',
msg['documentation-heading-reason'],
msg['documentation-heading-action'],
msg['documentation-heading-description']
)
-- Rows
for _, t in ipairs(rowData) do
ret[#ret + 1] = '|-'
ret[#ret + 1] = string.format(
'| %s\n| %s\n| %s',
t.reason,
t.action,
t.description
)
end
end
ret[#ret + 1] = '|}'

return table.concat(ret, '\n')
end

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

local p = {}

function p.reasonTable()
local cfg = mw.loadData('Module:Protection banner/config')
local documentationObj = Documentation:new(cfg)
return documentationObj:makeReasonTable()
end

return p