doing 2.1.0pre → 2.1.4pre

data/doc/String.html

@@ -99,14 +99,16 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/doing/string.rb</dd>
+    <dd>lib/doing/string.rb<span class="defines">,<br />
+  lib/doing/string_chronify.rb</span>
+</dd>
   </dl>
   
 </div>
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>String helpers</p>
+    <p>Chronify methods for strings</p>
 
 
   </div>
@@ -138,6 +140,28 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#add_at-instance_method" title="#add_at (instance method)">#<strong>add_at</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#add_tags-instance_method" title="#add_tags (instance method)">#<strong>add_tags</strong>(tags, remove: false)  &#x21d2; Object </a>
     
 
@@ -199,6 +223,52 @@
     <span class="summary_desc"><div class='inline'><p>Capitalize on the first character on string.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#chronify-instance_method" title="#chronify (instance method)">#<strong>chronify</strong>(**options)  &#x21d2; DateTime </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Converts input string into a Time object when input takes on the following formats:             - interval format e.g.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#chronify_qty-instance_method" title="#chronify_qty (instance method)">#<strong>chronify_qty</strong>  &#x21d2; Integer </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Converts simple strings into seconds that can be added to a Time object.</p>
+</div></span>
+  
 </li>
 
       
@@ -648,6 +718,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#pluralize-instance_method" title="#pluralize (instance method)">#<strong>pluralize</strong>(number)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -716,6 +808,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#simple_wrap-instance_method" title="#simple_wrap (instance method)">#<strong>simple_wrap</strong>(width)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -965,6 +1079,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#wildcard_to_rx-instance_method" title="#wildcard_to_rx (instance method)">#<strong>wildcard_to_rx</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -1014,7 +1150,19 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="add_tags-instance_method">
+  <h3 class="signature first" id="add_at-instance_method">
+  
+    #<strong>add_at</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="add_tags-instance_method">
   
     #<strong>add_tags</strong>(tags, remove: false)  &#x21d2; <tt>Object</tt> 
   
@@ -1073,6 +1221,162 @@
   
 </ul>
 
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="chronify-instance_method">
+  
+    #<strong>chronify</strong>(**options)  &#x21d2; <tt>DateTime</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Converts input string into a Time object when input
+takes on the following formats:
+            - interval format e.g. &#39;1d2h30m&#39;, &#39;45m&#39;
+              etc.
+            - a semantic phrase e.g. &#39;yesterday
+              5:30pm&#39;
+            - a strftime e.g. &#39;2016-03-15 15:32:04
+              PDT&#39;</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Additional options</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:future</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>assume future date
+(default: false)</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:guess</span>
+          <span class="type">(<tt><span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>:begin or :end to
+assume beginning or end of
+arbitrary time range</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>DateTime</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>result</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>InvalidTimeExpression</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="chronify_qty-instance_method">
+  
+    #<strong>chronify_qty</strong>  &#x21d2; <tt>Integer</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Converts simple strings into seconds that can be
+added to a Time object</p>
+
+<p>Input string can be HH:MM or XX[dhm]<a href="1d2h30m,%2045m,%201.5d,%201h20m,%20etc.">[XXhm][XXm]</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Integer</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>seconds</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div>
 </div>
     
@@ -1636,6 +1940,18 @@ may not render the same style.</p>
   
 
   
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="pluralize-instance_method">
+  
+    #<strong>pluralize</strong>(number)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
 </h3>
 </div>
     
@@ -1692,6 +2008,18 @@ may not render the same style.</p>
   
 
   
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="simple_wrap-instance_method">
+  
+    #<strong>simple_wrap</strong>(width)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
 </h3>
 </div>
     
@@ -2197,6 +2525,18 @@ between characters</p>
   
 
   
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="wildcard_to_rx-instance_method">
+  
+    #<strong>wildcard_to_rx</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
 </h3>
 </div>
     
@@ -2280,7 +2620,7 @@ between characters</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Nov 27 10:06:03 2021 by
+  Generated on Fri Dec 17 16:17:19 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doc/Symbol.html

@@ -240,7 +240,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov 27 10:06:03 2021 by
+  Generated on Fri Dec 17 16:17:19 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doc/Time.html

@@ -127,6 +127,28 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#humanize-instance_method" title="#humanize (instance method)">#<strong>humanize</strong>(seconds)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#relative_date-instance_method" title="#relative_date (instance method)">#<strong>relative_date</strong>  &#x21d2; Object </a>
     
 
@@ -141,6 +163,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#time_ago-instance_method" title="#time_ago (instance method)">#<strong>time_ago</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -156,7 +200,19 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="relative_date-instance_method">
+  <h3 class="signature first" id="humanize-instance_method">
+  
+    #<strong>humanize</strong>(seconds)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="relative_date-instance_method">
   
     #<strong>relative_date</strong>  &#x21d2; <tt>Object</tt> 
   
@@ -164,6 +220,18 @@
   
 
   
+</h3>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="time_ago-instance_method">
+  
+    #<strong>time_ago</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
 </h3>
 </div>
     
@@ -172,7 +240,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Nov 27 10:06:03 2021 by
+  Generated on Fri Dec 17 16:17:18 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>