Module:ca-IPA/testcases/driver

This module lacks a documentation subpage. Please create it.

Useful links: root page • root page’s subpages • links • transclusions • testcases • sandbox

---

local export = {}

--[=[
This module contains driver code for running a given set of testcases for [[Module:ca-IPA]]. The testcases are split
into multiple subsets because there are too many of them to include in a single module (you get a time-expired error).
The maximum number of examples in a subset is not completely clear but it is somewhere between 600 and 1500.

To create a new subset, copy an existing subset and modify the examples, and set up the corresponding documentation page
as appropriate. For example, to create a subset specifically for English-origin words, copy an existing subset page such
as [[Module:ca-IPA/testcases/prefixes]] to e.g. [[Module:ca-IPA/testcases/english]]. Also copy the documentation page
[[Module:ca-IPA/testcases/prefixes/documentation]] to e.g. [[Module:ca-IPA/testcases/english/documentation]],
modifying the module invocation reference in the documentation page as appropriate to point to your subset module.
Then modify the examples in e.g. [[Module:ca-IPA/testcases/english]] according to the following format.

Each line of the example text is either a high-level header beginning with ###, a subheader beginning with ##, a comment
beginning with #, a blank line or an example. Examples consist of three tab-separated fields, followed by an optional
comment to be shown along with the example (delimited by a # preceded by whitespace). The first field is the actual
spelling of the term in question. The second field is the respelling. The third field is the expected phonemic IPA
pronunciation.

Example #1:

Aachener	Aachener	ˈaːxənɐ

This specifies a word [[Aachener]], respelled 'Aachener' (i.e. same as the actual spelling), with phonemic pronunciation
/ˈaːxənɐ/.

Example #2:

Bodyguard	Boddigàhrd	ˈbɔdiˌɡaːʁt

This specifies a word [[Bodyguard]], respelled 'Boddigàhrd', with phonemic pronunciation /ˈbɔdiˌɡaːʁt/.

Example #3:

Chefredakteur	Schef-redaktö́r	ˈʃeːfʁedakˌtøːʁ # usually in Austria

This specifies a word [[Chefredakteur]], respelled 'Schef-redaktö́r', with phonemic pronunciation /ˈʃeːfʁedakˌtøːʁ/ and
a comment "usually in Austria".
]=]

local m_ca_pron = require("Module:ca-IPA")
local m_links = require("Module:links")
local lang = require("Module:languages").getByCode("ca")

local rsplit = mw.text.split
local rmatch = mw.ustring.match

local function tag_IPA(IPA)
	return '<span class="IPA">' .. IPA .. "</span>"
end

local function link(text)
	return m_links.full_link{ term = text, lang = lang }
end

local options = { display = tag_IPA }

function export.check_ipa(self, spelling, respelling, expected, dialect, comment)
	local phonemic = m_ca_pron.test(spelling, respelling, dialect)
	options.comment = comment or ""
	self:equals(
		link(spelling) .. (respelling == spelling and "" or ", respelled " .. respelling ..
			(dialect == "val" and ", Valencian" or dialect == "bal" and ", Balearic" or "")),
		phonemic,
		expected,
		options
	)
end

function export.parse(examples)
	-- The following is a list of parsed examples where each element is a four-element list of
	-- {SPELLING, RESPELLING, EXPECTED, COMMENT}. SPELLING is the actual spelling of the term; RESPELLING is the
	-- respelling; EXPECTED is the phonemic IPA; and COMMENT is an optional comment or nil.
	local parsed_examples = {}
	-- Snarf each line.
	for line in examples:gmatch "[^\n]+" do
		-- Trim whitespace at beginning and end.
		line = line:gsub("^%s*(.-)%s*$", "%1")
		local function err(msg)
			error(msg .. ": " .. line)
		end
		if line == "" then
			-- Skip blank lines.
		elseif line:find("^###") then
			-- Line beginning with ### is a high-level header.
			line = line:gsub("^###%s*", "")
			table.insert(parsed_examples, "#h1:" .. line)
		elseif line:find("^##") then
			-- Line beginning with ## is a subheader.
			line = line:gsub("^##%s*", "")
			table.insert(parsed_examples, line)
		elseif line:find("^#") then
			-- Line beginning with # is a comment; ignore.
		else
			local line_no_comment, comment = rmatch(line, "^(.-)%s+#%s*(.*)$")
			line_no_comment = line_no_comment or line
			local parts = rsplit(line_no_comment, "\t")
			if #parts ~= 3 and #parts ~= 4 then
				err("Expected 3 or 4 tab-separated components in example (not including any comment)")
			end
			if #parts == 3 then
				table.insert(parts, "cen")
			end
			table.insert(parts, comment)
			table.insert(parsed_examples, parts)
		end
	end
	return parsed_examples
end

return export