9304191631

Committed 30 May 2024 02:21PM UTC coverage: 49.894% (-10.8%) from 60.669%

Build # 9304191631

Build Type

push

github

Committed by

web-flow

Commit Message

Merge fcc56c666 into 1a26b4f22

Run Details

8447 of 16930 relevant lines covered (49.89%)

1187.3 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.24

/packages/base.lua

--- SILE package class.
-- @interfaces packages

local package = pl.class()
package.type = "package"
package._name = "base"

package._initialized = false
package.class = nil

-- For shimming packages that used to have legacy exports
package.exports = {}

local function script_path ()
   local src = debug.getinfo(3, "S").source:sub(2)
   local base = src:match("(.*[/\\])")
   return base
end

local settingDeclarations = {}
local rawhandlerRegistrations = {}
local commandRegistrations = {}

function package:_init (_, reload)
   self.class = SILE.scratch.half_initialized_class or SILE.documentState.documentClass
   if not self.class then
      SU.error("Attempted to initialize package before class, should have been queued in the preamble", true)
   end
   self.basedir = script_path()
   -- Note string.format(%p) would be nicer than tostring() but only LuaJIT and Lua 5.4 support it
   local settingsDeclarator = tostring(self.declareSettings)
   if reload or not settingDeclarations[settingsDeclarator] then
      settingDeclarations[settingsDeclarator] = true
      self:declareSettings()
   end
   local rawhandlerRegistrator = tostring(self.registerRawHandlers)
   if reload or not rawhandlerRegistrations[rawhandlerRegistrator] then
      rawhandlerRegistrations[rawhandlerRegistrator] = true
      self:registerRawHandlers()
   end
   local commandRegistrator = tostring(self.registerCommands)
   if reload or not commandRegistrations[commandRegistrator] then
      commandRegistrations[commandRegistrator] = true
      self:registerCommands()
   end
end

function package:_post_init ()
   self._initialized = true
end

function package.declareSettings (_) end

function package.registerRawHandlers (_) end

function package:loadPackage (packname, options, reload)
   return self.class:loadPackage(packname, options, reload)
end

function package:reloadPackage (packname, options)
   return self.class:reloadPackage(packname, options)
end

function package.registerCommands (_) end

-- This gives us a hook to match commands with the packages that registered
-- them as opposed to core commands or class-provided commands

--- Register a function as a SILE command.
-- Takes any Lua function and registers it for use as a SILE command (which will in turn be used to process any content
-- nodes identified with the command name.
--
-- A similar method is available for classes, `classes:registerCommand`.
-- @tparam string name Name of cammand to register.
-- @tparam function func Callback function to use as command handler.
-- @tparam[opt] nil|string help User friendly short usage string for use in error messages, documentation, etc.
-- @tparam[opt] nil|string pack Information identifying the module registering the command for use in error and usage
-- messages. Usually auto-detected.
-- @see SILE.classes:registerCommand
function package:registerCommand (name, func, help, pack)
   self.class:registerCommand(name, func, help, pack)
end
function package:registerRawHandler (format, callback)
   self.class:registerRawHandler(format, callback)
end

-- Using this rather than doing the work directly will give us a way to
-- un-export them if we ever need to unload modules and revert functions
function package:export (name, func)
   self.class[name] = func
end

-- Shims for two possible kinds of legacy exports: blind direct stuffing into
-- the class but not expecting to be called as a method AND the exports table
-- to package modules...

local _deprecate_class_funcs = [[
  Please explicitly use functions provided by packages by referencing
  them in the document class's list of loaded packages rather than the
  legacy solution that added non-method functions to the class.]]

local _deprecate_exports_table = [[
  Please explicitly use functions provided by packages by referencing
  them in the document class's list of loaded packages rather than the
  legacy solution of calling them from an exports table.]]

function package:deprecatedExport (name, func, noclass, notable)
   if not noclass then
      self.class[name] = function (...)
         -- http://lua-users.org/wiki/VarargTheSecondClassCitizen
         local inputs = { ... }
         -- local inputs = table.unpack({...}, 1, select("#", ...))
         if type(inputs[1]) ~= "table" or inputs[1].type ~= "class" then
            table.insert(inputs, 1, self.class)
         end
         SU.deprecated(
            ("class.%s"):format(name),
            ("class.packages.%s:%s"):format(self._name, name),
            "0.14.0",
            "0.16.0",
            _deprecate_class_funcs
         )
         return func(pl.utils.unpack(inputs, 1, select("#", ...) + 1))
      end
   end

   if not notable then
      self.exports[name] = function (...)
         local inputs = { ... }
         if type(inputs[1]) ~= "table" or inputs[1].type ~= "package" then
            table.insert(inputs, 1, self)
         end
         SU.deprecated(
            ("require('packages.%s').exports.%s"):format(self._name, name),
            ("class.packages.%s:%s"):format(self._name, name),
            "0.14.0",
            "0.16.0",
            _deprecate_exports_table
         )
         return func(pl.utils.unpack(inputs, 1, select("#", ...) + 1))
      end
   end
end

return package

1	--- SILE package class.
2	-- @interfaces packages
3
4	local package = pl.class()	5✔
5	package.type = "package"	5✔
6	package._name = "base"	5✔
7
8	package._initialized = false	5✔
9	package.class = nil	5✔
10
11	-- For shimming packages that used to have legacy exports
12	package.exports = {}	5✔
13
14	local function script_path ()
15	local src = debug.getinfo(3, "S").source:sub(2)	22✔
16	local base = src:match("(.*[/\\])")	22✔
17	return base	22✔
18	end
19
20	local settingDeclarations = {}	5✔
21	local rawhandlerRegistrations = {}	5✔
22	local commandRegistrations = {}	5✔
23
24	function package:_init (_, reload)	5✔
25	self.class = SILE.scratch.half_initialized_class or SILE.documentState.documentClass	22✔
26	if not self.class then	22✔
27	SU.error("Attempted to initialize package before class, should have been queued in the preamble", true)	×
28	end
29	self.basedir = script_path()	44✔
30	-- Note string.format(%p) would be nicer than tostring() but only LuaJIT and Lua 5.4 support it
31	local settingsDeclarator = tostring(self.declareSettings)	22✔
32	if reload or not settingDeclarations[settingsDeclarator] then	22✔
33	settingDeclarations[settingsDeclarator] = true	7✔
34	self:declareSettings()	7✔
35	end
36	local rawhandlerRegistrator = tostring(self.registerRawHandlers)	22✔
37	if reload or not rawhandlerRegistrations[rawhandlerRegistrator] then	22✔
38	rawhandlerRegistrations[rawhandlerRegistrator] = true	5✔
39	self:registerRawHandlers()	5✔
40	end
41	local commandRegistrator = tostring(self.registerCommands)	22✔
42	if reload or not commandRegistrations[commandRegistrator] then	22✔
43	commandRegistrations[commandRegistrator] = true	20✔
44	self:registerCommands()	20✔
45	end
46	end
47
48	function package:_post_init ()	5✔
49	self._initialized = true	22✔
50	end
51
52	function package.declareSettings (_) end	10✔
53
54	function package.registerRawHandlers (_) end	10✔
55
56	function package:loadPackage (packname, options, reload)	5✔
57	return self.class:loadPackage(packname, options, reload)	7✔
58	end
59
60	function package:reloadPackage (packname, options)	5✔
61	return self.class:reloadPackage(packname, options)	×
62	end
63
64	function package.registerCommands (_) end	5✔
65
66	-- This gives us a hook to match commands with the packages that registered
67	-- them as opposed to core commands or class-provided commands
68
69	--- Register a function as a SILE command.
70	-- Takes any Lua function and registers it for use as a SILE command (which will in turn be used to process any content
71	-- nodes identified with the command name.
72	--
73	-- A similar method is available for classes, `classes:registerCommand`.
74	-- @tparam string name Name of cammand to register.
75	-- @tparam function func Callback function to use as command handler.
76	-- @tparam[opt] nil\|string help User friendly short usage string for use in error messages, documentation, etc.
77	-- @tparam[opt] nil\|string pack Information identifying the module registering the command for use in error and usage
78	-- messages. Usually auto-detected.
79	-- @see SILE.classes:registerCommand
80	function package:registerCommand (name, func, help, pack)	5✔
81	self.class:registerCommand(name, func, help, pack)	93✔
82	end
83	function package:registerRawHandler (format, callback)	5✔
84	self.class:registerRawHandler(format, callback)	×
85	end
86
87	-- Using this rather than doing the work directly will give us a way to
88	-- un-export them if we ever need to unload modules and revert functions
89	function package:export (name, func)	5✔
90	self.class[name] = func	19✔
91	end
92
93	-- Shims for two possible kinds of legacy exports: blind direct stuffing into
94	-- the class but not expecting to be called as a method AND the exports table
95	-- to package modules...
96
97	local _deprecate_class_funcs = [[
98	Please explicitly use functions provided by packages by referencing
99	them in the document class's list of loaded packages rather than the
100	legacy solution that added non-method functions to the class.]]	5✔
101
102	local _deprecate_exports_table = [[
103	Please explicitly use functions provided by packages by referencing
104	them in the document class's list of loaded packages rather than the
105	legacy solution of calling them from an exports table.]]	5✔
106
107	function package:deprecatedExport (name, func, noclass, notable)	5✔
108	if not noclass then	29✔
109	self.class[name] = function (...)	29✔
110	-- http://lua-users.org/wiki/VarargTheSecondClassCitizen
111	local inputs = { ... }	×
112	-- local inputs = table.unpack({...}, 1, select("#", ...))
113	if type(inputs[1]) ~= "table" or inputs[1].type ~= "class" then	×
114	table.insert(inputs, 1, self.class)	×
115	end
116	SU.deprecated(	×
117	("class.%s"):format(name),	×
118	("class.packages.%s:%s"):format(self._name, name),	×
119	"0.14.0",
120	"0.16.0",
121	_deprecate_class_funcs
122	)
123	return func(pl.utils.unpack(inputs, 1, select("#", ...) + 1))	×
124	end
125	end
126
127	if not notable then	29✔
128	self.exports[name] = function (...)	29✔
129	local inputs = { ... }	×
130	if type(inputs[1]) ~= "table" or inputs[1].type ~= "package" then	×
131	table.insert(inputs, 1, self)	×
132	end
133	SU.deprecated(	×
134	("require('packages.%s').exports.%s"):format(self._name, name),	×
135	("class.packages.%s:%s"):format(self._name, name),	×
136	"0.14.0",
137	"0.16.0",
138	_deprecate_exports_table
139	)
140	return func(pl.utils.unpack(inputs, 1, select("#", ...) + 1))	×
141	end
142	end
143	end
144
145	return package	5✔

sile-typesetter / sile / 9304191631

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous