publish ruby apidocs 1.27.1

rosette-api · Jan 12, 2024 · 54599e7 · 54599e7
1 parent 920bb09
commit 54599e7
Show file tree

Hide file tree

Showing 25 changed files with 707 additions and 1,750 deletions.
diff --git a/AddressParameter.html b/AddressParameter.html
diff --git a/AddressSimilarityParameters.html b/AddressSimilarityParameters.html
@@ -21,8 +21,6 @@
 <link href="./css/rdoc.css" rel="stylesheet">
 
 
-
-
 <body id="top" role="document" class="class">
 <nav role="navigation">
   <div id="project-navigation">
@@ -43,7 +41,7 @@ <h2>
     <div id="search-field-wrapper">
       <input id="search-field" role="combobox" aria-label="Search"
              aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
              title="Type to search, Up and Down to navigate, Enter to load">
     </div>
 
@@ -59,30 +57,25 @@ <h2>
 
   <div id="class-metadata">
 
-    <div id="parent-class-section" class="nav-section">
+
+<div id="parent-class-section" class="nav-section">
   <h3>Parent</h3>
 
-
   <p class="link">Object
-
 </div>
 
 
 
-    <!-- Method Quickref -->
+
+<!-- Method Quickref -->
 <div id="method-list-section" class="nav-section">
   <h3>Methods</h3>
 
   <ul class="link-list" role="directory">
-
     <li ><a href="#method-i-initialize">#initialize</a>
-
     <li ><a href="#method-i-load_params">#load_params</a>
-
     <li ><a href="#method-i-to_hash">#to_hash</a>
-
     <li ><a href="#method-i-validate_params">#validate_params</a>
-
   </ul>
 </div>
 
@@ -100,152 +93,111 @@ <h1 id="class-AddressSimilarityParameters" class="class">
 
   </section>
 
-
   <section id="5Buntitled-5D" class="documentation-section">
-
 
-
 
-
 
-
     <section class="attribute-method-details" class="method-section">
       <header>
         <h3>Attributes</h3>
       </header>
 
-
       <div id="attribute-i-address1" class="method-detail">
         <div class="method-heading attribute-method-heading">
           <span class="method-name">address1</span><span
             class="attribute-access-type">[RW]</span>
         </div>
 
         <div class="method-description">
-
         <p>Address to be compared to address2</p>
-
         </div>
       </div>
-
       <div id="attribute-i-address2" class="method-detail">
         <div class="method-heading attribute-method-heading">
           <span class="method-name">address2</span><span
             class="attribute-access-type">[RW]</span>
         </div>
 
         <div class="method-description">
-
         <p>Address to be compared to address1</p>
-
         </div>
       </div>
-
     </section>
-
 
-    
+
      <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
        <header>
          <h3>Public Instance Methods</h3>
        </header>
 
-
       <div id="method-i-load_params" class="method-detail ">
-
-        <div class="method-heading">
-          <span class="method-name">load_params</span><span
-            class="method-args">()</span>
-
-          <span class="method-click-advice">click to toggle source</span>
-
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">load_params</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
         </div>
-
 
         <div class="method-description">
-
           <p>Converts this class to Hash with its keys in lower CamelCase.</p>
 
 <p>Returns the new Hash.</p>
-
-
 
-
           <div class="method-source-code" id="load_params-source">
             <pre><span class="ruby-comment"># File address_similarity_parameters.rb, line 32</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_params</span>
   <span class="ruby-identifier">validate_params</span>
   <span class="ruby-identifier">to_hash</span>
-    .<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> }
-    .<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;_&#39;</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:capitalize</span>).<span class="ruby-identifier">join</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp">/\D/</span>, <span class="ruby-operator">&amp;</span><span class="ruby-value">:downcase</span>), <span class="ruby-identifier">value</span>] }
-    .<span class="ruby-identifier">to_h</span>
+    .<span class="ruby-identifier">compact</span>
+    .<span class="ruby-identifier">transform_keys</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39;_&#39;</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:capitalize</span>).<span class="ruby-identifier">join</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp">/\D/</span>, <span class="ruby-operator">&amp;</span><span class="ruby-value">:downcase</span>) }
 <span class="ruby-keyword">end</span></pre>
           </div>
-
         </div>
 
-
 
-
       </div>
 
-
       <div id="method-i-to_hash" class="method-detail ">
-
-        <div class="method-heading">
-          <span class="method-name">to_hash</span><span
-            class="method-args">()</span>
-
-          <span class="method-click-advice">click to toggle source</span>
-
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">to_hash</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
         </div>
-
 
         <div class="method-description">
-
           <p>Converts this class to Hash.</p>
 
 <p>Returns the new Hash.</p>
-
-
 
-
           <div class="method-source-code" id="to_hash-source">
-            <pre><span class="ruby-comment"># File address_similarity_parameters.rb, line 43</span>
+            <pre><span class="ruby-comment"># File address_similarity_parameters.rb, line 42</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_hash</span>
   {
     <span class="ruby-value">address1:</span> <span class="ruby-ivar">@address1</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">AddressParameter</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@address1</span>.<span class="ruby-identifier">load_param</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@address1</span>,
     <span class="ruby-value">address2:</span> <span class="ruby-ivar">@address2</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">AddressParameter</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@address2</span>.<span class="ruby-identifier">load_param</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@address2</span>
   }
 <span class="ruby-keyword">end</span></pre>
           </div>
-
         </div>
 
-
 
-
       </div>
 
-
       <div id="method-i-validate_params" class="method-detail ">
-
-        <div class="method-heading">
-          <span class="method-name">validate_params</span><span
-            class="method-args">()</span>
-
-          <span class="method-click-advice">click to toggle source</span>
-
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">validate_params</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
         </div>
-
 
         <div class="method-description">
-
           <p>Validates the parameters by checking if address1 and address2 are instances of AddressParameters or Strings.</p>
-
-
 
-
           <div class="method-source-code" id="validate_params-source">
             <pre><span class="ruby-comment"># File address_similarity_parameters.rb, line 21</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate_params</span>
@@ -256,67 +208,51 @@ <h3>Public Instance Methods</h3>
   <span class="ruby-identifier">raise</span> <span class="ruby-constant">BadRequestError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">a2_msg</span>) <span class="ruby-keyword">if</span> [<span class="ruby-constant">String</span>, <span class="ruby-constant">AddressParameter</span>].<span class="ruby-identifier">none?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">clazz</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@address2</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-identifier">clazz</span> }
 <span class="ruby-keyword">end</span></pre>
           </div>
-
         </div>
 
-
 
-
       </div>
 
-
     </section>
-  
+
      <section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
        <header>
          <h3>Protected Instance Methods</h3>
        </header>
 
-
       <div id="method-i-initialize" class="method-detail ">
-
-        <div class="method-heading">
-          <span class="method-name">initialize</span><span
-            class="method-args">(address1, address2)</span>
-
-          <span class="method-click-advice">click to toggle source</span>
-
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">initialize</span><span
+              class="method-args">(address1, address2)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
         </div>
-
 
         <div class="method-description">
 
-
-
-
 
-
           <div class="method-source-code" id="initialize-source">
             <pre><span class="ruby-comment"># File address_similarity_parameters.rb, line 14</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">address1</span>, <span class="ruby-identifier">address2</span>) <span class="ruby-comment">#:notnew:</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">address1</span>, <span class="ruby-identifier">address2</span>) <span class="ruby-comment"># :notnew:</span>
   <span class="ruby-ivar">@address1</span> = <span class="ruby-identifier">address1</span>
   <span class="ruby-ivar">@address2</span> = <span class="ruby-identifier">address2</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
-
         </div>
 
-
 
-
       </div>
 
-
     </section>
-
-  </section>
 
+  </section>
 </main>
 
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>