chore(*): release 1.1.0

### Summary #### Added - `url:decode` method - `ada.decode` function - `search:decode` method - `search:decode_all` method - `ada.search_encode` function - `ada.search.encode` function - `ada.search_decode` function - `ada.search.decode` function - `ada.search_decode_all` function - `ada.search.decode_all` function #### Changed - The `set_port` to not allow negative or positive inf or NaN #### Updated - The CI is now executed against Ada 2.9.1 Signed-off-by: Aapo Talvensaari <[email protected]>
bungle · Sep 3, 2024 · d629894 · d629894
1 parent 343dce0
commit d629894
Show file tree

Hide file tree

Showing 8 changed files with 614 additions and 11 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,11 +2,26 @@
 
 All notable changes to `lua-resty-ada` will be documented in this file.
 
+## [1.1.0] - 2024-09-03
+### Added
+- `url:decode` method
+- `ada.decode` function
+- `ada.search_encode` function
+- `ada.search.encode` function
+- `search:decode` method
+- `search:decode_all` method
+- `ada.search_decode` function
+- `ada.search.decode` function
+- `ada.search_decode_all` function
+- `ada.search.decode_all` function
+### Changed
+- The `set_port` to not allow negative or positive inf or NaN
+### Updated
+- The CI is now executed against Ada 2.9.2
 
 ## [1.0.1] - 2024-08-20
 ### Removed
 - The unnecessary `:is_valid` was removed (the URL is validated when parsed)
-
 ### Added
 - Explicitly free Ada URL object on invalid URLs
 

diff --git a/docs/classes/search.html b/docs/classes/search.html
@@ -34,6 +34,7 @@ <h1>resty.ada</h1>
 
 <h2>Contents</h2>
 <ul>
+<li><a href="#Decode_Methods">Decode Methods </a></li>
 <li><a href="#Has_Methods">Has Methods </a></li>
 <li><a href="#Get_Methods">Get Methods </a></li>
 <li><a href="#Set_Methods">Set Methods </a></li>
@@ -65,6 +66,17 @@ <h1>Class <code>search</code></h1>
 <p> See: <a href="https://url.spec.whatwg.org/#interface-urlsearchparams">https://url.spec.whatwg.org/#interface-urlsearchparams</a></p>
 
 
+<h2><a href="#Decode_Methods">Decode Methods </a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#search:decode">search:decode ()</a></td>
+	<td class="summary">Decodes search parameters and returns a Lua table of them.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#search:decode">search:decode ()</a></td>
+	<td class="summary">Decodes all search parameters and returns a Lua table of them.</td>
+	</tr>
+</table>
 <h2><a href="#Has_Methods">Has Methods </a></h2>
 <table class="function_list">
 	<tr>
@@ -182,6 +194,75 @@ <h2><a href="#Iterate_Methods">Iterate Methods </a></h2>
 <br/>
 
 
+    <h2 class="section-header "><a name="Decode_Methods"></a>Decode Methods </h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "search:decode"></a>
+    <strong>search:decode ()</strong>
+    </dt>
+    <dd>
+    Decodes search parameters and returns a Lua table of them.</p>
+
+<p> If same parameter appears multiple times, only the value of the
+ first is returned.</p>
+
+<p> An example return value:
+    {
+      key1 = &ldquo;value&rdquo;,
+      key2 = &ldquo;value2&rdquo;,
+    }
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        a table of all search parameters (a string:string map).
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> search = <span class="global">require</span>(<span class="string">"resty.ada.search"</span>).<span class="function-name">parse</span>(<span class="string">"a=b&amp;c=d&amp;e=f&amp;a=g"</span>)
+<span class="keyword">local</span> result = search:<span class="function-name">decode</span>()</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "search:decode"></a>
+    <strong>search:decode ()</strong>
+    </dt>
+    <dd>
+    Decodes all search parameters and returns a Lua table of them.</p>
+
+<p> An example return value:
+    {
+      key1 = { &ldquo;first&rdquo;, &ldquo;second&rdquo;, },
+      key2 = { &ldquo;value&rdquo; },
+    }
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        a table of all search parameters (a string:table [array] map).
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> search = <span class="global">require</span>(<span class="string">"resty.ada.search"</span>).<span class="function-name">parse</span>(<span class="string">"a=b&amp;a=c&amp;d=e"</span>)
+<span class="keyword">local</span> result = search:<span class="function-name">decode_all</span>()</pre>
+    </ul>
+
+</dd>
+</dl>
     <h2 class="section-header "><a name="Has_Methods"></a>Has Methods </h2>
 
     <dl class="function">
@@ -922,7 +1003,7 @@ <h3>Usage:</h3>
 </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-08-20 21:17:51 </i>
+<i style="float:right;">Last updated 2024-09-03 15:49:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/classes/url.html b/docs/classes/url.html
@@ -34,6 +34,7 @@ <h1>resty.ada</h1>
 
 <h2>Contents</h2>
 <ul>
+<li><a href="#Decode_Methods">Decode Methods </a></li>
 <li><a href="#Has_Methods">Has Methods </a></li>
 <li><a href="#Get_Methods">Get Methods </a></li>
 <li><a href="#Set_Methods">Set Methods </a></li>
@@ -66,6 +67,13 @@ <h1>Class <code>url</code></h1>
 <p> See: <a href="https://url.spec.whatwg.org/#url-representation">https://url.spec.whatwg.org/#url-representation</a></p>
 
 
+<h2><a href="#Decode_Methods">Decode Methods </a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#url:decode">url:decode ()</a></td>
+	<td class="summary">Decodes URL and return its components in Lua table.</td>
+	</tr>
+</table>
 <h2><a href="#Has_Methods">Has Methods </a></h2>
 <table class="function_list">
 	<tr>
@@ -230,6 +238,14 @@ <h2><a href="#Search_Methods">Search Methods </a></h2>
 	<td class="summary">Parses search from URL and returns an instance of Ada URL Search.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#url:search_decode">url:search_decode ()</a></td>
+	<td class="summary">Decodes search parameters from URL and returns a Lua table of them.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#url:search_decode_all">url:search_decode_all (url)</a></td>
+	<td class="summary">Decodes all search parameters from URL and returns a Lua table of them.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#url:search_has">url:search_has (key)</a></td>
 	<td class="summary">Checks whether the url has a search with a key.</td>
 	</tr>
@@ -327,6 +343,55 @@ <h2><a href="#Properties">Properties </a></h2>
 <br/>
 
 
+    <h2 class="section-header "><a name="Decode_Methods"></a>Decode Methods </h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "url:decode"></a>
+    <strong>url:decode ()</strong>
+    </dt>
+    <dd>
+    Decodes URL and return its components in Lua table.</p>
+
+<p> Given a following URL:
+    https://user:[email protected]:1234/foo/bar?baz#quux</p>
+
+<p> This function will return following table:
+    {
+      scheme_type = 2,
+      protocol = &ldquo;https:&rdquo;,
+      username = &ldquo;user&rdquo;,
+      password = &ldquo;pass&rdquo;,
+      origin = &ldquo;https://example.com:1234&rdquo;,
+      host_type = 0,
+      host = &ldquo;example.com:1234&rdquo;,
+      hostname = &ldquo;example.com&rdquo;,
+      port = 1234,
+      pathname = &ldquo;/foo/bar&rdquo;,
+      search = &ldquo;?baz&rdquo;,
+      hash = &ldquo;#quux&rdquo;,
+    }
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        table of URL components
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> url = <span class="global">require</span>(<span class="string">"resty.ada"</span>).<span class="function-name">parse</span>(
+  <span class="string">"https://user:pass@host:1234/path?search#hash"</span>)
+<span class="keyword">local</span> res = url:<span class="function-name">decode</span>()</pre>
+    </ul>
+
+</dd>
+</dl>
     <h2 class="section-header "><a name="Has_Methods"></a>Has Methods </h2>
 
     <dl class="function">
@@ -1235,6 +1300,8 @@ <h3>Usage:</h3>
     <dd>
     Sets port to the URL.</p>
 
+<p> Note: inf, -inf and NaN are considered invalid and they raise an error.</p>
+
 <p> See: <a href="https://url.spec.whatwg.org/#dom-url-port">https://url.spec.whatwg.org/#dom-url-port</a>
 
 
@@ -1253,7 +1320,7 @@ <h3>Returns:</h3>
         self (except on errors <code>nil</code>)</li>
         <li>
            <span class="types"><span class="type">nil</span> or <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-        error message</li>
+        error message (e.g. when port is out of acceptable range)</li>
     </ol>
 
     <h3>Raises:</h3>
@@ -1491,6 +1558,78 @@ <h3>Usage:</h3>
 <span class="keyword">local</span> search = url:<span class="function-name">search_parse</span>()</pre>
     </ul>
 
+</dd>
+    <dt>
+    <a name = "url:search_decode"></a>
+    <strong>url:search_decode ()</strong>
+    </dt>
+    <dd>
+    Decodes search parameters from URL and returns a Lua table of them.</p>
+
+<p> If same parameter appears multiple times, only the value of the
+ first is returned.</p>
+
+<p> An example return value:
+    {
+      key1 = &ldquo;value&rdquo;,
+      key2 = &ldquo;value2&rdquo;,
+    }
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        a table of all search parameters (a string:string map).
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> url = <span class="global">require</span>(<span class="string">"resty.ada"</span>).<span class="function-name">parse</span>(<span class="string">"http://host/?a=b&amp;c=d&amp;e=f&amp;a=g"</span>)
+<span class="keyword">local</span> result = url:<span class="function-name">search_decode</span>()</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "url:search_decode_all"></a>
+    <strong>url:search_decode_all (url)</strong>
+    </dt>
+    <dd>
+    Decodes all search parameters from URL and returns a Lua table of them.</p>
+
+<p> An example return value:
+    {
+      key1 = { &ldquo;first&rdquo;, &ldquo;second&rdquo;, },
+      key2 = { &ldquo;value&rdquo; },
+    }
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">url</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         url (with search) to parse
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+        a table of all search parameters (a string:table [array] map).
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> url = <span class="global">require</span>(<span class="string">"resty.ada"</span>).<span class="function-name">parse</span>(<span class="string">"http://host/?a=b&amp;a=c&amp;d=e"</span>)
+<span class="keyword">local</span> result = url:<span class="function-name">search_decode_all</span>()</pre>
+    </ul>
+
 </dd>
     <dt>
     <a name = "url:search_has"></a>
@@ -2124,7 +2263,7 @@ <h2 class="section-header "><a name="Properties"></a>Properties </h2>
 </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-08-20 21:17:51 </i>
+<i style="float:right;">Last updated 2024-09-03 15:49:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -77,7 +77,7 @@ <h2>Classes</h2>
 </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-08-20 21:17:51 </i>
+<i style="float:right;">Last updated 2024-09-03 15:49:45 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>