oorb 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d55ddf9e9afd0340d680a19dcef13a61cf7db58
-  data.tar.gz: 022bfa4d33c7cdbd16619e6e77da6c48710656b2
+  metadata.gz: a6aefb3c8f8c97b1fc4eeb19ef84fca064d809fb
+  data.tar.gz: 50589bef6b59f747a2f75b06bc290097185c4f27
 SHA512:
-  metadata.gz: cdabd0136bf3e5a625e43405cdacbe6930b35a1375ca53f98e12e4e10bbb5a43d872e1983d2fdb2eaf79fa76f0d1cff676e4d1aa3c9aee31653c4674576eeede
-  data.tar.gz: 42214d7494c799654b025fb5f7b15d5e4eec74a9f8d2095f3af55cd852f71d21ae5b7382d3adcd44dc93cb0361e14c4748d401b14741af2c358680c61c1ed0f0
+  metadata.gz: 367114c7b883d27860355daa97b8f15df9583c68959bd56848cc8902671fe6cad5dc43a362888e01bea19b9fbc653dc488562a727f9380bb6c265d08fb088fe4
+  data.tar.gz: 22a1823de6b17fb8a38280c7b6cc626a13e557080e4a9e0832b8ded09680cbce51d06460a51fdf159fd6b32323b864d8853332d17d8f0ce1af2df7583b0642e5

data/.yardopts

@@ -1 +1 @@
-yardoc -r --no-private lib/**/*.rb - LICENSE.txt CODE_OF_CONDUCT.md --exclude lib/oorb/version.rb
+yardoc --no-private lib/**/*.rb - LICENSE.txt CODE_OF_CONDUCT.md --exclude lib/oorb/version.rb

data/doc/OORB.html

@@ -168,7 +168,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#build_collection-instance_method" title="#build_collection (instance method)">- (Object) <strong>build_collection</strong>(character) </a>
+      <a href="#build_collection-instance_method" title="#build_collection (instance method)">- (String) <strong>build_collection</strong>(character) </a>
     
 
     
@@ -192,7 +192,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#build_regex-instance_method" title="#build_regex (instance method)">- (Object) <strong>build_regex</strong>(input) </a>
+      <a href="#build_regex-instance_method" title="#build_regex (instance method)">- (String) <strong>build_regex</strong>(input) </a>
     
 
     
@@ -216,7 +216,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#combine_whitespace-instance_method" title="#combine_whitespace (instance method)">- (Object) <strong>combine_whitespace</strong>(string) </a>
+      <a href="#combine_whitespace-instance_method" title="#combine_whitespace (instance method)">- (String) <strong>combine_whitespace</strong>(string) </a>
     
 
     
@@ -241,7 +241,7 @@ whitespace character.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#escape-instance_method" title="#escape (instance method)">- (Object) <strong>escape</strong>(character) </a>
+      <a href="#escape-instance_method" title="#escape (instance method)">- (String) <strong>escape</strong>(character) </a>
     
 
     
@@ -298,7 +298,7 @@ whitespace character.</p>
       <div class="method_details first">
   <h3 class="signature first" id="build_collection-instance_method">
   
-    - (<tt>Object</tt>) <strong>build_collection</strong>(character) 
+    - (<tt>String</tt>) <strong>build_collection</strong>(character) 
   
 
   
@@ -307,14 +307,69 @@ whitespace character.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Builds a group match from an input letter.  Raises an argument error if the
-letter isn&#39;t from the LETTERS hash</p>
+<p>Builds a group match from an input letter.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>character</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>made of a single character</p>
+</div>
+      
+    </li>
   
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>collection of commonly mis-ocr&#39;d characters bounded by square brackets</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ArgumentError</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>if the argument isn&#39;t a single character string</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -322,16 +377,16 @@ letter isn&#39;t from the LETTERS hash</p>
       <pre class="lines">
 
 
-55
-56
-57
-58
-59
-60
-61</pre>
+61
+62
+63
+64
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 61</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_build_collection'>build_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_character'>character</span><span class='rparen'>)</span>
   <span class='kw'>unless</span> <span class='const'>LETTERS</span><span class='lbracket'>[</span><span class='id identifier rubyid_character'>character</span><span class='rbracket'>]</span>
@@ -348,7 +403,7 @@ letter isn&#39;t from the LETTERS hash</p>
       <div class="method_details ">
   <h3 class="signature " id="build_regex-instance_method">
   
-    - (<tt>Object</tt>) <strong>build_regex</strong>(input) 
+    - (<tt>String</tt>) <strong>build_regex</strong>(input) 
   
 
   
@@ -363,7 +418,46 @@ letter isn&#39;t from the LETTERS hash</p>
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>input</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>to be parsed</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>formatted as a valid regular expression optimized for capturing OCR
+mistakes</p>
+</div>
+      
+    </li>
   
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -371,14 +465,14 @@ letter isn&#39;t from the LETTERS hash</p>
       <pre class="lines">
 
 
-40
-41
 42
 43
-44</pre>
+44
+45
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 40</span>
+      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 42</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_build_regex'>build_regex</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='period'>.</span><span class='id identifier rubyid_chars'>chars</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_char'>char</span><span class='op'>|</span>
@@ -393,7 +487,7 @@ letter isn&#39;t from the LETTERS hash</p>
       <div class="method_details ">
   <h3 class="signature " id="combine_whitespace-instance_method">
   
-    - (<tt>Object</tt>) <strong>combine_whitespace</strong>(string) 
+    - (<tt>String</tt>) <strong>combine_whitespace</strong>(string) 
   
 
   
@@ -409,7 +503,45 @@ whitespace character</p>
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>string</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>of any length</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>where consecutive whitespace characters have been collapsed</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -417,12 +549,12 @@ whitespace character</p>
       <pre class="lines">
 
 
-48
-49
-50</pre>
+52
+53
+54</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 52</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_combine_whitespace'>combine_whitespace</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\s</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -435,7 +567,7 @@ whitespace character</p>
       <div class="method_details ">
   <h3 class="signature " id="escape-instance_method">
   
-    - (<tt>Object</tt>) <strong>escape</strong>(character) 
+    - (<tt>String</tt>) <strong>escape</strong>(character) 
   
 
   
@@ -450,7 +582,45 @@ whitespace character</p>
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>character</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>made of a single character</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>escaped character with whitespace charactions made optional</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -458,15 +628,15 @@ whitespace character</p>
       <pre class="lines">
 
 
-65
-66
-67
-68
-69
-70</pre>
+73
+74
+75
+76
+77
+78</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 65</span>
+      <pre class="code"><span class="info file"># File 'lib/oorb.rb', line 73</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_escape'>escape</span><span class='lparen'>(</span><span class='id identifier rubyid_character'>character</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_character'>character</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>1</span>
@@ -533,7 +703,7 @@ whitespace character</p>
 </div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/_index.html

@@ -107,7 +107,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/file.CODE_OF_CONDUCT.html

@@ -118,7 +118,7 @@ href="http://contributor-covenant.org/version/1/3/0/">contributor-covenant.org/v
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/file.LICENSE.html

@@ -64,7 +64,7 @@
     <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2016 Calvyn82<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/file.README.html

@@ -134,7 +134,7 @@ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/index.html

@@ -134,7 +134,7 @@ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jun 11 11:35:54 2016 by
+  Generated on Sat Jun 11 12:25:54 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/lib/oorb.rb

@@ -37,6 +37,8 @@ class OORB
 
   ##
   # Builds an OCR optimized regular expression from a string
+  # @param input [String] to be parsed
+  # @return [String] formatted as a valid regular expression optimized for capturing OCR mistakes
   def build_regex(input)
     input.downcase.chars.map do |char|
       LETTERS.has_key?(char) ? build_collection(char) : escape(char)
@@ -45,13 +47,17 @@ class OORB
 
   ##
   # Collapses mutliple consecutive whitespace characters into a single whitespace character
+  # @param string [String] of any length
+  # @return [String] where consecutive whitespace characters have been collapsed
   def combine_whitespace(string)
     string.gsub(/\s+/, "\s")
   end
 
   ##
   # Builds a group match from an input letter. 
-  # Raises an argument error if the letter isn't from the LETTERS hash
+  # @raise [ArgumentError] if the argument isn't a single character string
+  # @param character [String] made of a single character
+  # @return [String] collection of commonly mis-ocr'd characters bounded by square brackets
   def build_collection(character)
     unless LETTERS[character]
       raise ArgumentError, "Valid arguments are a single character from #{LETTERS.keys.join(", ")}."
@@ -62,6 +68,8 @@ class OORB
 
   ##
   # Escapes a single-character string and makes whitespace characters optional
+  # @param character [String] made of a single character
+  # @return [String] escaped character with whitespace charactions made optional
   def escape(character)
     if character.length > 1
       raise ArgumentError, "Argument must be a single character string"

data/lib/oorb/version.rb

@@ -1,3 +1,3 @@
 module Oorb
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oorb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Calvyn82