Compare commits

...

8 commits

23 changed files with 133 additions and 65 deletions

View file

@ -1,5 +1,8 @@
return { return {
_all = { _all = {
lpath = "?.lua;?/init.lua" lpath = "?.lua;?/init.lua"
} };
core = {
recursive = false
};
} }

2
.editorconfig Normal file
View file

@ -0,0 +1,2 @@
[*]
indent_style = tab

3
.luarc.json Normal file
View file

@ -0,0 +1,3 @@
{
"workspace.checkThirdParty": false
}

View file

@ -1,30 +0,0 @@
package = "glass"
version = "dev-1"
source = {
url = "git+https://github.com/darkwiiplayer/glass"
}
description = {
homepage = "https://github.com/darkwiiplayer/glass",
license = "Unlicense"
}
dependencies = {
"luafilesystem"
}
build = {
type = "builtin",
modules = {
glass = "glass.lua",
["glass.cosmo"] = "glass/cosmo.lua",
["glass.discount"] = "glass/discount.lua",
["glass.environment"] = "glass/environment.lua",
["glass.error"] = "glass/error.lua",
["glass.json"] = "glass/json.lua",
["glass.lua"] = "glass/lua.lua",
["glass.moonhtml"] = "glass/moonhtml.lua",
["glass.raw"] = "glass/raw.lua",
["glass.skooma.html"] = "glass/skooma/html.lua",
["glass.skooma.xml"] = "glass/skooma/xml.lua",
["glass.table"] = "glass/table.lua",
["glass.yaml"] = "glass/yaml.lua",
}
}

32
glass-dev-2.rockspec Normal file
View file

@ -0,0 +1,32 @@
package = "glass"
version = "dev-2"
source = {
url = "git+https://github.com/darkwiiplayer/glass"
}
description = {
summary = "A library to load configuration files by accessing tables",
homepage = "https://github.com/darkwiiplayer/glass",
license = "Unlicense"
}
dependencies = {
"luafilesystem"
}
build = {
type = "builtin",
modules = {
glass = "glass.lua",
["glass.cosmo"] = "glass/cosmo.lua",
["glass.csv"] = "glass/csv.lua",
["glass.discount"] = "glass/discount.lua",
["glass.environment"] = "glass/environment.lua",
["glass.error"] = "glass/error.lua",
["glass.fennel"] = "glass/fennel.lua",
["glass.json"] = "glass/json.lua",
["glass.lua"] = "glass/lua.lua",
["glass.raw"] = "glass/raw.lua",
["glass.skooma.html"] = "glass/skooma/html.lua",
["glass.skooma.xml"] = "glass/skooma/xml.lua",
["glass.table"] = "glass/table.lua",
["glass.yaml"] = "glass/yaml.lua",
}
}

View file

@ -21,8 +21,8 @@ function __metatable:__index(index)
return config.bind(path, self.__loaders) return config.bind(path, self.__loaders)
else else
for _, loader in ipairs(self.__loaders) do for _, loader in ipairs(self.__loaders) do
local result = loader(path) local success, result = loader(path)
if result then if success then
rawset(self, index, result) rawset(self, index, result)
return result return result
end end

View file

@ -2,7 +2,7 @@
-- @module glass.cosmo -- @module glass.cosmo
local cosmo = require 'cosmo' local cosmo = require 'cosmo'
local readfile = require 'restia.config.readfile' local raw = require 'glass.raw'
--- Loads a cosmo template from a file and returns the compiled template. --- Loads a cosmo template from a file and returns the compiled template.
-- Returns nil if no template can be found. -- Returns nil if no template can be found.
@ -10,10 +10,8 @@ local readfile = require 'restia.config.readfile'
-- @function load -- @function load
return function(name) return function(name)
name = tostring(name) .. '.cosmo' name = tostring(name) .. '.cosmo'
local text = readfile(name) local text = raw(name)
if text then if text then
return assert(cosmo.compile(text, name)) return true, assert(cosmo.compile(text, name))
else
return nil
end end
end end

15
glass/csv.lua Normal file
View file

@ -0,0 +1,15 @@
--- Loader for CSV-Data using streamcsv
-- @module glass.csv
local csv = require 'streamcsv'
--- Loads a CSV-File and returns a corresponding Lua table.
-- CSV file is assumed to have a header row.
-- @treturn table CSV-Data
-- @function load
return function(name)
local file = io.open(name..'.csv')
if file then
return true, csv.file(file)
end
end

View file

@ -14,10 +14,8 @@ return function(name)
local file = io.open(name) local file = io.open(name)
if file then if file then
local html = discount(file:read("*a")) local html = discount(file:read("*a"))
return function() return true, function()
return html return html
end end
else
return nil
end end
end end

View file

@ -4,5 +4,5 @@
--- Loads values from environment variables --- Loads values from environment variables
-- @treturn string The value of the environment variable -- @treturn string The value of the environment variable
return function(name) return function(name)
return os.getenv(name:match("[^/].+$")) return true, os.getenv(name:match("[^/].+$"))
end end

18
glass/fennel.lua Normal file
View file

@ -0,0 +1,18 @@
--- Loader for Fennel files
-- @module glass.fennel
local fennel = require "fennel"
local read = require 'glass.raw'
--- Loads and compiles a Fennel file and runs it.
-- Returns the result of running the Fennel file.
-- If running the code immediately is not desired,
-- it has to be returned as a function.
-- @return The result of the Fennel file after running it
-- @function load
return function(file)
local success, raw = read(file..'.fnl')
if success then
return true, fennel.eval(raw)
end
end

View file

@ -2,7 +2,7 @@
-- @module glass.json -- @module glass.json
local json = require 'cjson' local json = require 'cjson'
local readfile = require 'restia.cofnig.readfile' local read = require 'glass.raw'
--- Loads a JSON-File and returns a corresponding Lua table. --- Loads a JSON-File and returns a corresponding Lua table.
-- May return non-table values for invalid JSON, -- May return non-table values for invalid JSON,
@ -11,8 +11,8 @@ local readfile = require 'restia.cofnig.readfile'
-- @treturn table JSON-Data -- @treturn table JSON-Data
-- @function load -- @function load
return function(file) return function(file)
local raw = readfile(file..'.json') local success, raw = read(file..'.json')
if raw then if success then
return json.decode(raw) return true, json.decode(raw)
end end
end end

View file

@ -9,5 +9,7 @@
-- @function load -- @function load
return function(name) return function(name)
local f = loadfile(name..'.lua') local f = loadfile(name..'.lua')
return f and f() or nil if f then
return true, f()
end
end end

View file

@ -1,7 +1,6 @@
--- Loader for MoonHTML files --- Loader for MoonHTML files
-- @module glass.moonhtml -- @module glass.moonhtml
local template = require 'restia.template' local template = require 'restia.template'
--- Loads and compiles a moonhtml template. --- Loads and compiles a moonhtml template.
@ -11,7 +10,7 @@ return function(name)
name = tostring(name) .. '.moonhtml' name = tostring(name) .. '.moonhtml'
local file = io.open(name) local file = io.open(name)
if file then if file then
return assert(template.loadmoon(file:read("*a"), name)) return true, assert(template.loadmoon(file:read("*a"), name))
else else
return nil return nil
end end

View file

@ -6,8 +6,10 @@
-- @function load -- @function load
return function(path) return function(path)
local f = io.open(path) local f = io.open(path)
if not f then return end if not f then
return false
end
local result = f:read("*a") local result = f:read("*a")
f:close() f:close()
return result return true, result
end end

View file

@ -17,9 +17,12 @@ end})
-- @function load -- @function load
return function(name) return function(name)
name = tostring(name)..'.html.skooma' name = tostring(name)..'.html.skooma'
local template = loadfile(name, "t", env) local template, err = loadfile(name, "t", env)
if template == nil then
return nil, err
end
if setfenv then if setfenv then
setfenv(template, env) setfenv(template, env)
end end
return template return true, template
end end

View file

@ -17,9 +17,12 @@ end})
-- @function load -- @function load
return function(name) return function(name)
name = tostring(name)..'.xml.skooma' name = tostring(name)..'.xml.skooma'
local template = loadfile(name, "t", env) local template, err = loadfile(name, "t", env)
if template == nil then
return nil, err
end
if setfenv then if setfenv then
setfenv(template, env) setfenv(template, env)
end end
return template return true, template
end end

View file

@ -7,6 +7,9 @@
-- @treturn function A loader function to be used with `glass.bind` -- @treturn function A loader function to be used with `glass.bind`
return function(input) return function(input)
return function(name) return function(name)
return input[name:match("[^/].+$")] local result = input[name:match("[^/].+$")]
if result then
return true, result
end
end end
end end

View file

@ -2,7 +2,7 @@
-- @module glass.yaml -- @module glass.yaml
local yaml = require 'lyaml' local yaml = require 'lyaml'
local readfile = require 'restia.config.readfile' local read = require 'glass.raw'
--- Loads a YAML-File and returns a corresponding Lua table. --- Loads a YAML-File and returns a corresponding Lua table.
-- May return non-table values for invalid YAML, -- May return non-table values for invalid YAML,
@ -11,8 +11,11 @@ local readfile = require 'restia.config.readfile'
-- @treturn table YAML-Data -- @treturn table YAML-Data
-- @function load -- @function load
return function(file) return function(file)
local raw = readfile(file..'.yml') or readfile(file..'.yaml') local success, raw = read(file..'.yml')
if raw then if not success then
return yaml.load(raw) success, raw = read(file..'.yaml')
end
if success then
return true, yaml.load(raw)
end end
end end

View file

@ -28,8 +28,10 @@ A glass loader is initialised with a list of loaders and will try each of them i
## Loaders ## Loaders
Glass offers the following loaders out of the box: Glass offers the following loaders out of the box:
* `cosmo` loads cosmo templates * `cosmo` loads cosmo templates
* `csv` loads csv files (with header line)
* `discount` loads markdown files\*. * `discount` loads markdown files\*.
* `environment` loads environment variables. * `environment` loads environment variables.
* `fennel` loads and executes fennel files.
* `json` loads a JSON file as a Lua table. (requires `cjson`) * `json` loads a JSON file as a Lua table. (requires `cjson`)
* `lua` loads and executes a Lua file. * `lua` loads and executes a Lua file.
* `moonhtml` loads a MoonHTML template and returns it as a function. * `moonhtml` loads a MoonHTML template and returns it as a function.
@ -52,6 +54,8 @@ file and attempts to load it into a Lua value.
Loaders will typically add an extension to the given file name before checking Loaders will typically add an extension to the given file name before checking
whether that file exists and can be loaded. whether that file exists and can be loaded.
When a loader cannot find the expected file, it should return `nil` to let glass A successful loader should return `true` followed by its result.
continue the loader chain. When a loader returns a truthy value, this will be When a loader can't load a key, it should return `false` and an optional
used and no further loaders will be tried. description of why.
When a loader encounters an error (file found but can't be parsed), it should
error.

View file

@ -0,0 +1,6 @@
describe 'fennel loader', ->
before_each -> export loader = require 'glass.fennel'
it 'loads Fennel files', ->
success, result = loader 'spec/fixtures/test'
assert.true success
assert.same { foo: 'bar', tab: {} }, result

2
spec/fixtures/test.fnl vendored Normal file
View file

@ -0,0 +1,2 @@
{"foo" "bar"
"tab" []}

View file

@ -1,9 +1,11 @@
describe 'raw loader', -> describe 'raw loader', ->
before_each -> export loader = require 'glass.raw' before_each -> export loader = require 'glass.raw'
it 'loads files as plain text', -> it 'loads files as plain text', ->
assert.same 'plain text\n', loader 'spec/fixtures/test' assert.same {true, 'plain text\n'}, {loader 'spec/fixtures/test'}
describe 'lua loader', -> describe 'lua loader', ->
before_each -> export loader = require 'glass.lua' before_each -> export loader = require 'glass.lua'
it 'loads Lua files', -> it 'loads Lua files', ->
assert.same { foo: 'bar', tab: {} }, loader 'spec/fixtures/test' success, result = loader 'spec/fixtures/test'
assert.true success
assert.same { foo: 'bar', tab: {} }, result