class Analyzer::Lua::Lor

• Analyzer::Lua::Lor
• Analyzer
• Reference
• Object

Overview

lor (https://github.com/sumory/lor) is an Express-style web framework for Lua on top of OpenResty. Routes are declared on the application or on a router instance:

local app = lor() app:get("/", handler) -- direct app route

local userRouter = lor:Router() userRouter:get("/find/:id", handler) -- router route app:use("/user", userRouter()) -- mount router under a prefix

The mount prefix is what makes lor routes hard to read in isolation: a route file declares userRouter:get("/find/:id", …) and a different file (router.lua) mounts it with app:use("/user", userRouter()), so the real URL is /user/find/:id. userRouter in the mounting file is bound to require("app.routes.user"), so we resolve that require to the route file and prefix every route the file declares. Prefixes compose transitively for nested mounts.

Path params use Express :name syntax, which already matches noir's URL convention. Verbs come from lor's supported set (get/post/put/delete/patch/ head/options/trace and the catch-all all).

Defined in:

Constant Summary

ALL_VERBS = ["GET", "POST", "PUT", "DELETE", "PATCH"] of ::String

app:all(...) matches every method; surface the common five (the same fallback set the Lapis app:match analyzer uses).

APP_VAR_RE = /(?:^|[^A-Za-z0-9_.])(?:local\s+)?([A-Za-z_]\w*)\s*=\s*lor\s*\(\s*\)/

local app = lor() — the application object.

REQUIRE_RE = /(?:^|[^A-Za-z0-9_.])(?:local\s+)?([A-Za-z_]\w*)\s*=\s*require\s*\(?\s*(['"])([^'"]+)\2/

local userRouter = require("app.routes.user") — module binding.

ROUTER_VAR_RE = /(?:^|[^A-Za-z0-9_.])(?:local\s+)?([A-Za-z_]\w*)\s*=\s*lor\s*[:.]\s*[Rr]outer\s*\(/

local userRouter = lor:Router() — a router instance.

SUPPORTED_VERBS = ["get", "post", "put", "delete", "patch", "head", "options", "trace"] of ::String

USE_MOUNT_RE = /\b([A-Za-z_]\w*)\s*[:.]\s*use\s*\(\s*(['"])([^'"]*)\2\s*,\s*([A-Za-z_]\w*)\s*\(/

app:use("/prefix", userRouter()) — mount a sub-router under a prefix. The second arg must be a bare-variable call (name(...)); a function literal or table second arg is middleware, not a router mount.

USE_RECEIVER_RE = /\b([A-Za-z_]\w*)\s*[:.]\s*use\s*\(/

Any <var>:use( — used purely to flag a variable as an app/router receiver (lor's App/Router both expose :use; redis/db/cache never do).

Instance Method Summary

• #analyze

Instance Method Detail