Onarum

Prerequisite

• Lua 5.1

Installation

$ git clone [email protected]:blackwindforce/onarum.git
$ cd onarum
$ git submodule update --init

Usage

SYNOPSIS
  onarum <package> [<path>]

OPTIONS
  <path>
    Similar to `package.path` in Lua, but simply remove the provided path from
    module name in `package.preload`, which shorten module names in the program.

EXAMPLE 1
  onarum package.lua > bundle.lua

EXAMPLE 2
  onarum package.lua ./lib/lua-inspect/lib/ > bundle.lua

CAVEATS
  `onarum` CAN NOT use as a system executable due to `luarocks` does not support
  `git submodule`, you MUST use `onarum` under `/bin` instead.

Example

package.lua

Require module dependencies.

require('spec.fixtures.add')

add.lua

Write modules as usual.

return function(x)
  return function(y)
    return x + y
  end
end

bundle.lua

Preload modules in the bundle.

package = package or {}
package.loaded = package.loaded or {
  _G = _G,
  coroutine = coroutine,
  debug = debug,
  io = io,
  math = math,
  os = os,
  package = package,
  string = string,
  table = table
}
package.preload = package.preload or {}

require = require or function(modname)
  if package.loaded[modname] == nil then
    assert(package.preload[modname], ("module '%s' not found"):format(modname))
    local mod = package.preload[modname]()
    package.loaded[modname] = mod == nil or mod
  end
  return package.loaded[modname]
end

package.preload['spec.fixtures.add'] = function()
return function(x)
  return function(y)
    return x + y
  end
end

end

init.lua

Use modules as usual.

print(require('spec.fixtures.add')(1)(2) == 3)

Testing

$ luarocks install busted
$ luarocks install luacheck
$ luarocks install luacov
$ luarocks install luacov-console
$ make test