lua-astra 0.25.0

🔥 Blazingly Fast 🔥 web server runtime for Lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

---@meta

--- Jinja2 templating engine
---@class TemplateEngine
---@field add_template fun(templates: TemplateEngine, name: string, template: string)
---@field add_template_file fun(templates: TemplateEngine, name: string, path: string)
---@field get_template_names fun(template: TemplateEngine): string[]
---Excludes template files from being added to the server for rendering
---@field exclude_templates fun(templates: TemplateEngine, names: string[])
---@field reload_templates fun(templates: TemplateEngine) Refreshes the template code from the glob given at the start
---@field add_function fun(templates: TemplateEngine, name: string, function: template_function): any Add a function to the templates
---Renders the given template into a string with the available context
---@field render fun(templates: TemplateEngine, name: string, context?: table): string
---@field add_to_server fun(templates: TemplateEngine, server: HTTPServer, context?: table) Adds the templates to the server
---Adds the templates to the server in debugging manner, where the content refreshes on each request
---@field add_to_server_debug fun(templates: TemplateEngine, server: HTTPServer, context?: table)

---@diagnostic disable-next-line: duplicate-doc-alias
---@alias template_function fun(args: table): any


--- Returns a new templating engine
---@param dir? string path to the directory, for example: `"templates/**/[!exclude.html]*.html"`
---@return TemplateEngine
---@nodiscard
function Astra.new_templating_engine(dir)
	---@type TemplateEngine
	---@diagnostic disable-next-line: undefined-global
	local engine = astra_internal__new_templating_engine(dir)
	---@type TemplateEngine
	---@diagnostic disable-next-line: missing-fields
	local TemplateEngineWrapper = { engine = engine }
	local templates_re = Astra.regex([[(?:index)?\.(html|lua)$]])

	local function normalize_paths(path)
		-- Ensure path starts with "/"
		if path:sub(1, 1) ~= "/" then
			path = "/" .. path
		end

		-- If empty, it's just the root
		if path == "/" then
			return { "/" }
		end

		-- Return both with and without trailing slash
		if path:sub(-1) == "/" then
			return { path, path:sub(1, -2) }
		else
			return { path, path .. "/" }
		end
	end

	function TemplateEngineWrapper:add_to_server(server, context)
		local names = self.engine:get_template_names()
		for _, value in ipairs(names) do
			local path = templates_re:replace(value, "")
			local content = self.engine:render(value, context)

			for _, route in ipairs(normalize_paths(path)) do
				server:get(route, function(_, response)
					response:set_header("Content-Type", "text/html")
					return content
				end)
			end
		end
	end

	function TemplateEngineWrapper:add_to_server_debug(server, context)
		local names = self.engine:get_template_names()
		for _, value in ipairs(names) do
			local path = templates_re:replace(value, "")

			for _, route in ipairs(normalize_paths(path)) do
				server:get(route, function(_, response)
					self.engine:reload_templates()
					response:set_header("Content-Type", "text/html")
					return self.engine:render(value, context)
				end)
			end
		end
	end

	local templating_methods = {
		"add_template",
		"add_template_file",
		"get_template_names",
		"exclude_templates",
		"reload_templates",
		"context_add",
		"context_remove",
		"context_get",
		"add_function",
		"render",
	}

	for _, method in ipairs(templating_methods) do
		---@diagnostic disable-next-line: assign-type-mismatch
		TemplateEngineWrapper[method] = function(self, ...)
			return self.engine[method](self.engine, ...)
		end
	end

	return TemplateEngineWrapper
end