Sign upLogin

halogenandtoast/timelord

View on GitHub
Star
doc/classes/Timelord.html

Summary

Maintainability
Test Coverage
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: Timelord</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">Timelord</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/timelord_rb.html">
                lib/timelord.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Object
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">



   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000001">parse</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">


    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">SHORT_MONTHS</td>
          <td>=</td>
          <td class="context-item-value">%w(jan feb mar apr may jun jul aug sep oct nov dec).freeze</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">SHORT_MATCHER</td>
          <td>=</td>
          <td class="context-item-value">SHORT_MONTHS.join('|').freeze</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">ORDINAL_MATCHER</td>
          <td>=</td>
          <td class="context-item-value">&quot;st|nd|rd|th&quot;.freeze</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">DAY_NAMES</td>
          <td>=</td>
          <td class="context-item-value">%w(monday tuesday wednesday thursday friday saturday sunday).freeze</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">DAY_MATCHER</td>
          <td>=</td>
          <td class="context-item-value">DAY_NAMES.join('|').freeze</td>
        </tr>
        </table>
      </div>
    </div>



      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000001" class="method-detail">
        <a name="M000001"></a>

        <div class="method-heading">
          <a href="#M000001" class="method-signature">
          <span class="method-name">parse</span><span class="method-args">(str, format = :international)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Parses a date str. Second parameter switches between international and
american date formats.
</p>
<pre>
  Timelord.parse(&quot;Tuesday&quot;).to_s # &quot;2011-01-04&quot;
  Timelord.parse(&quot;11/01&quot;).to_s # &quot;2011-01-11&quot;
  Timelord.parse(&quot;11/01&quot;, :american) # &quot;2011-11-01&quot;
</pre>
<p>
For more examples, check out the <a
href="https://github.com/halogenandtoast/timelord/blob/master/spec/timelord_spec.rb">spec</a>
</p>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000001-source">
<pre>
    <span class="ruby-comment cmt"># File lib/timelord.rb, line 18</span>
18:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">format</span> = <span class="ruby-identifier">:international</span>)
19:     <span class="ruby-identifier">today</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
20:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(\d{4})\/(\d{1,2})\/(\d{1,2})/i</span>
21:       <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$3</span>.<span class="ruby-identifier">to_i</span>)
22:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(\d{4})\-(\d{1,2})\-(\d{1,2})/i</span>
23:       <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$3</span>.<span class="ruby-identifier">to_i</span>)
24:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(\d{1,2})\/(\d{1,2})\/(\d{2}(\d{2})?)/i</span>
25:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:american</span>
26:         <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">$3</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>)
27:       <span class="ruby-keyword kw">else</span>
28:         <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">$3</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>)
29:       <span class="ruby-keyword kw">end</span>
30:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/(\d{1,2})\/(\d{1,2})/i</span>
31:       <span class="ruby-identifier">date</span> = <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:american</span>
32:         <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">today</span>.<span class="ruby-identifier">year</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>)
33:       <span class="ruby-keyword kw">else</span>
34:         <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">today</span>.<span class="ruby-identifier">year</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>)
35:       <span class="ruby-keyword kw">end</span>
36:       <span class="ruby-identifier">set_to_future</span>(<span class="ruby-identifier">date</span>)
37:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/(\d{1,2})\s+(#{SHORT_MATCHER})/i</span>
38:       <span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">today</span>.<span class="ruby-identifier">year</span>, <span class="ruby-constant">SHORT_MONTHS</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">$2</span>.<span class="ruby-identifier">downcase</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>)
39:       <span class="ruby-identifier">set_to_future</span>(<span class="ruby-identifier">date</span>)
40:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/(#{SHORT_MATCHER})\s+(\d{1,2})/i</span>
41:       <span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">today</span>.<span class="ruby-identifier">year</span>, <span class="ruby-constant">SHORT_MONTHS</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">downcase</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">$2</span>.<span class="ruby-identifier">to_i</span>)
42:       <span class="ruby-identifier">set_to_future</span>(<span class="ruby-identifier">date</span>)
43:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/(\d{1,2})(#{ORDINAL_MATCHER})/i</span>
44:       <span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">civil</span>(<span class="ruby-identifier">today</span>.<span class="ruby-identifier">year</span>, <span class="ruby-identifier">today</span>.<span class="ruby-identifier">month</span>, <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>)
45:       <span class="ruby-identifier">set_to_future</span>(<span class="ruby-identifier">date</span>)
46:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span><span class="ruby-node">/next (#{DAY_MATCHER})/i</span>
47:       <span class="ruby-identifier">current_date</span> = <span class="ruby-identifier">today</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%A&quot;</span>).<span class="ruby-identifier">downcase</span>
48:       <span class="ruby-identifier">current_index</span> = <span class="ruby-constant">DAY_NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">current_date</span>)
49:       <span class="ruby-identifier">expected_index</span> = <span class="ruby-constant">DAY_NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">downcase</span>)
50:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">expected_index</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">current_index</span>
51:         <span class="ruby-identifier">today</span> <span class="ruby-operator">+</span> (<span class="ruby-value">7</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_index</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">expected_index</span>) <span class="ruby-operator">+</span> <span class="ruby-value">7</span>
52:       <span class="ruby-keyword kw">else</span>
53:         <span class="ruby-identifier">diff</span> = <span class="ruby-identifier">expected_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_index</span>
54:         <span class="ruby-identifier">today</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">diff</span> <span class="ruby-operator">+</span> <span class="ruby-value">7</span>
55:       <span class="ruby-keyword kw">end</span>
56:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span><span class="ruby-node">/(#{DAY_MATCHER})/i</span>
57:       <span class="ruby-identifier">current_date</span> = <span class="ruby-identifier">today</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%A&quot;</span>).<span class="ruby-identifier">downcase</span>
58:       <span class="ruby-identifier">current_index</span> = <span class="ruby-constant">DAY_NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">current_date</span>)
59:       <span class="ruby-identifier">expected_index</span> = <span class="ruby-constant">DAY_NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">downcase</span>)
60:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">expected_index</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">current_index</span>
61:         <span class="ruby-identifier">today</span> <span class="ruby-operator">+</span> (<span class="ruby-value">7</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_index</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">expected_index</span>)
62:       <span class="ruby-keyword kw">else</span>
63:         <span class="ruby-identifier">diff</span> = <span class="ruby-identifier">expected_index</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">current_index</span>
64:         <span class="ruby-identifier">today</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">diff</span>
65:       <span class="ruby-keyword kw">end</span>
66:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/today/i</span>
67:       <span class="ruby-identifier">today</span>
68:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/tomorrow/i</span>
69:       <span class="ruby-identifier">today</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
70:     <span class="ruby-keyword kw">end</span>
71:   <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>