class
Analyzer::Lua::Lapis
- Analyzer::Lua::Lapis
- Analyzer
- Reference
- Object
Overview
Lapis is a Lua/MoonScript web framework on top of OpenResty. Routes can be expressed in several styles:
- Method-specific calls —
app:get("/path", handler),app:post,app:put,app:delete,app:patch,app:head,app:options. - Generic
app:match(path, handler)and the namedapp:match("name", "/path", handler)form, both of which dispatch on any HTTP method. - Application-table style:
["/path"] = "handler_name"or["/path"] = function(self) ... end. - MoonScript class actions:
"/path": =>and the named form[name: "/path"]: =>.
Path parameters use :name and splats use *name, which already
match noir's URL convention so they are surfaced verbatim. Lapis
route patterns additionally carry Lua-pattern constraints
(:id[%d], :slug[%w]) and optional groups ((/page/:page)),
neither of which belong in a concrete URL — both are normalised
away. Sub-apps mounted with app:include(...) carry an
app.path = "/prefix" that every route inherits, so the prefix is
detected per file and prepended to the routes bound on that app.
Defined in:
analyzer/analyzers/lua/lapis.crConstant Summary
-
APP_PATH_RE =
/(?:^|[^A-Za-z0-9_.])([A-Za-z_]\w*)\.path\s*=\s*(['"])([^'"]*)\2/ -
APP_VAR_RE =
/(?:^|[^A-Za-z0-9_])(?:local\s+)?([A-Za-z_]\w*)\s*=\s*lapis\.Application(?:\b|:extend|\s*\()/ -
FALLBACK_METHODS =
["GET", "POST", "PUT", "DELETE", "PATCH"] -
HTTP_METHODS =
["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"] of ::String -
MOON_ACTION_MARKER_RE =
Regex.union("=>", "respond_to") -
moonscript_action?'s two OR-ed String#includes? scans, folded into one precompiled union so the boolean gate costs a single PCRE2 match instead of up to two naive substring scans. -
MOON_PATH_RE =
/@path\s*:\s*(['"])([^'"]*)\1/
Class Method Summary
Instance Method Summary
- #analyze
-
#tech : String
Instance-side view of the same declaration.
Instance methods inherited from class Analyzer
analyze
analyze,
base_path : String
base_path,
base_paths : Array(String)
base_paths,
base_relative_path(path : String) : String
base_relative_path,
callees_needed? : Bool
callees_needed?,
content_matches?(content : String, markers : Regex) : Bool
content_matches?,
http_header_name(name : String) : String | Nil
http_header_name,
line_number_for_index(content : String, char_index : Int32) : Int32
line_number_for_index,
logger : NoirLogger
logger,
parallel_analyze(files : Array(String), &block : String -> Nil)
parallel_analyze,
read_file_content(path : String) : String
read_file_content,
result : Array(Endpoint)
result,
tech : String
tech,
unique_params(params : Array(Param)) : Array(Param)
unique_params,
url : String
url,
web_root_path(path : String, markers : Array(String)) : String
web_root_path
Constructor methods inherited from class Analyzer
new(options : Hash(String, YAML::Any))
new
Macros inherited from class Analyzer
analyzer_for(tech)
analyzer_for
Instance methods inherited from module FileHelper
all_files : Array(String)
all_files,
get_files_by_basename(basename : String) : Array(String)
get_files_by_basename,
get_files_by_extension(extension : String) : Array(String)
get_files_by_extension,
get_files_by_extensions(extensions : Array(String)) : Array(String)
get_files_by_extensions,
get_files_by_prefix(prefix : String) : Array(String)
get_files_by_prefix,
get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String)
get_files_by_prefix_and_extension,
get_files_by_relative_path(relative_path : String, root : String = "") : Array(String)
get_files_by_relative_path,
get_public_dir_files(base_path : String, folder : String) : Array(String)
get_public_dir_files,
get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String)
get_public_files,
walked_path(expanded : String) : String
walked_path
Class Method Detail
Instance Method Detail
Instance-side view of the same declaration. The per-file rescues live on
this base class, which has no way to name the analyzer that is running
inside them, so a skipped file could not be attributed to a tech.
Deriving it from analyzer_for keeps the name written exactly once.