Module:Mock title/doc - Revision history

Mr. Stradivarius: fix more spelling mistakes

2023-08-28T13:57:54Z

fix more spelling mistakes

← Previous revision		Revision as of 13:57, 28 August 2023
Line 240:		Line 240:
	** A table of MockTitle object options (table)		** A table of MockTitle object options (table)

	==== ~~deregsiterMockTitles~~ ====		==== deregisterMockTitles ====

	Remove multiple titles from the mock title registry.		Remove multiple titles from the mock title registry.
Line 258:		Line 258:
	* A table of MockTitle object options (table)		* A table of MockTitle object options (table)

	==== ~~deregsiterMockCurrentTitle~~ ====		==== deregisterMockCurrentTitle ====

	Remove the mock title registered as the current title.		Remove the mock title registered as the current title.

Mr. Stradivarius: /* regsiterMockTitles */ sp

2023-08-28T13:56:47Z

regsiterMockTitles: sp

← Previous revision		Revision as of 13:56, 28 August 2023
Line 192:		Line 192:
	* '''titleOrOptions''' - a [[#MockTitle\|MockTitle]] object, or a table of MockTitle object options. (table, required)		* '''titleOrOptions''' - a [[#MockTitle\|MockTitle]] object, or a table of MockTitle object options. (table, required)

	==== ~~regsiterMockTitles~~ ====		==== registerMockTitles ====

	Register multiple mock titles.		Register multiple mock titles.

Mr. Stradivarius: finish first draft of documentation

2023-08-22T13:51:47Z

finish first draft of documentation

Show changes

Mr. Stradivarius: document another function, and add empty sections for the others

2023-08-22T00:38:46Z

document another function, and add empty sections for the others

@@ Line 51: / Line 51: @@
 == API documentation ==
-=== MockTitle ===
+=== Mock title constructors ===
 Creates a mock title object.
@@ Line 65: / Line 67: @@
 Parameters:
-This function takes a table of options. The possible keys are as follows:
+This function takes a table of options. The possible options are as follows:
 * '''title''' - the page title. If this is a string, it is the page title as used with [[mw:Extension:Scribunto/Lua reference manual#mw.title.new|mw.title.new]]. If it is a number, it is the page ID. (required)
@@ Line 113: / Line 115: @@
+}
 </syntaxhighlight>
 <includeonly>{{Sandbox other||

Mr. Stradivarius: /* MockTitle */ fix missing space

2023-08-16T23:16:41Z

MockTitle: fix missing space

← Previous revision		Revision as of 23:16, 16 August 2023
Line 85:		Line 85:
	* '''fileWidth''' - the file width in pixels (not used for non-file titles). (int, optional)		* '''fileWidth''' - the file width in pixels (not used for non-file titles). (int, optional)
	* '''fileHeight''' - the file height in pixels (not used for non-file titles). (int, optional)		* '''fileHeight''' - the file height in pixels (not used for non-file titles). (int, optional)
	* '''filePages''' - pages in the file (not used for non-file titles). See [[mw:Extension:Scribunto/Lua reference manual#File metadata\|the Scribunto documentation]] of the title object <code>pages</code> ~~parameterfor~~ the correct format. (table, optional)		* '''filePages''' - pages in the file (not used for non-file titles). See [[mw:Extension:Scribunto/Lua reference manual#File metadata\|the Scribunto documentation]] of the title object <code>pages</code> parameter for the correct format. (table, optional)
	* '''fileSize''' - the file size in bytes (not used for non-file titles). (int, optional)		* '''fileSize''' - the file size in bytes (not used for non-file titles). (int, optional)
	* '''fileMimeType''' - the [[MIME type]] of the file (not used for non-file titles). (int, optional)		* '''fileMimeType''' - the [[MIME type]] of the file (not used for non-file titles). (int, optional)

Mr. Stradivarius: document MockTitle function

2023-08-16T15:01:03Z

document MockTitle function

@@ Line 47: / Line 47: @@
 mMockTitle.patchTitleConstructors(logCurrentTitle) -- Logs "User:Example"
 logCurrentTitle() -- Logs "Module:Mock title"
 </syntaxhighlight>

Mr. Stradivarius: /* Patching title constructors */ link title constructors

2023-08-15T14:37:32Z

Patching title constructors: link title constructors

← Previous revision		Revision as of 14:37, 15 August 2023
Line 36:		Line 36:
	=== Patching title constructors ===		=== Patching title constructors ===

	During tests, you can use the <code>patchTitleConstructors</code> function to temporarily replace the title constructors mw.title.new, mw.title.makeTitle and mw.title.getCurrentTitle with functions that return the mock titles that you registered. You pass <code>patchTitleConstructors</code> your own function containing your test code; while the function is running the title constructors will return mock titles, but after it finishes running they will be restored to their original versions.		During tests, you can use the <code>patchTitleConstructors</code> function to temporarily replace the title constructors [[mw:Extension:Scribunto/Lua reference manual#mw.title.new\|mw.title.new]], [[mw:Extension:Scribunto/Lua reference manual#mw.title.makeTitle\|mw.title.makeTitle]] and [[mw:Extension:Scribunto/Lua reference manual#mw.title.getCurrentTitle\|mw.title.getCurrentTitle]] with functions that return the mock titles that you registered. You pass <code>patchTitleConstructors</code> your own function containing your test code; while the function is running the title constructors will return mock titles, but after it finishes running they will be restored to their original versions.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Mr. Stradivarius: start documentation

2023-08-15T14:32:14Z

start documentation

New page

This module allows you to easily [[mock object|mock]] Scribunto [[mw:Extension:Scribunto/Lua reference manual#Title objects|title objects]]. This can be useful when writing unit tests for modules which depend on whether a certain page exists, or whether a certain page is a redirect, etc. If you don't use mock title objects, then you run the risk of some editor changing a page that your test cases relied on (e.g. redirecting it or deleting it), thus breaking your tests. By using mock objects, you get to specify things like existence status and redirect status in your tests, making them more resilient against changes to real pages.

== Usage ==

=== Loading the module ===

Load the module using <code>require</code>:

<syntaxhighlight lang="lua">
local mMockTitle = require('Module:Mock title')
</syntaxhighlight>

=== Registering titles to mock ===

You can register a title to be mocked with the <code>registerMockTitle</code> function.

<syntaxhighlight lang="lua">
mMockTitle.registerMockTitle({title = "Main Page", isRedirect = true, redirectTarget = "Wikipedia:Village stocks"})
</syntaxhighlight>

Or you can register multiple titles at once using <code>registerMockTitles</code>.

<syntaxhighlight lang="lua">
mMockTitle.registerMockTitles(
{title = "File:Example.png", height = 250, width = 200},
{title = "Template:3x", editProtection = "templateeditor"}
)
</syntaxhighlight>

You can also register a mock for the current page with <code>registerMockCurrentTitle</code>.

<syntaxhighlight lang="lua">
mMockTitle.registerMockCurrentTitle({title = "User:Example"})
</syntaxhighlight>

=== Patching title constructors ===

During tests, you can use the <code>patchTitleConstructors</code> function to temporarily replace the title constructors mw.title.new, mw.title.makeTitle and mw.title.getCurrentTitle with functions that return the mock titles that you registered. You pass <code>patchTitleConstructors</code> your own function containing your test code; while the function is running the title constructors will return mock titles, but after it finishes running they will be restored to their original versions.

<syntaxhighlight lang="lua">

local function logCurrentTitle()
mw.log(mw.title.getCurrentTitle().prefixedText)
end

logCurrentTitle() -- Logs "Module:Mock title"
mMockTitle.patchTitleConstructors(logCurrentTitle) -- Logs "User:Example"
logCurrentTitle() -- Logs "Module:Mock title"
</syntaxhighlight>

<includeonly>{{Sandbox other||


}}</includeonly>