Difference between revisions of "Module:Category handler/sandbox"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (improvements in suppression argument methods) |
blackwiki>Mr. Stradivarius (move yesno processing to CategoryHandler:initialize and start switching things out of the p._main function) |
||
Line 47: | Line 47: | ||
-- Set suppression parameter values | -- Set suppression parameter values | ||
− | self._nocat = self:parameter('nocat') | + | self._nocat = yesno(self:parameter('nocat')) |
− | self._categories = self:parameter('categories') | + | self._categories = yesno(self:parameter('categories')) |
− | + | for _, key in ipairs{'category2', 'subpage'} do | |
− | + | local value = self:parameter(key) | |
+ | if type(value) == 'string' then | ||
+ | value = mw.ustring.lower(value) | ||
+ | end | ||
+ | self['_' .. key] = value | ||
+ | end | ||
end | end | ||
Line 74: | Line 79: | ||
end | end | ||
− | function CategoryHandler: | + | function CategoryHandler:isSuppressedByArguments() |
− | -- See if a category suppression argument has been set. | + | return |
− | + | -- See if a category suppression argument has been set. | |
− | or | + | self._nocat == true |
+ | or self._categories == false | ||
or ( | or ( | ||
self._category2 | self._category2 | ||
Line 83: | Line 89: | ||
and self._category2 ~= self._data.category2Negative | and self._category2 ~= self._data.category2Negative | ||
) | ) | ||
− | |||
− | |||
− | + | -- Check whether we are on a subpage, and see if categories are | |
− | + | -- suppressed based on our subpage status. | |
− | + | or self._subpage == self._data.subpageNo and self.title.isSubpage | |
− | |||
or self._subpage == self._data.subpageOnly and not self.title.isSubpage | or self._subpage == self._data.subpageOnly and not self.title.isSubpage | ||
end | end | ||
Line 96: | Line 99: | ||
-- Check whether the category suppression arguments indicate we | -- Check whether the category suppression arguments indicate we | ||
-- should skip the blacklist check. | -- should skip the blacklist check. | ||
− | return | + | return self._nocat == false |
− | or | + | or self._categories == true |
or self._category2 == self._data.category2Yes | or self._category2 == self._data.category2Yes | ||
+ | end | ||
+ | |||
+ | function CategoryHandler:matchesBlacklist() | ||
+ | if self._usesCurrentTitle then | ||
+ | return self._data.currentTitleMatchesBlacklist | ||
+ | else | ||
+ | return require('Module:Category handler/shared').matchesBlacklist( | ||
+ | self.title.prefixedText, | ||
+ | mw.loadData('Module:Category handler/blacklist') | ||
+ | ) | ||
+ | end | ||
+ | end | ||
+ | |||
+ | function CategoryHandler:isSuppressed() | ||
+ | -- Find if categories are suppressed by either the arguments or by | ||
+ | -- matching the blacklist. | ||
+ | return self:isSuppressedByArguments() | ||
+ | or not self:shouldSkipBlacklistCheck() and self:matchesBlacklist() | ||
end | end | ||
Line 121: | Line 142: | ||
end | end | ||
− | function p. | + | -------------------------------------------------------------------------------- |
− | -- | + | -- Exports |
− | + | -------------------------------------------------------------------------------- | |
− | + | ||
+ | local p = {} | ||
+ | |||
+ | function p._exportClasses() | ||
+ | -- Used for testing purposes. | ||
+ | return { | ||
+ | CategoryHandler = CategoryHandler | ||
+ | } | ||
end | end | ||
− | |||
− | |||
function p._main(args) | function p._main(args) | ||
− | + | local data = mw.loadData('Module:Category handler/data') | |
− | + | local handlerObj = CategoryHandler:new(data, args) | |
− | |||
− | local | ||
− | local | ||
− | if | + | if handlerObj:isSuppressed() then |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
return nil | return nil | ||
end | end | ||
Line 240: | Line 254: | ||
else | else | ||
args[k] = v | args[k] = v | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
end | end | ||
Line 256: | Line 259: | ||
return p._main(args) | return p._main(args) | ||
end | end | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
return p | return p |
Revision as of 13:45, 7 July 2014
Documentation for this module may be created at Module:Category handler/sandbox/doc
--------------------------------------------------------------------------------
-- --
-- CATEGORY HANDLER --
-- --
-- This module implements the {{category handler}} template in Lua, --
-- with a few improvements: all namespaces and all namespace aliases --
-- are supported, and namespace names are detected automatically for --
-- the local wiki. This module requires [[Module:Namespace detect]] --
-- and [[Module:Yesno]] to be available on the local wiki. It can be --
-- configured for different wikis by altering the values in --
-- [[Module:Category handler/config]], and pages can be blacklisted --
-- from categorisation by using [[Module:Category handler/blacklist]]. --
-- --
--------------------------------------------------------------------------------
-- Load required modules
local class = require('Module:Middleclass').class
local mNamespaceDetect = require('Module:Namespace detect')
local yesno = require('Module:Yesno')
local p = {}
--------------------------------------------------------------------------------
-- CategoryHandler class
--------------------------------------------------------------------------------
local CategoryHandler = class('CategoryHandler')
function CategoryHandler:initialize(data, args)
self._data = data
self._args = args
-- Set the title object
do
local pagename = self:parameter('demopage')
local success, titleObj = pcall(mw.title.new, pagename)
if success and titleObj then
self.title = titleObj
else
self.title = mw.title.getCurrentTitle()
self._usesCurrentTitle = true
end
end
-- Set parameter mappings
self._mappings = mNamespaceDetect.getParamMappings()
-- Set suppression parameter values
self._nocat = yesno(self:parameter('nocat'))
self._categories = yesno(self:parameter('categories'))
for _, key in ipairs{'category2', 'subpage'} do
local value = self:parameter(key)
if type(value) == 'string' then
value = mw.ustring.lower(value)
end
self['_' .. key] = value
end
end
function CategoryHandler:parameter(key)
local parameterNames = self._data.parameters[key]
local pntype = type(parameterNames)
if pntype == 'string' or pntype == 'number' then
return self._args[parameterNames]
elseif pntype == 'table' then
for _, name in ipairs(parameterNames) do
local value = self._args[name]
if value ~= nil then
return value
end
end
return nil
else
error(string.format(
'invalid config key "%s"',
tostring(key)
), 2)
end
end
function CategoryHandler:isSuppressedByArguments()
return
-- See if a category suppression argument has been set.
self._nocat == true
or self._categories == false
or (
self._category2
and self._category2 ~= self._data.category2Yes
and self._category2 ~= self._data.category2Negative
)
-- Check whether we are on a subpage, and see if categories are
-- suppressed based on our subpage status.
or self._subpage == self._data.subpageNo and self.title.isSubpage
or self._subpage == self._data.subpageOnly and not self.title.isSubpage
end
function CategoryHandler:shouldSkipBlacklistCheck()
-- Check whether the category suppression arguments indicate we
-- should skip the blacklist check.
return self._nocat == false
or self._categories == true
or self._category2 == self._data.category2Yes
end
function CategoryHandler:matchesBlacklist()
if self._usesCurrentTitle then
return self._data.currentTitleMatchesBlacklist
else
return require('Module:Category handler/shared').matchesBlacklist(
self.title.prefixedText,
mw.loadData('Module:Category handler/blacklist')
)
end
end
function CategoryHandler:isSuppressed()
-- Find if categories are suppressed by either the arguments or by
-- matching the blacklist.
return self:isSuppressedByArguments()
or not self:shouldSkipBlacklistCheck() and self:matchesBlacklist()
end
function CategoryHandler:namespaceParametersExist()
-- Find whether any namespace parameters have been specified.
-- We use the order "all" --> namespace params --> "other" as this is what
-- the old template did.
if self:parameter('all') then
return true
end
for ns, params in pairs(self._mappings) do
for i, param in ipairs(params) do
if self._args[param] then
return true
end
end
end
if self:parameter('other') then
return true
end
return false
end
--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------
local p = {}
function p._exportClasses()
-- Used for testing purposes.
return {
CategoryHandler = CategoryHandler
}
end
function p._main(args)
local data = mw.loadData('Module:Category handler/data')
local handlerObj = CategoryHandler:new(data, args)
if handlerObj:isSuppressed() then
return nil
end
local ret = {}
if not nsParamsExist(mappings, args) then
-- No namespace parameters exist; basic usage. Pass args[1] to
-- [[Module:Namespace detect]] using the default namespace
-- parameters, and return the result.
local ndargs = {}
for _, ndarg in ipairs(data.defaultNamespaces) do
ndargs[ndarg] = args[1]
end
ndargs.page = args.page
ndargs.demospace = args.demospace
local ndresult = mNamespaceDetect._main(ndargs)
if ndresult then
ret[#ret + 1] = ndresult
end
else
-- Namespace parameters exist; advanced usage.
-- If the all parameter is specified, return it.
local all = args.all
if type(all) == 'string' then
ret[#ret + 1] = all
end
-- Get the arguments to pass to [[Module:Namespace detect]].
local ndargs = {}
for ns, params in pairs(mappings) do
for _, param in ipairs(params) do
ndargs[param] = args[param] or args[data.other] or nil
end
end
ndargs.other = args.other
ndargs.page = args.page
ndargs.demospace = args.demospace
local data = mNamespaceDetect._main(ndargs)
-- Work out what to return based on the result of the namespace detect call.
local datanum = tonumber(data)
if type(datanum) == 'number' then
-- "data" is a number, so return that positional parameter.
-- Remove non-positive integer values, as only positive integers
-- from 1-10 were used with the old template.
if datanum > 0 and math.floor(datanum) == datanum then
local dataArg = args[datanum]
if type(dataArg) == 'string' then
ret = ret .. dataArg
end
end
else
-- "data" is not a number, so return it as it is.
if type(data) == 'string' then
ret[#ret + 1] = data
end
end
end
return table.concat(ret)
end
function p.main(frame)
-- If called via #invoke, use the args passed into the invoking
-- template, or the args passed to #invoke if any exist. Otherwise
-- assume args are being passed directly in.
local origArgs
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
for k, v in pairs(frame.args) do
origArgs = frame.args
break
end
else
origArgs = frame
end
-- Trim whitespace and remove blank arguments for the following args:
-- 1, 2, 3 etc., "nocat", "categories", "subpage", and "page".
local args = {}
for k, v in pairs(origArgs) do
if type(v) == 'string' then
v = mw.text.trim(v) -- Trim whitespace.
end
if type(k) == 'number'
or k == data.nocat
or k == data.categories
or k == data.subpage
or k == data.page
then
if v ~= '' then
args[k] = v
end
else
args[k] = v
end
end
return p._main(args)
end
return p