RubyGems - smart_month - Versions diffs - 1.0.0 - Mend

smart_month 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (90) hide show

data/MIT-LICENSE +20 -0
data/README +33 -0
data/Rakefile +51 -0
data/VERSION +1 -0
data/lib/month.rb +26 -0
data/lib/smart_month.rb +11 -0
data/lib/smart_month/calculations.rb +87 -0
data/lib/smart_month/collection.rb +51 -0
data/lib/smart_month/extensions/date.rb +19 -0
data/lib/smart_month/magic.rb +71 -0
data/lib/smart_month/math.rb +41 -0
data/lib/smart_month/rulesets.rb +151 -0
data/lib/smart_month/util.rb +37 -0
data/pkg/smart_month-1.0.0.gem +0 -0
data/rdoc/classes/Date.html +209 -0
data/rdoc/classes/Month.html +189 -0
data/rdoc/classes/SmartMonth.html +136 -0
data/rdoc/classes/SmartMonth/Calculations.html +383 -0
data/rdoc/classes/SmartMonth/Collection.html +306 -0
data/rdoc/classes/SmartMonth/Magic.html +214 -0
data/rdoc/classes/SmartMonth/Magic/MonthFactory.html +178 -0
data/rdoc/classes/SmartMonth/Math.html +311 -0
data/rdoc/classes/SmartMonth/Rulesets.html +419 -0
data/rdoc/classes/SmartMonth/Util.html +302 -0
data/rdoc/classes/Time.html +152 -0
data/rdoc/created.rid +1 -0
data/rdoc/files/README.html +170 -0
data/rdoc/files/lib/month_rb.html +113 -0
data/rdoc/files/lib/smart_month/calculations_rb.html +101 -0
data/rdoc/files/lib/smart_month/collection_rb.html +101 -0
data/rdoc/files/lib/smart_month/extensions/date_rb.html +108 -0
data/rdoc/files/lib/smart_month/magic_rb.html +101 -0
data/rdoc/files/lib/smart_month/math_rb.html +101 -0
data/rdoc/files/lib/smart_month/rulesets_rb.html +108 -0
data/rdoc/files/lib/smart_month/util_rb.html +101 -0
data/rdoc/files/lib/smart_month_rb.html +108 -0
data/rdoc/fr_class_index.html +37 -0
data/rdoc/fr_file_index.html +36 -0
data/rdoc/fr_method_index.html +74 -0
data/rdoc/index.html +24 -0
data/rdoc/rdoc-style.css +208 -0
data/smart_month.gemspec +179 -0
data/test/spec/date/accessor_spec.rb +91 -0
data/test/spec/date/add_month_spec.rb +24 -0
data/test/spec/date/add_spec.rb +23 -0
data/test/spec/date/boat_spec.rb +20 -0
data/test/spec/date/civil_spec.rb +28 -0
data/test/spec/date/commercial_spec.rb +29 -0
data/test/spec/date/constants_spec.rb +41 -0
data/test/spec/date/conversions_spec.rb +153 -0
data/test/spec/date/downto_spec.rb +18 -0
data/test/spec/date/eql_spec.rb +10 -0
data/test/spec/date/gregorian_spec.rb +28 -0
data/test/spec/date/hash_spec.rb +14 -0
data/test/spec/date/infinity_spec.rb +77 -0
data/test/spec/date/julian_spec.rb +52 -0
data/test/spec/date/minus_month_spec.rb +23 -0
data/test/spec/date/minus_spec.rb +30 -0
data/test/spec/date/new_spec.rb +9 -0
data/test/spec/date/neww_spec.rb +9 -0
data/test/spec/date/ordinal_spec.rb +29 -0
data/test/spec/date/parse_spec.rb +149 -0
data/test/spec/date/relationship_spec.rb +20 -0
data/test/spec/date/shared/civil.rb +66 -0
data/test/spec/date/shared/commercial.rb +39 -0
data/test/spec/date/shared/parse.rb +54 -0
data/test/spec/date/shared/parse_eu.rb +30 -0
data/test/spec/date/shared/parse_us.rb +29 -0
data/test/spec/date/step_spec.rb +56 -0
data/test/spec/date/strftime_spec.rb +205 -0
data/test/spec/date/strptime_spec.rb +143 -0
data/test/spec/date/upto_spec.rb +18 -0
data/test/spec/parsedate/parsedate.rb +95 -0
data/test/spec/time/httpdate_spec.rb +21 -0
data/test/spec/time/iso8601_spec.rb +7 -0
data/test/spec/time/rfc2822_spec.rb +7 -0
data/test/spec/time/rfc822_spec.rb +7 -0
data/test/spec/time/shared/rfc2822.rb +65 -0
data/test/spec/time/shared/xmlschema.rb +53 -0
data/test/spec/time/xmlschema_spec.rb +7 -0
data/test/spec_helper.rb +56 -0
data/test/test_helper.rb +4 -0
data/test/unit/calculations_test.rb +82 -0
data/test/unit/collection_test.rb +42 -0
data/test/unit/magic_test.rb +37 -0
data/test/unit/math_test.rb +30 -0
data/test/unit/rulesets_test.rb +94 -0
data/test/unit/samples/test_ruleset.yml +6 -0
data/test/unit/util_test.rb +29 -0
metadata +196 -0

data/rdoc/classes/SmartMonth/Rulesets.html ADDED

@@ -0,0 +1,419 @@
+<?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: SmartMonth::Rulesets</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">SmartMonth::Rulesets</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/smart_month/rulesets_rb.html">
+                lib/smart_month/rulesets.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="#M000044">activate_rules!</a>&nbsp;&nbsp;
+      <a href="#M000042">add_rule</a>&nbsp;&nbsp;
+      <a href="#M000045">inject_rule</a>&nbsp;&nbsp;
+      <a href="#M000041">load_file</a>&nbsp;&nbsp;
+      <a href="#M000040">load_yaml</a>&nbsp;&nbsp;
+      <a href="#M000046">parse</a>&nbsp;&nbsp;
+      <a href="#M000047">parse_string_as_date</a>&nbsp;&nbsp;
+      <a href="#M000048">parse_string_as_frequency</a>&nbsp;&nbsp;
+      <a href="#M000043">remove_rule</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="aliases-list">
+      <h3 class="section-bar">External Aliases</h3>
+      <div class="name-list">
+                        <table summary="aliases">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">add_rule</td>
+          <td>-&gt;</td>
+          <td class="context-item-value">update_rule</td>
+        </tr>
+                        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000042" class="method-detail">
+        <a name="M000042"></a>
+        <div class="method-heading">
+          <a href="#M000042" class="method-signature">
+          <span class="method-name">add_rule</span><span class="method-args">(name, rule, year = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+manually add a rule to the system. The rule argument should be a string, an
+optional year argument can be passed if using a &quot;natural
+frequency&quot;
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000042-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 25</span>
+25:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">add_rule</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">year</span> = <span class="ruby-keyword kw">nil</span>)
+26:       <span class="ruby-ivar">@@rulesets</span> = {} <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">defined?</span> <span class="ruby-ivar">@@rulesets</span>
+27:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
+28:         <span class="ruby-comment cmt"># define rule</span>
+29:         <span class="ruby-identifier">rule_hash</span> = { <span class="ruby-identifier">name</span> =<span class="ruby-operator">&gt;</span> {<span class="ruby-value str">'when'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">rule</span> } }
+30:         <span class="ruby-identifier">rule_hash</span>[<span class="ruby-identifier">name</span>][<span class="ruby-value str">'year'</span>] = <span class="ruby-identifier">year</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">year</span>.<span class="ruby-identifier">nil?</span>
+31:         <span class="ruby-comment cmt"># merge and inject</span>
+32:         <span class="ruby-ivar">@@rulesets</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">rule_hash</span>)
+33:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:inject_rule</span>,<span class="ruby-identifier">name</span>,<span class="ruby-ivar">@@rulesets</span>[<span class="ruby-identifier">name</span>])
+34:       <span class="ruby-keyword kw">end</span>
+35:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000041" class="method-detail">
+        <a name="M000041"></a>
+        <div class="method-heading">
+          <a href="#M000041" class="method-signature">
+          <span class="method-name">load_file</span><span class="method-args">(path)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+this allows import of rules into the system as a yaml file on disk
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000041-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 17</span>
+17:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">path</span>)
+18:       <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">yaml</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_yaml</span>(<span class="ruby-identifier">yaml</span>) }
+19:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000040" class="method-detail">
+        <a name="M000040"></a>
+        <div class="method-heading">
+          <a href="#M000040" class="method-signature">
+          <span class="method-name">load_yaml</span><span class="method-args">(yaml)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+this allows importing of rules into the system as a raw yaml stream
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000040-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 10</span>
+10:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_yaml</span>(<span class="ruby-identifier">yaml</span>)
+11:       <span class="ruby-ivar">@@rulesets</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-identifier">yaml</span>)
+12:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:activate_rules!</span>)
+13:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000043" class="method-detail">
+        <a name="M000043"></a>
+        <div class="method-heading">
+          <a href="#M000043" class="method-signature">
+          <span class="method-name">remove_rule</span><span class="method-args">(name)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+manually remove an existing rule from the system.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000043-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 43</span>
+43:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">remove_rule</span>(<span class="ruby-identifier">name</span>)
+44:       <span class="ruby-keyword kw">begin</span>
+45:         <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">' '</span>,<span class="ruby-value str">'_'</span>).<span class="ruby-identifier">downcase</span>
+46:         <span class="ruby-ivar">@@rulesets</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span> }
+47:         <span class="ruby-constant">Date</span>.<span class="ruby-identifier">class_eval</span>  { <span class="ruby-identifier">eval</span>(<span class="ruby-node">&quot;undef is_#{name}?&quot;</span>) }
+48:         <span class="ruby-constant">Month</span>.<span class="ruby-identifier">class_eval</span> { <span class="ruby-identifier">eval</span>(<span class="ruby-node">&quot;undef #{name}&quot;</span>)}
+49:       <span class="ruby-keyword kw">rescue</span>
+50:        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+51:       <span class="ruby-keyword kw">end</span>
+52:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+53:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <h3 class="section-bar">Protected Instance methods</h3>
+      <div id="method-M000044" class="method-detail">
+        <a name="M000044"></a>
+        <div class="method-heading">
+          <a href="#M000044" class="method-signature">
+          <span class="method-name">activate_rules!</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+iterates through all the rules currently defined in the class and injects
+them if they are not currently implemented.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000044-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 59</span>
+59:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">activate_rules!</span>
+60:       <span class="ruby-ivar">@@rulesets</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
+61:         <span class="ruby-identifier">inject_rule</span>(<span class="ruby-identifier">rule</span>, <span class="ruby-ivar">@@rulesets</span>[<span class="ruby-identifier">rule</span>])
+62:       <span class="ruby-keyword kw">end</span>
+63:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000045" class="method-detail">
+        <a name="M000045"></a>
+        <div class="method-heading">
+          <a href="#M000045" class="method-signature">
+          <span class="method-name">inject_rule</span><span class="method-args">(name,rule)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+this method parses and defines the methods in our pre-existing ruby classes
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000045-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 66</span>
+66:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inject_rule</span>(<span class="ruby-identifier">name</span>,<span class="ruby-identifier">rule</span>)
+67:       <span class="ruby-identifier">meth_name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">' '</span>,<span class="ruby-value str">'_'</span>).<span class="ruby-identifier">downcase</span>
+68:       <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span> = <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">rule</span>)
+69:       <span class="ruby-comment cmt"># don't define the rulset methods if they might override existing methods!</span>
+70:       <span class="ruby-identifier">define_methods</span>(<span class="ruby-identifier">type</span>,<span class="ruby-identifier">meth_name</span>,<span class="ruby-identifier">data</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Month</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">meth_name</span>) <span class="ruby-operator">||</span> <span class="ruby-constant">Date</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">meth_name</span>)
+71:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000046" class="method-detail">
+        <a name="M000046"></a>
+        <div class="method-heading">
+          <a href="#M000046" class="method-signature">
+          <span class="method-name">parse</span><span class="method-args">(rule)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+factory method for determing which parsing strategy to use based on the
+rule.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000046-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 76</span>
+76:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">rule</span>)
+77:       (<span class="ruby-constant">Month</span><span class="ruby-operator">::</span><span class="ruby-constant">NAMES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">rule</span>[<span class="ruby-value str">'when'</span>].<span class="ruby-identifier">split</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">capitalize</span>)) <span class="ruby-operator">?</span> <span class="ruby-identifier">parse_string_as_date</span>(<span class="ruby-identifier">rule</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">parse_string_as_frequency</span>(<span class="ruby-identifier">rule</span>)
+78:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000047" class="method-detail">
+        <a name="M000047"></a>
+        <div class="method-heading">
+          <a href="#M000047" class="method-signature">
+          <span class="method-name">parse_string_as_date</span><span class="method-args">(rule)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+this is the parsing process for basic &quot;date as string&quot; rules (eg:
+&#8216;December 12th, 2005&#8217; or &#8216;March 15th&#8217;)
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000047-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 83</span>
+83:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_string_as_date</span>(<span class="ruby-identifier">rule</span>)
+84:       <span class="ruby-comment cmt"># first attempt to parse the string and load structure</span>
+85:       <span class="ruby-identifier">month</span>,<span class="ruby-identifier">day</span>,<span class="ruby-identifier">year</span> = <span class="ruby-identifier">rule</span>[<span class="ruby-value str">'when'</span>].<span class="ruby-identifier">split</span>
+86:       <span class="ruby-identifier">year</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">year</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">year</span>.<span class="ruby-identifier">nil?</span>
+87:       <span class="ruby-identifier">data</span> = {<span class="ruby-identifier">:year</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">year</span>.<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">:month</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Month</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">month</span>).<span class="ruby-identifier">to_i</span>, <span class="ruby-identifier">:day</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">day</span>.<span class="ruby-identifier">to_i</span>}
+88:       <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">:date</span>,<span class="ruby-identifier">data</span>]
+89:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000048" class="method-detail">
+        <a name="M000048"></a>
+        <div class="method-heading">
+          <a href="#M000048" class="method-signature">
+          <span class="method-name">parse_string_as_frequency</span><span class="method-args">(rule)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+this is the parsing process for basic &quot;date as frequency&quot; rules
+(eg: &#8216;every tuesday and saturday&#8217; or &#8216;every monday in
+march and april&#8217;)
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000048-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/smart_month/rulesets.rb, line 93</span>
+ 93:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_string_as_frequency</span>(<span class="ruby-identifier">rule</span>)
+ 94:       <span class="ruby-identifier">data</span>,<span class="ruby-identifier">context</span> = <span class="ruby-identifier">rule</span>[<span class="ruby-value str">'when'</span>].<span class="ruby-identifier">split</span>(<span class="ruby-value str">'in'</span>)
+ 95:       <span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">rstrip</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">' '</span>,<span class="ruby-value str">'_'</span>).<span class="ruby-identifier">downcase</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span>
+ 96:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">context</span>.<span class="ruby-identifier">nil?</span>
+ 97:         <span class="ruby-identifier">context</span> = <span class="ruby-identifier">context</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/(\,|and)/</span>,<span class="ruby-value str">''</span>).<span class="ruby-identifier">split</span>
+ 98:         <span class="ruby-identifier">context</span>.<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">ctx</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">downcase</span> }
+ 99:       <span class="ruby-keyword kw">end</span>
+100:       <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">:freq</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">context</span>, <span class="ruby-identifier">rule</span>[<span class="ruby-value str">'year'</span>].<span class="ruby-identifier">to_i</span>]
+101:     <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>

data/rdoc/classes/SmartMonth/Util.html ADDED

@@ -0,0 +1,302 @@
+<?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>Module: SmartMonth::Util</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>Module</strong></td>
+          <td class="class-name-in-header">SmartMonth::Util</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/smart_month/util_rb.html">
+                lib/smart_month/util.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Responsible for odds and ends.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000006">inspect</a>&nbsp;&nbsp;
+      <a href="#M000007">inspect!</a>&nbsp;&nbsp;
+      <a href="#M000012">month</a>&nbsp;&nbsp;
+      <a href="#M000009">to_i</a>&nbsp;&nbsp;
+      <a href="#M000010">to_int</a>&nbsp;&nbsp;
+      <a href="#M000008">to_s</a>&nbsp;&nbsp;
+      <a href="#M000011">year</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">inspect</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000012">month</a> as a string.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+   <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 5</span>
+5:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
+6:      <span class="ruby-node">&quot;#{self.to_s}&quot;</span>
+7:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">inspect!</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000012">month</a> and the <a
+href="Util.html#M000011">year</a> as a string.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 10</span>
+10:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect!</span>
+11:       <span class="ruby-node">&quot;#{self.to_s} #{self.year}&quot;</span>
+12:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="#M000012" class="method-signature">
+          <span class="method-name">month</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000012">month</a> of the current <a
+href="Util.html#M000012">month</a>.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000012-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 32</span>
+32:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">month</span>
+33:       <span class="ruby-ivar">@date</span>.<span class="ruby-identifier">month</span>
+34:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">to_i</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000012">month</a> as a fixnum.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 20</span>
+20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_i</span>
+21:       <span class="ruby-constant">Month</span><span class="ruby-operator">::</span><span class="ruby-constant">NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>)
+22:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <span class="method-name">to_int</span><span class="method-args">()</span>
+        </div>
+        <div class="method-description">
+          <p>
+Alias for <a href="Util.html#M000009">to_i</a>
+</p>
+        </div>
+      </div>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000012">month</a> as a string.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 15</span>
+15:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+16:        <span class="ruby-constant">Month</span><span class="ruby-operator">::</span><span class="ruby-constant">NAMES</span>[<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">month</span>]
+17:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="#M000011" class="method-signature">
+          <span class="method-name">year</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns the <a href="Util.html#M000011">year</a> of the current <a
+href="Util.html#M000012">month</a>.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000011-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/smart_month/util.rb, line 27</span>
+27:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">year</span>
+28:       <span class="ruby-ivar">@date</span>.<span class="ruby-identifier">year</span>
+29:     <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>