Module:Arguments - Revision history

Sushoff: Created page with "-- This module provides easy processing of arguments passed to Scribunto from -- #invoke. It is intended for use by other Lua modules, and should not be -- called from #invoke directly. local libraryUtil = require('libraryUtil') local checkType = libraryUtil.checkType local arguments = {} -- Generate four different tidyVal functions, so that we don't have to check the -- options every time we call it. local function tidyValDefault(key, val) if type(val) == 'string'..."

2025-02-01T12:49:15Z

Created page with "-- This module provides easy processing of arguments passed to Scribunto from -- #invoke. It is intended for use by other Lua modules, and should not be -- called from #invoke directly. local libraryUtil = require('libraryUtil') local checkType = libraryUtil.checkType local arguments = {} -- Generate four different tidyVal functions, so that we don't have to check the -- options every time we call it. local function tidyValDefault(key, val) if type(val) == 'string'..."

← Older revision	Revision as of 12:49, 1 February 2025
(No difference)

imported>MusikAnimal: 1 revision imported

2020-04-01T06:12:40Z

1 revision imported

← Older revision	Revision as of 06:12, 1 April 2020
(No difference)

w>MusikAnimal: Protected "Module:Arguments": High-risk template ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2019-02-14T01:32:53Z

Protected "Module:Arguments": High-risk template ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 01:32, 14 February 2019
(No difference)

imported>Xaosflux: Changed protection level of Module:Arguments: used in the mediawiki interface ex: MediaWiki:Watchlist-details ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2015-12-23T16:07:27Z

Changed protection level of Module:Arguments: used in the mediawiki interface ex: MediaWiki:Watchlist-details ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 16:07, 23 December 2015
(No difference)

imported>Jackmcbarn: add argument translation from sandbox - all tests pass

2015-06-26T22:53:15Z

add argument translation from sandbox - all tests pass

@@ Line 52: / Line 52: @@
 	return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
 end
 function arguments.getArgs(frame, options)
@@ Line 58: / Line 60: @@
 	frame = frame or {}
 	options = options or {}
 	--[[
@@ Line 97: / Line 124: @@
 					end
 				end
 				-- We test for false specifically here so that nil (the default) acts like true.
 				if found or options.frameOnly == false then
@@ Line 122: / Line 149: @@
 		luaArgs = frame
 	end
 	-- Set the order of precedence of the argument tables. If the variables are
 	-- nil, nothing will be added to the table, which is how we avoid clashes
 	-- between the frame/parent args and the Lua args.
 	local argTables = {fargs}
 	argTables[#argTables + 1] = pargs
@@ Line 215: / Line 242: @@
 		-- must be nil.
 		--]]
 		local val = metaArgs[key]
 		if val ~= nil then
@@ Line 235: / Line 265: @@
 		-- This function is called when a module tries to add a new value to the
 		-- args table, or tries to change an existing value.
 		if options.readOnly then
 			error(
@@ Line 261: / Line 294: @@
 		else
 			metaArgs[key] = val
 		end
 	end
@@ Line 270: / Line 321: @@
 			metatable.donePairs = true
 		end
-		return pairs(metaArgs)
+		return translatenext, { t = metaArgs }
 	end
 	local function inext(t, i)
 		-- This uses our __index metamethod

imported>Jackmcbarn: apply changes from sandbox - all tests pass

2015-01-31T22:31:40Z

apply changes from sandbox - all tests pass

← Older revision		Revision as of 22:31, 31 January 2015
Line 46:		Line 46:
	local function tidyValNoChange(key, val)		local function tidyValNoChange(key, val)
	return val		return val
		⚫	end

			local function matchesTitle(given, title)
			local tp = type( given )
			return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
	end		end

Line 82:		Line 87:
	local title = parent:getTitle():gsub('/sandbox$', '')		local title = parent:getTitle():gsub('/sandbox$', '')
	local found = false		local found = false
	if ~~type~~(options.wrappers) ~~== 'table'~~ then		if matchesTitle(options.wrappers, title) then
		⚫	found = true
		⚫	elseif type(options.wrappers) == 'table' then
	for _,v in pairs(options.wrappers) do		for _,v in pairs(options.wrappers) do
	if v == title then		if matchesTitle(v, title) then
	found = true		found = true
	break		break
	end		end
	end		end
⚫	elseif options.wrappers == ~~title~~ then
⚫	found = true
	end		end

Line 165:		Line 170:
	setmetatable(args, metatable)		setmetatable(args, metatable)

	local function mergeArgs(~~iterator,~~ tables)		local function mergeArgs(tables)
	--[[		--[[
	-- Accepts multiple tables as input and merges their keys and values		-- Accepts multiple tables as input and merges their keys and values
	-- into one table ~~using the specified iterator~~. If a value is already		-- into one table. If a value is already present it is not overwritten;
	-- ~~present it is not overwritten;~~ tables listed earlier have precedence.		-- tables listed earlier have precedence. We are also memoizing nil
	-- ~~We are also memoizing nil~~ values, which can be overwritten if they		-- values, which can be overwritten if they are 's' (soft).
	-- are 's' (soft).
	--]]		--]]
	for _, t in ipairs(tables) do		for _, t in ipairs(tables) do
	for key, val in ~~iterator~~(t) do		for key, val in pairs(t) do
	if metaArgs[key] == nil and nilArgs[key] ~= 'h' then		if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
	local tidiedVal = tidyVal(key, val)		local tidiedVal = tidyVal(key, val)
Line 263:		Line 267:
	-- Called when pairs is run on the args table.		-- Called when pairs is run on the args table.
	if not metatable.donePairs then		if not metatable.donePairs then
	mergeArgs(~~pairs,~~ argTables)		mergeArgs(argTables)
	metatable.donePairs = true		metatable.donePairs = true
	metatable.doneIpairs = true
	end		end
	return pairs(metaArgs)		return pairs(metaArgs)
			end

			local function inext(t, i)
			-- This uses our __index metamethod
			local v = t[i + 1]
			if v ~= nil then
			return i + 1, v
			end
	end		end

	metatable.__ipairs = function ()		metatable.__ipairs = function (t)
	-- Called when ipairs is run on the args table.		-- Called when ipairs is run on the args table.
			return inext, t, 0
	if not metatable.doneIpairs then
	mergeArgs(ipairs, argTables)
	metatable.doneIpairs = true
⚫	end
	return ipairs(metaArgs)
	end		end

imported>Mr. Stradivarius: fix bug where explicitly deleted args were still appearing when iterated over with pairs or ipairs - code courtesy of User:Jackmcbarn

2014-12-11T04:32:27Z

fix bug where explicitly deleted args were still appearing when iterated over with pairs or ipairs - code courtesy of User:Jackmcbarn

← Older revision		Revision as of 04:32, 11 December 2014
Line 170:		Line 170:
	-- into one table using the specified iterator. If a value is already		-- into one table using the specified iterator. If a value is already
	-- present it is not overwritten; tables listed earlier have precedence.		-- present it is not overwritten; tables listed earlier have precedence.
	-- We are also memoizing nil values, ~~but those values~~ can be		-- We are also memoizing nil values, which can be overwritten if they
	-- ~~overwritten~~.		-- are 's' (soft).
	--]]		--]]
	for _, t in ipairs(tables) do		for _, t in ipairs(tables) do
	for key, val in iterator(t) do		for key, val in iterator(t) do
	if metaArgs[key] == nil then		if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
	local tidiedVal = tidyVal(key, val)		local tidiedVal = tidyVal(key, val)
	if tidiedVal == nil then		if tidiedVal == nil then
	nilArgs[key] = ~~true~~		nilArgs[key] = 's'
	else		else
	metaArgs[key] = tidiedVal		metaArgs[key] = tidiedVal
Line 219:		Line 219:
	for _, argTable in ipairs(argTables) do		for _, argTable in ipairs(argTables) do
	local argTableVal = tidyVal(key, argTable[key])		local argTableVal = tidyVal(key, argTable[key])
	if argTableVal == nil then		if argTableVal ~= nil then
⚫	nilArgs[key] = ~~true~~
	else
	metaArgs[key] = argTableVal		metaArgs[key] = argTableVal
	return argTableVal		return argTableVal
	end		end
	end		end
		⚫	nilArgs[key] = 'h'
	return nil		return nil
	end		end
Line 255:		Line 254:
	--]]		--]]
	metaArgs[key] = nil		metaArgs[key] = nil
	nilArgs[key] = ~~true~~		nilArgs[key] = 'h'
	else		else
	metaArgs[key] = val		metaArgs[key] = val

imported>Mr. Stradivarius: allow using both the frame and parent frame arguments with the wrappers option if specifically requested, per protected edit request by User:Jackmcbarn

2014-07-05T03:52:56Z

allow using both the frame and parent frame arguments with the wrappers option if specifically requested, per protected edit request by User:Jackmcbarn

← Older revision		Revision as of 03:52, 5 July 2014
Line 92:		Line 92:
	found = true		found = true
	end		end
	~~if found then~~
			-- We test for false specifically here so that nil (the default) acts like true.
		⚫	if found or options.frameOnly == false then
	pargs = parent.args		pargs = parent.args
	~~else~~		end
			if not found or options.parentOnly == false then
	fargs = frame.args		fargs = frame.args
	end		end
Line 107:		Line 110:
	pargs = parent and parent.args or nil		pargs = parent and parent.args or nil
	end		end
		⚫	end
⚫	if options.~~parentFirst~~ then
			if options.parentFirst then
	fargs, pargs = pargs, fargs		fargs, pargs = pargs, fargs
⚫	end
	end		end
	else		else

imported>Mr. Stradivarius: add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn

2014-06-06T14:24:47Z

add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn

@@ Line 55: / Line 55: @@
 	--[[
-	-- Get the arguments from the frame object if available. If the frame object
+	-- Get the argument tables. If we were passed a valid frame object, get the
-	-- debug console, so assign the args to a new variable so we can
+	-- on the options set and on the parent frame's availability. If we weren't
 	--]]
 	local fargs, pargs, luaArgs
 	if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
-		if not options.parentOnly then
+		if options.wrappers then
 		end
 	else
@@ Line 212: / Line 252: @@
 			--]]
 			metaArgs[key] = nil
-			nilArgs[key] = true -- Memoize nils.
+			nilArgs[key] = true
 		else
 			metaArgs[key] = val

imported>Mr. Stradivarius: memoize nils using a separate nilArgs table; this fixes a bug where nil values were being iterated over with pairs()

2014-04-18T10:30:10Z

memoize nils using a separate nilArgs table; this fixes a bug where nil values were being iterated over with pairs()

Show changes