resty-app

Author: xiangnanscu

README.md

@@ -7,20 +7,20 @@ Elegant, performant and productive router for Openresty.
 It's recommended to use npm to scaffold a lua-resty-router project.
 
 ```bash
-npm create lua-resty-router@latest
+npm create resty-app@latest
 ```
+Then follow the instructions to complete the project.
 
 # Api
 
-## create
+## new
 
 ```lua
----@alias Route {[1]:string, [2]:function|string, [3]?:string|string[]}
-(method) Router:create(routes: Route[])
+(method) Router:new()
   -> Router
 ```
 
-init a router with routes
+create a router.
 
 ## insert
 
@@ -29,7 +29,17 @@ init a router with routes
   -> Router
 ```
 
-insert a route
+insert a route.
+
+## extend
+
+```lua
+---@alias Route {[1]:string, [2]:function|string, [3]?:string|string[]}
+(method) Router:extend(routes: Route[])
+  -> Router
+```
+
+insert routes to a router.
 
 ## match
 

api/account/users.lua

@@ -0,0 +1,8 @@
+local function get_users(ctx)
+  return {
+    { id = 1, name = "Alice" },
+    { id = 2, name = "Bob" },
+  }
+end
+
+return get_users

api/array_group.lua

@@ -0,0 +1,25 @@
+return {
+  -- 数组形式的多路由定义
+  { "bloggers", function()
+    return {
+      { id = 1, name = "Alice" },
+      { id = 2, name = "Bob" }
+    }
+  end },
+
+  { "bloggers/:name", function(ctx)
+    return {
+      name = ctx.params.name
+    }
+  end },
+
+  { "bloggers/#id/posts", function(ctx)
+    return {
+      user_id = ctx.params.id,
+      posts = {
+        { id = 1, title = "Post 1" },
+        { id = 2, title = "Post 2" }
+      }
+    }
+  end }
+}

api/hash_group.lua

@@ -0,0 +1,27 @@
+return {
+  -- 映射形式的路由定义
+  list = function()
+    return {
+      { id = 1, type = "item1" },
+      { id = 2, type = "item2" }
+    }
+  end,
+
+  ["detail/#id"] = function(ctx)
+    return {
+      id = ctx.params.id,
+      type = "detail",
+      description = "Item details"
+    }
+  end,
+
+  ["search/:keyword"] = function(ctx)
+    return {
+      keyword = ctx.params.keyword,
+      results = {
+        { id = 1, match = true },
+        { id = 2, match = false }
+      }
+    }
+  end
+}

app.lua

@@ -132,4 +132,7 @@ router:get("/response-body", function(ctx)
   ctx.response.body = "response body"
 end)
 
+router:fs("./api")
+
+assert(io.open("logs/router.log", "w")):write(require("resty.repr")(router)):close()
 return router

conf/nginx.conf

@@ -1,6 +1,6 @@
  worker_processes        auto;
  pid                     logs/nginx.pid;
-
+ user                    root;
  error_log               logs/error.log;
 events {
   worker_connections     1024;

lib/resty/router.lua

@@ -1,29 +1,35 @@
-local json           = require "cjson.safe"
-local bit            = bit
-local gmatch         = string.gmatch
-local ipairs         = ipairs
-local tonumber       = tonumber
-local byte           = string.byte
-local ngx_re_match   = ngx.re.match
-local coroutine      = coroutine
-local resume         = coroutine.resume
-local trace_back     = debug.traceback
-local ngx            = ngx
-local ngx_header     = ngx.header
-local ngx_print      = ngx.print
-local ngx_var        = ngx.var
-local string_format  = string.format
-local xpcall         = xpcall
-local spawn          = ngx.thread.spawn
-local ngx_req        = ngx.req
-local decode         = json.decode
-local encode         = json.encode
-local get_post_args  = ngx.req.get_post_args
-local read_body      = ngx.req.read_body
-local get_body_data  = ngx.req.get_body_data
-local assert         = assert
-local rawget         = rawget
-local setmetatable   = setmetatable
+local json          = require "cjson.safe"
+local bit           = bit
+local gmatch        = string.gmatch
+local ipairs        = ipairs
+local tonumber      = tonumber
+local byte          = string.byte
+local ngx_re_match  = ngx.re.match
+local coroutine     = coroutine
+local resume        = coroutine.resume
+local trace_back    = debug.traceback
+local ngx           = ngx
+local ngx_header    = ngx.header
+local ngx_print     = ngx.print
+local ngx_var       = ngx.var
+local string_format = string.format
+local xpcall        = xpcall
+local spawn         = ngx.thread.spawn
+local ngx_req       = ngx.req
+local decode        = json.decode
+local encode        = json.encode
+local get_post_args = ngx.req.get_post_args
+local read_body     = ngx.req.read_body
+local get_body_data = ngx.req.get_body_data
+local assert        = assert
+local rawget        = rawget
+local setmetatable  = setmetatable
+local lfs
+do
+  local o, l = pcall(require, "syscall.lfs")
+  if not o then o, l = pcall(require, "lfs") end
+  if o then lfs = l end
+end
 
 local method_bitmask = {
   GET = 1,       -- 2^0
@@ -201,24 +207,23 @@ function Router:is_route(view)
   return self:is_handler(view[2])
 end
 
----init a router with routes
+---insert routes to a router
 ---@param routes Route[]
 ---@return Router
-function Router:create(routes)
-  local tree = Router:new()
+function Router:extend(routes)
   for _, route in ipairs(routes) do
     assert(self:is_route(route))
     local path = route[1]
     if type(path) == 'string' then
-      tree:_insert(path, route[2], route[3])
+      self:_insert(path, route[2], route[3])
     else
       for _, p in ipairs(path) do
-        tree:_insert(p, route[2], route[3])
+        self:_insert(p, route[2], route[3])
       end
     end
   end
-  _set_find_method(tree)
-  return tree
+  _set_find_method(self)
+  return self
 end
 
 ---@param path string|table
@@ -574,4 +579,88 @@ function Router:run()
   return self:dispatch(ngx_var.document_uri, ngx_var.request_method)
 end
 
+local function callable(handler)
+  return type(handler) == "function" or
+      (type(handler) == "table" and getmetatable(handler) and getmetatable(handler).__call)
+end
+
+local function is_handler(handler)
+  return type(handler) == "string" or callable(handler)
+end
+
+---@param dir string Directory path to scan
+---@param base_path? string Base path (used for recursion)
+---@return table[] Route configuration array
+function Router:collect_routes(dir, base_path)
+  local routes = {}
+  base_path = base_path or ""
+
+  -- Recursively scan directory
+  for file in lfs.dir(dir) do
+    if file ~= "." and file ~= ".." then
+      local path = dir .. "/" .. file
+      local attr = lfs.attributes(path)
+
+      if attr.mode == "directory" then
+        -- Process subdirectories recursively
+        local sub_routes = self:collect_routes(path, base_path .. "/" .. file)
+        for _, route in ipairs(sub_routes) do
+          routes[#routes + 1] = route
+        end
+      elseif attr.mode == "file" and file:match("%.lua$") then
+        -- Process .lua files
+        local module_path = path:gsub("%.lua$", ""):gsub("/", ".")
+        local ok, route = pcall(require, module_path)
+        if ok then
+          -- Get relative path (remove .lua extension)
+          local relative_path = base_path .. "/" .. file:gsub("%.lua$", "")
+
+          -- Handle different types of route definitions
+          if is_handler(route) then
+            -- Type 1: Function or callable table
+            routes[#routes + 1] = { relative_path, route }
+          elseif type(route) == "table" then
+            if #route > 0 then
+              if type(route[1]) == "string" and is_handler(route[2]) then
+                -- Type 2: Single route definition
+                local path = route[1]
+                if path:sub(1, 1) == "/" then
+                  routes[#routes + 1] = { path, route[2], route[3] }
+                else
+                  routes[#routes + 1] = { relative_path .. "/" .. path, route[2], route[3] }
+                end
+              else
+                -- Type 3: Array of multiple route definitions
+                for _, view in ipairs(route) do
+                  if type(view[1]) == "string" and is_handler(view[2]) then
+                    if view[1]:sub(1, 1) == "/" then
+                      routes[#routes + 1] = { view[1], view[2], view[3] }
+                    else
+                      routes[#routes + 1] = { relative_path .. "/" .. view[1], view[2], view[3] }
+                    end
+                  end
+                end
+              end
+            else
+              -- Type 4: Map-style route definitions
+              for key, handler in pairs(route) do
+                if type(key) == "string" and key:sub(1, 1) ~= "/" and is_handler(handler) then
+                  routes[#routes + 1] = { relative_path .. "/" .. key, handler }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  return routes
+end
+
+function Router:fs(dir)
+  local routes = self:collect_routes(dir)
+  self:extend(routes)
+end
+
 return Router

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "create-lua-resty-router-tmp",
-  "version": "0.4.0",
+  "name": "create-resty-app",
+  "version": "0.5.0",
   "description": "high performance router",
   "type": "module",
   "bin": {
-    "create-lua-resty-router-tmp": "outfile.cjs"
+    "create-resty-app": "outfile.cjs"
   },
   "files": [
     "outfile.cjs",
@@ -29,11 +29,11 @@
     "format": "prettier --write .",
     "build": "zx ./scripts/build.mjs",
     "snapshot": "zx ./scripts/snapshot.mjs",
-    "pretest2": "run-s build snapshot",
+    "pretest": "rm -f logs/error.log; lsof -t -i:8080 | xargs kill -9 || true",
     "prepublishOnly": "npm run build",
     "prepublishOnly2": "zx ./scripts/prepublish.mjs",
     "nginx": "nginx -p . -c conf/nginx.conf",
-    "test": "mv logs/error.log; kill -9 $(lsof -t -i:8080);yarn nginx; ./test.py ; yarn nginx -s stop"
+    "test": "yarn nginx; ./test.py ; yarn nginx -s stop"
   },
   "author": "",
   "license": "ISC",
@@ -56,4 +56,4 @@
     "prompts": "^2.4.2",
     "zx": "^7.2.3"
   }
-}
+}