Module:PTV route/sandbox - Revision history

Mr. Stradivarius: make the code a little clearer

2023-01-22T09:55:25Z

make the code a little clearer

← Previous revision		Revision as of 09:55, 22 January 2023
Line 114:		Line 114:
	args = normalizeArguments(args)		args = normalizeArguments(args)
	local routeData = getRouteData(args.mode, args.route)		local routeData = getRouteData(args.mode, args.route)
	if ~~not~~ routeData then		if routeData then
		⚫	return renderFunc(args, routeData)
			else
	return renderTrackingCategory(INVALID_ROUTE_CATEGORY)		return renderTrackingCategory(INVALID_ROUTE_CATEGORY)
	end		end

⚫	return renderFunc(args, routeData)
	end		end

2023-01-22T09:52:59Z

remove code tracking deprecated parameters

← Previous revision		Revision as of 09:52, 22 January 2023
Line 5:		Line 5:

	local INVALID_ROUTE_CATEGORY = 'PTV route templates with invalid routes'		local INVALID_ROUTE_CATEGORY = 'PTV route templates with invalid routes'
	local DEPRECATED_PARAMETER_CATEGORY = 'PTV route templates with deprecated parameters'

	local function makeExternalLink(url, display)		local function makeExternalLink(url, display)
Line 94:		Line 93:
	ret.route = ret.route or ret[1]		ret.route = ret.route or ret[1]
	return ret		return ret
	end

	local function hasDeprecatedParameters(args)
	-- Whether the argument table contains deprecated parameters.
	return args.numtext or args.deftext
	end		end

Line 124:		Line 118:
	end		end

		⚫	return renderFunc(args, routeData)
	local ret = ''
⚫	~~ret = ret ..~~ renderFunc(args, routeData)
	if hasDeprecatedParameters(args) then
	ret = ret .. renderTrackingCategory(DEPRECATED_PARAMETER_CATEGORY)
	end
	return ret
	end		end

2022-10-21T10:00:07Z

use require('strict') instead of require('Module:No globals')

← Previous revision		Revision as of 10:00, 21 October 2022
Line 1:		Line 1:
	require('~~Module:No globals~~')		require('strict')

	local data = mw.loadData('Module:PTV route/data')		local data = mw.loadData('Module:PTV route/data')

2019-03-11T06:23:25Z

only output tracking categories in mainspace

← Previous revision		Revision as of 06:23, 11 March 2019
Line 14:		Line 14:
	return string.format('[%s]', url)		return string.format('[%s]', url)
	end		end
⚫	end

⚫	local function makeCategoryLink(category)
⚫	-- Make a category wikilink.
⚫	return string.format('[[Category:%s]]', category)
	end		end

Line 104:		Line 99:
	-- Whether the argument table contains deprecated parameters.		-- Whether the argument table contains deprecated parameters.
	return args.numtext or args.deftext		return args.numtext or args.deftext
		⚫	end

		⚫	local function makeCategoryLink(category)
		⚫	-- Make a category wikilink.
		⚫	return string.format('[[Category:%s]]', category)
			end

			local function renderTrackingCategory(category)
			-- Render a tracking category, if the current page is in mainspace.
			if mw.title.getCurrentTitle().namespace == 0 then
			return makeCategoryLink(category)
			else
			return ''
			end
	end		end

Line 112:		Line 121:
	local routeData = getRouteData(args.mode, args.route)		local routeData = getRouteData(args.mode, args.route)
	if not routeData then		if not routeData then
	return ~~makeCategoryLink~~(INVALID_ROUTE_CATEGORY)		return renderTrackingCategory(INVALID_ROUTE_CATEGORY)
	end		end

Line 118:		Line 127:
	ret = ret .. renderFunc(args, routeData)		ret = ret .. renderFunc(args, routeData)
	if hasDeprecatedParameters(args) then		if hasDeprecatedParameters(args) then
	ret = ret .. ~~makeCategoryLink~~(DEPRECATED_PARAMETER_CATEGORY)		ret = ret .. renderTrackingCategory(DEPRECATED_PARAMETER_CATEGORY)
	end		end
	return ret		return ret

2019-03-11T06:06:01Z

sync from main module

← Previous revision		Revision as of 06:06, 11 March 2019
Line 22:		Line 22:

	local function makePtvUrl(routeData)		local function makePtvUrl(routeData)
	-- ~~Make~~ the URL for a PTV route page.		-- Generate the URL for a PTV route page.
	return 'https://www.ptv.vic.gov.au/route/' .. routeData.page		return 'https://www.ptv.vic.gov.au/route/' .. routeData.page
	end		end

2019-03-10T13:04:29Z

add a comment for normalizeArguments

← Previous revision		Revision as of 13:04, 10 March 2019
Line 90:		Line 90:

	local function normalizeArguments(args)		local function normalizeArguments(args)
			-- Normalize the arguments that we received.
	-- ~~Make~~ a copy of the table so we don't alter our caller's data		-- First, make a copy of the table so we don't alter our caller's data.
	local ret = {}		local ret = {}
	for key, value in pairs(args) do		for key, value in pairs(args) do

2019-03-10T13:02:02Z

output a tracking category if the user specifies an invalid route or uses deprecated parameters

@@ Line 4: / Line 4: @@
 local p = {}
 local function makeExternalLink(url, display)
@@ Line 22: / Line 14: @@
 		return string.format('[%s]', url)
 	end
 end
@@ Line 53: / Line 50: @@
 end
-function p._main(args)
+local function makePtvLink(args, routeData)
-	-- Generate a link to a Public Transport Victoria route.
+	-- Make a link to a PTV route page.
 	local url = makePtvUrl(routeData)
 	local display = makeDisplayText(args, routeData)
@@ Line 66: / Line 57: @@
 end
-function p._cite(args)
+local function makePtvCitation(args, routeData)
-	-- Generate a citation for a Public Transport Victoria route.
+	-- Make a citation for a PTV route page.
 	local title
 	if args.route == routeData.text then
@@ Line 101: / Line 87: @@
 		args = citeArgs,
+	}
 end

2019-03-10T10:21:29Z

sync from main module

← Previous revision		Revision as of 10:21, 10 March 2019
Line 1:		Line 1:
	-- This module implements [[Template:PTV route]].

	require('Module:No globals')		require('Module:No globals')

2019-03-09T15:30:22Z

use the new data module

← Previous revision		Revision as of 15:30, 9 March 2019
Line 3:		Line 3:
	require('Module:No globals')		require('Module:No globals')

	local data = mw.loadData('Module:~~PTVBus~~/data')		local data = mw.loadData('Module:PTV route/data')
	local p = {}		local p = {}

2019-03-09T15:28:34Z

allow the first positional parameter instead of "route"

← Previous revision		Revision as of 15:28, 9 March 2019
Line 3:		Line 3:
	require('Module:No globals')		require('Module:No globals')

	local data = mw.loadData('Module:~~PTV route~~/data')		local data = mw.loadData('Module:PTVBus/data')
	local p = {}		local p = {}

			local function normalizeArguments(args)
			-- Make a copy of the table so we don't alter our caller's data
			local ret = {}
			for key, value in pairs(args) do
			ret[key] = value
			end
			-- Set aliases
			ret.route = ret.route or ret[1]
			return ret
			end

	local function makeExternalLink(url, display)		local function makeExternalLink(url, display)
Line 46:		Line 57:
	function p._main(args)		function p._main(args)
	-- Generate a link to a Public Transport Victoria route.		-- Generate a link to a Public Transport Victoria route.
			args = normalizeArguments(args)
	local routeData = getRouteData(args.mode, args.route)		local routeData = getRouteData(args.mode, args.route)
	if not routeData then		if not routeData then
Line 58:		Line 70:
	function p._cite(args)		function p._cite(args)
	-- Generate a citation for a Public Transport Victoria route.		-- Generate a citation for a Public Transport Victoria route.
			args = normalizeArguments(args)
	local routeData = getRouteData(args.mode, args.route)		local routeData = getRouteData(args.mode, args.route)
	if not routeData then		if not routeData then