cron-spec 0.1.0 → 0.1.1

data/.idea/cron-spec.iml

@@ -35,6 +35,11 @@
     <orderEntry type="library" scope="PROVIDED" name="[gem] rcov (v0.9.8, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rcov-0.9.8)" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="[gem] git (v1.2.5, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/git-1.2.5)" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="[gem] rake (v0.8.7, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rake-0.8.7)" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="[gem] rspec (v2.1.0, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rspec-2.1.0)" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="[gem] rspec-core (v2.1.0, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rspec-core-2.1.0)" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="[gem] diff-lcs (v1.1.2, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/diff-lcs-1.1.2)" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="[gem] rspec-mocks (v2.1.0, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rspec-mocks-2.1.0)" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="[gem] rspec-expectations (v2.1.0, /Users/dave/.rvm/gems/ruby-1.9.2-p0@rails3/gems/rspec-expectations-2.1.0)" level="application" />
   </component>
 </module>
 

data/.idea/workspace.xml

@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="5a15dc32-6ade-4091-9f48-a1ce07241214" name="Default" comment="" />
+    <list default="true" id="5a15dc32-6ade-4091-9f48-a1ce07241214" name="Default" comment="">
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/.idea/workspace.xml" afterPath="$PROJECT_DIR$/.idea/workspace.xml" />
+    </list>
     <ignored path="cron-spec.iws" />
     <ignored path=".idea/workspace.xml" />
     <option name="TRACKING_ENABLED" value="true" />
@@ -27,7 +29,7 @@
       <file leaf-file-name="Rakefile" pinned="false" current="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/Rakefile">
           <provider selected="true" editor-type-id="text-editor">
-            <state line="26" column="55" selection-start="1012" selection-end="1012" vertical-scroll-proportion="-14.444445">
+            <state line="26" column="55" selection-start="1012" selection-end="1012" vertical-scroll-proportion="0.0">
               <folding />
             </state>
           </provider>
@@ -36,7 +38,7 @@
       <file leaf-file-name="single_value_cron_value_spec.rb" pinned="false" current="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/spec/single_value_cron_value_spec.rb">
           <provider selected="true" editor-type-id="text-editor">
-            <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="-0.5555556">
+            <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.0">
               <folding />
             </state>
           </provider>
@@ -45,7 +47,7 @@
       <file leaf-file-name="cron_specification_spec.rb" pinned="false" current="true" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/spec/cron_specification_spec.rb">
           <provider selected="true" editor-type-id="text-editor">
-            <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.028571429">
+            <state line="10" column="12" selection-start="336" selection-end="336" vertical-scroll-proportion="0.27173913">
               <folding />
             </state>
           </provider>
@@ -169,6 +171,7 @@
   </component>
   <component name="TaskManager">
     <task active="true" id="Default" summary="Default task">
+      <changelist id="5a15dc32-6ade-4091-9f48-a1ce07241214" name="Default" comment="" />
       <created>1298829562652</created>
       <updated>1298829562652</updated>
     </task>
@@ -178,22 +181,22 @@
     <frame x="142" y="22" width="1538" height="959" extended-state="0" />
     <editor active="false" />
     <layout>
-      <window_info id="Messages" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
-      <window_info id="Changes" active="true" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.3298731" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
+      <window_info id="Changes" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.3298731" sideWeight="0.5" order="7" side_tool="false" content_ui="tabs" />
       <window_info id="TODO" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="6" side_tool="false" content_ui="tabs" />
       <window_info id="Structure" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="1" side_tool="true" content_ui="tabs" />
-      <window_info id="Dependency Viewer" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
-      <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.24966975" sideWeight="0.67012686" order="0" side_tool="false" content_ui="tabs" />
+      <window_info id="Dependency Viewer" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="7" side_tool="false" content_ui="tabs" />
+      <window_info id="Project" active="true" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.24966975" sideWeight="0.67012686" order="0" side_tool="false" content_ui="tabs" />
       <window_info id="Debug" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.4" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
       <window_info id="Run" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="2" side_tool="false" content_ui="tabs" />
-      <window_info id="Version Control" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="-1" side_tool="false" content_ui="tabs" />
+      <window_info id="Version Control" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="7" side_tool="false" content_ui="tabs" />
       <window_info id="Cvs" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="4" side_tool="false" content_ui="tabs" />
       <window_info id="Message" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
-      <window_info id="Find" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
       <window_info id="Ant Build" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
+      <window_info id="Find" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
+      <window_info id="Messages" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="7" side_tool="false" content_ui="tabs" />
       <window_info id="Commander" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.4" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
-      <window_info id="Inspection" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.4" sideWeight="0.5" order="5" side_tool="false" content_ui="tabs" />
       <window_info id="Hierarchy" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="2" side_tool="false" content_ui="combo" />
+      <window_info id="Inspection" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.4" sideWeight="0.5" order="5" side_tool="false" content_ui="tabs" />
     </layout>
   </component>
   <component name="VcsManagerConfiguration">
@@ -232,112 +235,86 @@
   <component name="editorHistoryManager">
     <entry file="file://$PROJECT_DIR$/lib/cron-spec/minute_factory.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="2" column="28" selection-start="45" selection-end="45" vertical-scroll-proportion="0.037926674">
-          <folding />
-        </state>
+        <state line="2" column="28" selection-start="45" selection-end="45" vertical-scroll-proportion="0.037926674" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/lib/cron-spec/hour_factory.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="2" column="26" selection-start="43" selection-end="43" vertical-scroll-proportion="0.037926674">
-          <folding />
-        </state>
+        <state line="2" column="26" selection-start="43" selection-end="43" vertical-scroll-proportion="0.037926674" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/lib/cron-spec/dow_factory.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="25" selection-start="41" selection-end="41" vertical-scroll-proportion="0.018963337">
-          <folding />
-        </state>
+        <state line="1" column="25" selection-start="41" selection-end="41" vertical-scroll-proportion="0.018963337" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/lib/cron-spec/day_factory.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="25" selection-start="41" selection-end="41" vertical-scroll-proportion="0.018963337">
-          <folding />
-        </state>
+        <state line="1" column="25" selection-start="41" selection-end="41" vertical-scroll-proportion="0.018963337" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/spec/wildcard_cron_value_spec.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.018495684">
-          <folding />
-        </state>
+        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.018495684" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/spec/step_cron_value_spec.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.018495684">
-          <folding />
-        </state>
+        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.018495684" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/spec/range_cron_value_spec.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="6" selection-start="6" selection-end="6" vertical-scroll-proportion="-0.0">
-          <folding />
-        </state>
+        <state line="0" column="6" selection-start="6" selection-end="6" vertical-scroll-proportion="-0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/VERSION">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="19" selection-start="5" selection-end="5" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="19" selection-start="5" selection-end="5" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/.document">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/README.rdoc">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/.rspec">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/Gemfile">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/LICENSE.txt">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
-          <folding />
-        </state>
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0" />
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/Rakefile">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="26" column="55" selection-start="1012" selection-end="1012" vertical-scroll-proportion="-14.444445">
+        <state line="26" column="55" selection-start="1012" selection-end="1012" vertical-scroll-proportion="0.0">
           <folding />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/spec/single_value_cron_value_spec.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="-0.5555556">
+        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.0">
           <folding />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/spec/cron_specification_spec.rb">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="1" column="0" selection-start="22" selection-end="22" vertical-scroll-proportion="0.028571429">
+        <state line="10" column="12" selection-start="336" selection-end="336" vertical-scroll-proportion="0.27173913">
           <folding />
         </state>
       </provider>

data/README.rdoc

@@ -1,6 +1,59 @@
-= cron-spec
+= cron-spec - Exposing the cron syntax as a time filter
 
-Description goes here.
+cron-spec provides the Ruby developer with a way to leverage the cron
+syntax to add flexible time filtering for his/her code.
+
+Most cron-aware people see the cron syntax as a way to fire off an activity 
+at a specific time/day/month, etc. There are a variety of tools out there
+that handle this sort of activity. cron-spec tries to address a different
+subset of problems. In particular, cron-spec allows the developer to ask if 
+a particular date/time is effective with respect to a cron specification.
+
+For example, a web application might want to display a message to the end-user
+each Friday between the hours of 8AM and 5PM indicating that there will be
+a maintenance that night. The developer could simply define a cron
+specification like '* 8-17 * * fri', then for each end-user request, check
+the current time against this specification to determine whether or not 
+to display the message. This specification is much more succinct than other - more explicit - types of filter specifications.
+
+== Installing
+
+Since cron-spec is a gem, installing is relatively straightforward:
+
+ gem install cron-spec
+
+== Usage
+
+To use a cron specification as a time filter simply construct a new
+specification, then ask if it is in effect.
+
+ cs = CronSpec::CronSpecification.new("* 8-17 * * fri")
+ cs.is_specification_in_effect?(Time.now) # => true/false
+
+cron-spec handles most - if not all - the standard cron syntax illustrated
+below:
+
+There are several special predefined values which can be used to substitute the CRON expression.
+ Entry                  Description     Equivalent To
+ @yearly (or @annually) Run once a year   0 0 1 1 *
+ @monthly               Run once a month  0 0 1 * *
+ @weekly                Run once a week   0 0 * * 0
+ @daily (or @midnight)  Run once a day    0 0 * * *
+ @hourly                Run once an hour  0 * * * *
+
+ *    *    *    *    *      
+ -    -    -    -    -
+ |    |    |    |    |
+ |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
+ |    |    |    +---------- month (1 - 12)
+ |    |    +--------------- day of month (1 - 31)
+ |    +-------------------- hour (0 - 23)
+ +------------------------- min (0 - 59)
+
+The following named entries can be used:
+
+* Day of week - sun, mon, tue, wed, thu, fri, sat
+* Month - jan feb mar apr may jun jul aug sep oct nov dec
 
 == Contributing to cron-spec
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/cron-spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cron-spec}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dave Sieh"]
-  s.date = %q{2011-02-27}
+  s.date = %q{2011-02-28}
   s.description = %q{Cron specification implementation}
   s.email = %q{dave.sieh@nursinghomequality.com}
   s.extra_rdoc_files = [

data/lib/cron-spec/cron_specification.rb

@@ -1,4 +1,10 @@
 module CronSpec
+
+  ##
+  # Encapsulates the interpretation of a cron specification and 
+  # provides a method which determines if the specified time is effective
+  # with respect to the specification.
+  #
   class CronSpecification
 
     TimeMethods = [ :min, :hour, :day, :month, :wday ]
@@ -31,6 +37,35 @@ module CronSpec
 
     attr_reader :raw_specification
 
+    ##
+    # Constructs a new CronSpecification with a textual cron specificiation.
+    #
+    # A broad cron syntax is supported:
+    #
+    #  *    *    *    *    *      
+    #  -    -    -    -    -
+    #  |    |    |    |    |
+    #  |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
+    #  |    |    |    +---------- month (1 - 12)
+    #  |    |    +--------------- day of month (1 - 31)
+    #  |    +-------------------- hour (0 - 23)
+    #  +------------------------- min (0 - 59)
+    #
+    # The following named entries can be used:
+    #
+    # * Day of week - sun, mon, tue, wed, thu, fri, sat
+    # * Month - jan feb mar apr may jun jul aug sep oct nov dec
+    #
+    # The following constructs are supported:
+    # 
+    # * Ranges are supported (e.g. 2-10 or mon-fri)
+    # * Multiple values are supported (e.g. 2,3,8 or mon,wed,fri)
+    # * Wildcards are supported (e.g. *)
+    # * Step values are supported (e.g. */4)
+    # * Combinations of all but wildcard are supported (e.g. 2,*/3,8-10)
+    #
+    # A single space is required between each group.
+    # 
     def initialize(raw_specification)
       raise "Must specify a cron specification" if raw_specification.nil?
 
@@ -47,7 +82,11 @@ module CronSpec
       @cron_values << parse_specification(specification[DOW], DowFactory.new)
     end
 
-        def is_specification_in_effect?(time=Time.now.in_time_zone(DISPLAY_TIME_ZONE))
+    ##
+    # Return true if the specified time falls within the definition of the
+    # CronSpecification. The parameter defaults to the current time.
+    #
+    def is_specification_in_effect?(time=Time.now)
       idx = 0
       test_results = @cron_values.collect do | cvalues |
         time_value = time.send(TimeMethods[idx])

data/lib/cron-spec/cron_specification_factory.rb

@@ -1,5 +1,8 @@
 module CronSpec
 
+  ##
+  # Base class for the definition of CronSpecificationFactory classes.
+  #
   class CronSpecificationFactory
 
     WildcardPattern = /\A\*\z/
@@ -7,12 +10,24 @@ module CronSpec
     RangePattern = /\A(\d+)-(\d+)\z/
     StepPattern = /\A\*\/(\d+)\z/
 
+    ## 
+    # Constructs a new CronSpecificationFactory
+    #
     def initialize
       @single_value_pattern = SingleValuePattern
       @range_pattern = RangePattern
       @step_pattern = StepPattern
     end
 
+    ##
+    # Parses a unit of a cron specification.
+    # The supported patterns for parsing are one of:
+    # 
+    # * Wildcard '*'
+    # * Single Scalar Value [0-9]+|(sun|mon|tue|wed|thu|fri|sat)|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)
+    # * Range value (0-9, mon-fri, etc.)
+    # * Step value (*/[0-9]+)
+    #
     def parse(value_spec)
       case value_spec
         when WildcardPattern
@@ -36,4 +51,4 @@ module CronSpec
 
   end
 
-end
+end

data/lib/cron-spec/cron_value_base.rb

@@ -1,9 +1,18 @@
 module CronSpec
 
+  ##
+  # Base class for parsed cron values.
+  #
   class CronValueBase
 
     attr_reader :lower_limit, :upper_limit
 
+    ##
+    # Constructs a new CronValueBase with the upper and lower limits of 
+    # values allowed for this CronValue. For example, when definiting a
+    # CronValue for a 'minute', the lower limit would be 0 and the upper
+    # limit would be 59.
+    #
     def initialize(lower_limit, upper_limit)
       @lower_limit = lower_limit
       @upper_limit = upper_limit
@@ -11,9 +20,13 @@ module CronSpec
       raise "Lower limit must be less than or equal to upper limit" if @lower_limit > @upper_limit
     end
 
+    ##
+    # Returns true if the specified value is with the upper and lower 
+    # limits defined for this CronValue.
+    #
     def is_value_within_limits?(value)
       value >= @lower_limit && value <= upper_limit
     end
   end
 
-end
+end

data/lib/cron-spec/day_factory.rb

@@ -1,12 +1,20 @@
 module CronSpec
+  ##
+  # Factory for constructing Day CronValues from a cron specification.
+  #
   class DayFactory < CronSpecificationFactory
+    
+    # The lower limit for a value representing a day of the month
     DayLowerLimit = 1
+    # The upper limit for a value representing a day of the month
     DayUpperLimit = 31
 
+    ##
+    # Constructs a new DayFactory object.
     def initialize
       super
       @lower_limit = DayLowerLimit
       @upper_limit = DayUpperLimit
     end
   end
-end
+end

data/lib/cron-spec/dow_factory.rb

@@ -1,19 +1,33 @@
 module CronSpec
+
+  ##
+  # Factory for constructing Day of week values from a cron specification.
+  #
   class DowFactory < CronSpecificationFactory
 
+    # The lower limit for the value of a day of the week (0-Sunday)
     DayOfWeekLowerLimit = 0
+    # The upper limit for the value of a day of the week (6-Saturday)
     DayOfWeekUpperLimit = 6
 
+    # The supported names for the days of the week
     DaysOfWeek = %w{ sun mon tue wed thu fri sat }
 
+    # A pipe-delimited expression for the days of the week
     DayOfWeekExpression = DaysOfWeek.join('|')
 
+    # A regular expression that matches a single day of the week.
     DayOfWeekSingleValuePattern = /\A(#{DayOfWeekExpression}|\d)\z/
 
+    # Regular expression that matches a range of days of the week
     DayOfWeekRangePattern = /\A(#{DayOfWeekExpression}|\d)-(#{DayOfWeekExpression}|\d)\z/
 
+    # Regular expression that matches only a named day of the week.
     NamedDayOfWeekPattern = /\A(#{DayOfWeekExpression})\z/
 
+    ##
+    # Constructs a new DowFactory object.
+    #
     def initialize
       super
       @lower_limit = DayOfWeekLowerLimit
@@ -29,5 +43,6 @@ module CronSpec
       # Sunday can be specified as index 7
       (dow == 7) ? 0 : dow
     end
+
   end
-end
+end

data/lib/cron-spec/hour_factory.rb

@@ -1,10 +1,18 @@
 module CronSpec
 
+  ##
+  # Factory for constructing hour cron values from a cron specification.
+  #
   class HourFactory < CronSpecificationFactory
 
+    # The lower limit of a value representing an hour of the day.
     HourLowerLimit = 0
+    # The upper limit of a value representing an hour of the day.
     HourUpperLimit = 23
 
+    ##
+    # Constructs a new HourFactory object.
+    #
     def initialize
       super
       @lower_limit = HourLowerLimit
@@ -13,4 +21,4 @@ module CronSpec
 
   end
 
-end
+end

data/lib/cron-spec/minute_factory.rb

@@ -1,10 +1,17 @@
 module CronSpec
 
+  ##
+  # Factory for constructing minute cron values from a cron specification.
+  #
   class MinuteFactory < CronSpecificationFactory
 
+    # The lower limit of a value representing a minute of an hour
     MinuteLowerLimit = 0
+    # The upper limit of a value representing a minute of an hour
     MinuteUpperLimit = 59
 
+    ##
+    # Constructs a new MinuteFactory object.
     def initialize
       super
       @lower_limit = MinuteLowerLimit
@@ -13,4 +20,4 @@ module CronSpec
 
   end
 
-end
+end

data/lib/cron-spec/month_factory.rb

@@ -1,19 +1,33 @@
 module CronSpec
+
+  ##
+  # Factory for constructing month cron values from a cron specification.
+  #
   class MonthFactory < CronSpecificationFactory
 
+    # The lower limit for a value representing a month of a year
     MonthLowerLimit = 1
+    # The upper limit for a value representing a month of a year
     MonthUpperLimit = 12
 
+    # The supported names of the months
     Months = %w{ jan feb mar apr may jun jul aug sep oct nov dec }
 
+    # A pipe-delimited list of the months of the year
     MonthExpression = Months.join('|')
 
+    # A regular expression to match a single value month expression
     MonthSingleValuePattern = /\A(#{MonthExpression}|\d+)\z/
 
+    # A regular expression to match a range month expression
     MonthRangePattern = /\A(#{MonthExpression}|\d+)-(#{MonthExpression}|\d+)\z/
 
+    # A regular expression to match a named month
     NamedMonthPattern = /\A(#{MonthExpression})\z/
 
+    ##
+    # Constructs a new MonthFactory object.
+    #
     def initialize
       super
       @lower_limit = MonthLowerLimit
@@ -29,4 +43,4 @@ module CronSpec
     end
 
   end
-end
+end

data/lib/cron-spec/range_cron_value.rb

@@ -1,9 +1,21 @@
 module CronSpec
 
+  ##
+  # A cron value representing a range of values
+  #
   class RangeCronValue < CronValueBase
 
     attr_reader :range_lower, :range_upper
 
+    ##
+    # Constructs a new RangeCronValue object. The object is initialized
+    # with the value limits (lower_limit and upper_limit) and the 
+    # defined sub-range of the lower/upper limits. 
+    # 
+    # The range_lower and range_upper values are checked to determine if
+    # they are within the value limits and are not reversed. If they are not
+    # within limits or reversed an exception is raised.
+    #
     def initialize(lower_limit, upper_limit, range_lower, range_upper)
       super(lower_limit, upper_limit)
       @range_lower = range_lower
@@ -14,10 +26,14 @@ module CronSpec
       raise "Lower limit must be less than or equal to the upper limit" if @range_lower > @range_upper
     end
 
+    ##
+    # Returns true if the specified value is with the range_upper/range_lower
+    # value range, inclusive.
+    #
     def is_effective?(value)
       @range_lower <= value && value <= @range_upper
     end
 
   end
 
-end
+end

data/lib/cron-spec/single_value_cron_value.rb

@@ -1,9 +1,17 @@
 module CronSpec
 
+  ##
+  # A single cron value
+  #
   class SingleValueCronValue < CronValueBase
 
     attr_reader :single_value
 
+    ##
+    # Constructs a new SingleValueCronValue having the specified limits
+    # and value. The value is checked to determine if it fits within the
+    # specified limits; if it doesn't, an exception is raised.
+    #
     def initialize(lower_limit, upper_limit, single_value)
       super(lower_limit, upper_limit)
 
@@ -12,10 +20,14 @@ module CronSpec
       raise "Value is out of range: #{@single_value}" unless is_value_within_limits?(@single_value)
     end
 
+    ##
+    # Returns true if the specified value is equal to the value encapsulated
+    # by the SingleValueCronValue.
+    #
     def is_effective?(value)
       @single_value == value
     end
 
   end
 
-end
+end

data/lib/cron-spec/step_cron_value.rb

@@ -1,9 +1,17 @@
 module CronSpec
 
+  ##
+  # Defines an instance of a step value within a cron specification.
+  #
   class StepCronValue < CronValueBase
 
     attr_reader :step_value
 
+    ##
+    # Constructs a new StepCronValue with the specified lower and upper limits
+    # and step value. If the step value is 0 or is not less than or equal to
+    # the upper limit, an exception is raised.
+    #
     def initialize(lower_limit, upper_limit, step_value)
       super(lower_limit, upper_limit)
 
@@ -12,10 +20,14 @@ module CronSpec
       raise "Invalid step value: #{@step_value}" if step_value == 0 || step_value > upper_limit
     end
 
+    ##
+    # Returns true if the specified value represents a value step value within
+    # the step specification. Verifies that value % step_value == 0
+    #
     def is_effective?(value)
       value % @step_value == 0
     end
 
   end
 
-end
+end

data/lib/cron-spec/wildcard_cron_value.rb

@@ -1,15 +1,24 @@
 module CronSpec
 
+  ##
+  # Represents a wildcard value
+  #
   class WildcardCronValue < CronValueBase
 
+    ##
+    # Constructs a new WildcardCronValue with the specified limits.
+    #
     def initialize(lower_limit, upper_limit)
       super(lower_limit, upper_limit)
     end
 
+    ##
+    # Returns true if the specified value is any value whatsoever.
+    #
     def is_effective?(value)
       true
     end
 
   end
 
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Dave Sieh
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 -07:00
+date: 2011-02-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -136,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3189745320292493514
+      hash: -3901467252571771135
       segments: 
       - 0
       version: "0"