-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: using ldoc to generate document site (#37)
- Loading branch information
Showing
13 changed files
with
736 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| project = 'Radix-Router' | ||
| description = 'A lightweight high-performance and radix tree based router for Lua/LuaJIT.' | ||
| full_description = '' | ||
| examples = { './examples' } | ||
| file='./src/router.lua' | ||
| dir = 'docs' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
| <html> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
| <head> | ||
| <title>Reference</title> | ||
| <link rel="stylesheet" href="../ldoc.css" type="text/css" /> | ||
| </head> | ||
| <body> | ||
|
|
||
| <div id="container"> | ||
|
|
||
| <div id="product"> | ||
| <div id="product_logo"></div> | ||
| <div id="product_name"><big><b></b></big></div> | ||
| <div id="product_description"></div> | ||
| </div> <!-- id="product" --> | ||
|
|
||
|
|
||
| <div id="main"> | ||
|
|
||
|
|
||
| <!-- Menu --> | ||
|
|
||
| <div id="navigation"> | ||
| <br/> | ||
| <h1>Radix-Router</h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2>Examples</h2> | ||
| <ul class="nowrap"> | ||
| <li><strong>custom-matcher.lua</strong></li> | ||
| <li><a href="../examples/example.lua.html">example.lua</a></li> | ||
| </ul> | ||
| <h2>Modules</h2> | ||
| <ul class="nowrap"> | ||
| <li><a href="../index.html">radix-router</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
|
|
||
| <div id="content"> | ||
|
|
||
| <h2>custom-matcher.lua</h2> | ||
| <pre> | ||
| <span class="keyword">local</span> Router = <span class="global">require</span> <span class="string">"radix-router"</span> | ||
|
|
||
| <span class="keyword">local</span> ip_matcher = { | ||
| process = <span class="keyword">function</span>(route) | ||
| <span class="comment">-- builds a table for O(1) access | ||
| </span> <span class="keyword">if</span> route.ips <span class="keyword">then</span> | ||
| <span class="keyword">local</span> ips = {} | ||
| <span class="keyword">for</span> _, ip <span class="keyword">in</span> <span class="global">ipairs</span>(route.ips) <span class="keyword">do</span> | ||
| ips[ip] = <span class="keyword">true</span> | ||
| <span class="keyword">end</span> | ||
| route.ips = ips | ||
| <span class="keyword">end</span> | ||
| <span class="keyword">end</span>, | ||
| match = <span class="keyword">function</span>(route, ctx, matched) | ||
| <span class="keyword">if</span> route.ips <span class="keyword">then</span> | ||
| <span class="keyword">local</span> ip = ctx.ip | ||
| <span class="keyword">if</span> <span class="keyword">not</span> route.ips[ip] <span class="keyword">then</span> | ||
| <span class="keyword">return</span> <span class="keyword">false</span> | ||
| <span class="keyword">end</span> | ||
| <span class="keyword">if</span> matched <span class="keyword">then</span> | ||
| matched[<span class="string">"ip"</span>] = ip | ||
| <span class="keyword">end</span> | ||
| <span class="keyword">end</span> | ||
| <span class="keyword">return</span> <span class="keyword">true</span> | ||
| <span class="keyword">end</span> | ||
| } | ||
|
|
||
| <span class="keyword">local</span> opts = { | ||
| matchers = { ip_matcher }, <span class="comment">-- register custom ip_matcher | ||
| </span> matcher_names = { <span class="string">"method"</span> }, <span class="comment">-- host is disabled | ||
| </span>} | ||
|
|
||
| <span class="keyword">local</span> router = Router.<span class="function-name">new</span>({ | ||
| { | ||
| paths = { <span class="string">"/"</span> }, | ||
| methods = { <span class="string">"GET"</span>, <span class="string">"POST"</span> }, | ||
| ips = { <span class="string">"127.0.0.1"</span>, <span class="string">"127.0.0.2"</span> }, | ||
| handler = <span class="string">"1"</span>, | ||
| }, | ||
| { | ||
| paths = { <span class="string">"/"</span> }, | ||
| methods = { <span class="string">"GET"</span>, <span class="string">"POST"</span> }, | ||
| ips = { <span class="string">"192.168.1.1"</span>, <span class="string">"192.168.1.2"</span> }, | ||
| handler = <span class="string">"2"</span>, | ||
| } | ||
| }, opts) | ||
| <span class="global">assert</span>(<span class="string">"1"</span> == router:<span class="function-name">match</span>(<span class="string">"/"</span>, { method = <span class="string">"GET"</span>, ip = <span class="string">"127.0.0.2"</span> })) | ||
| <span class="keyword">local</span> matched = {} | ||
| <span class="global">assert</span>(<span class="string">"2"</span> == router:<span class="function-name">match</span>(<span class="string">"/"</span>, { method = <span class="string">"GET"</span>, ip = <span class="string">"192.168.1.2"</span> }, <span class="keyword">nil</span>, matched)) | ||
| <span class="global">print</span>(matched.method) <span class="comment">-- GET | ||
| </span><span class="global">print</span>(matched.ip) <span class="comment">-- 192.168.1.2</span></pre> | ||
|
|
||
|
|
||
| </div> <!-- id="content" --> | ||
| </div> <!-- id="main" --> | ||
| <div id="about"> | ||
| <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> | ||
| <i style="float:right;">Last updated 2024-02-05 16:00:23 </i> | ||
| </div> <!-- id="about" --> | ||
| </div> <!-- id="container" --> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
| <html> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
| <head> | ||
| <title>Reference</title> | ||
| <link rel="stylesheet" href="../ldoc.css" type="text/css" /> | ||
| </head> | ||
| <body> | ||
|
|
||
| <div id="container"> | ||
|
|
||
| <div id="product"> | ||
| <div id="product_logo"></div> | ||
| <div id="product_name"><big><b></b></big></div> | ||
| <div id="product_description"></div> | ||
| </div> <!-- id="product" --> | ||
|
|
||
|
|
||
| <div id="main"> | ||
|
|
||
|
|
||
| <!-- Menu --> | ||
|
|
||
| <div id="navigation"> | ||
| <br/> | ||
| <h1>Radix-Router</h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2>Examples</h2> | ||
| <ul class="nowrap"> | ||
| <li><a href="../examples/custom-matcher.lua.html">custom-matcher.lua</a></li> | ||
| <li><strong>example.lua</strong></li> | ||
| </ul> | ||
| <h2>Modules</h2> | ||
| <ul class="nowrap"> | ||
| <li><a href="../index.html">radix-router</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
|
|
||
| <div id="content"> | ||
|
|
||
| <h2>example.lua</h2> | ||
| <pre> | ||
| <span class="keyword">local</span> Router = <span class="global">require</span> <span class="string">"radix-router"</span> | ||
| <span class="keyword">local</span> router, err = Router.<span class="function-name">new</span>({ | ||
| { | ||
| paths = { <span class="string">"/foo"</span>, <span class="string">"/foo/bar"</span>, <span class="string">"/html/index.html"</span> }, | ||
| handler = <span class="string">"1"</span> <span class="comment">-- handler can be any non-nil value. (e.g. boolean, table, function) | ||
| </span> }, | ||
| { | ||
| <span class="comment">-- variable path | ||
| </span> paths = { <span class="string">"/users/{id}/profile-{year}.{format}"</span> }, | ||
| handler = <span class="string">"2"</span> | ||
| }, | ||
| { | ||
| <span class="comment">-- prefix path | ||
| </span> paths = { <span class="string">"/api/authn/{*path}"</span> }, | ||
| handler = <span class="string">"3"</span> | ||
| }, | ||
| { | ||
| <span class="comment">-- methods | ||
| </span> paths = { <span class="string">"/users/{id}"</span> }, | ||
| methods = { <span class="string">"POST"</span> }, | ||
| handler = <span class="string">"4"</span> | ||
| } | ||
| }) | ||
| <span class="keyword">if</span> <span class="keyword">not</span> router <span class="keyword">then</span> | ||
| <span class="global">error</span>(<span class="string">"failed to create router: "</span> .. err) | ||
| <span class="keyword">end</span> | ||
|
|
||
| <span class="global">assert</span>(<span class="string">"1"</span> == router:<span class="function-name">match</span>(<span class="string">"/html/index.html"</span>)) | ||
| <span class="global">assert</span>(<span class="string">"2"</span> == router:<span class="function-name">match</span>(<span class="string">"/users/100/profile-2023.pdf"</span>)) | ||
| <span class="global">assert</span>(<span class="string">"3"</span> == router:<span class="function-name">match</span>(<span class="string">"/api/authn/token/genreate"</span>)) | ||
| <span class="global">assert</span>(<span class="string">"4"</span> == router:<span class="function-name">match</span>(<span class="string">"/users/100"</span>, { method = <span class="string">"POST"</span> })) | ||
|
|
||
| <span class="comment">-- parameter binding | ||
| </span><span class="keyword">local</span> params = {} | ||
| router:<span class="function-name">match</span>(<span class="string">"/users/100/profile-2023.pdf"</span>, <span class="keyword">nil</span>, params) | ||
| <span class="global">assert</span>(params.year == <span class="string">"2023"</span>) | ||
| <span class="global">assert</span>(params.format == <span class="string">"pdf"</span>)</pre> | ||
|
|
||
|
|
||
| </div> <!-- id="content" --> | ||
| </div> <!-- id="main" --> | ||
| <div id="about"> | ||
| <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> | ||
| <i style="float:right;">Last updated 2024-02-05 16:00:23 </i> | ||
| </div> <!-- id="about" --> | ||
| </div> <!-- id="container" --> | ||
| </body> | ||
| </html> |
Oops, something went wrong.