repeatable 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85f2e7cec322abe280bc2d383c2eb3286685e9ce
-  data.tar.gz: b9495fe2fc4044b096d98734ef8521aaff27439e
+  metadata.gz: 03a465c906b9b2d7fdff5ffc02f1d101f87d3ab8
+  data.tar.gz: d29495e2f3820d482dc6a7e71c21623db1d8a8bf
 SHA512:
-  metadata.gz: eb4e21f11667e4ef609ee9af000a24a83010119cd53fe00c8068272db8fa250b623eeedc77f137dde683edb71d626401bae6cbf0813fba8f43d44e3a0ba93cce
-  data.tar.gz: f6b85f9183fc1e052d5aaefcc6b57f7e52334cbc6685f91e5c930d3be33631af2229b9baa7e717e645d83f83f9b17eedeb9e75a70b42220b58dec677657590cf
+  metadata.gz: 857276ebf76281f5aa7b2c71599417aeb1da1e7fc0f5bbda36806f5165b47eb92a10ede29e510351858eb0b32a3c5dbb2e82f485cacecf9e8547e2ec1605ec07
+  data.tar.gz: 4f5cc44ae471c8bf0006c4570c09e829b803f44cb5661c3dc9fce721e1ed519ecc3b5373016b70d9ad6a2952c96b0fc75dfd2f51d27875fdc2ec555ee9d652fd

data/README.md

@@ -101,14 +101,32 @@ Repeatable::Expression::RangeInYear.new(start_month: 10, end_month: 12)
 Repeatable::Expression::RangeInYear.new(start_month: 10, end_month: 12, start_day: 1, end_day: 20)
 ```
 
+#### Schedule Errors
+
+If something in the argument passed into `Repeatable::Schedule.new` can't be handled by the `Schedule` or `Parser` (e.g. an expression hash key that doesn't match an existing expression class), a `Repeatable::ParseError` will be raised with a (hopefully) helpful error message.
+
 ### Getting information from a Schedule
 
-Ask a schedule one of three questions.
+Ask a schedule to do a number of things.
 
 ```ruby
 schedule.next_occurrence
   # => Date of next occurrence
 
+# By default, it will find the next occurrence after Date.today.
+# You can also specify a start date.
+schedule.next_occurrence(Date.new(2015, 1, 1))
+  # => Date of next occurrence after Jan 1, 2015
+
+# You also have the option of including the start date as a possible result.
+schedule.next_occurrence(Date.new(2015, 1, 1), include_start: true)
+  # => Date of next occurrence on or after Jan 1, 2015
+
+# By default, searches for the next occurrence are limited to the next 36,525 days (about 100 years).
+# That limit can also be specified in number of days.
+schedule.next_occurrence(limit: 365)
+  # => Date of next occurrence within the next 365 days
+
 schedule.occurrences(Date.new(2015, 1, 1), Date.new(2016, 6, 30))
   # => Dates of all occurrences between Jan 1, 2015 and June 30, 2016
 
@@ -117,7 +135,7 @@ schedule.include?(Date.new(2015, 10, 10))
 
 schedule.to_h
   # => Hash representation of the Schedule, which is useful for storage and
-  #    can be used to recreating an identical Schedule object at a later time
+  #    can be used to recreate an identical Schedule object at a later time
 ```
 
 ## Development

data/lib/repeatable/schedule.rb

@@ -9,22 +9,30 @@ module Repeatable
       when Hash
         @expression = Parser.call(arg)
       else
-        fail(ArgumentError, "Can't build a Repeatable::Schedule from #{arg.class}")
+        fail(ParseError, "Can't build a Repeatable::Schedule from #{arg.class}")
       end
     end
 
     def occurrences(start_date, end_date)
       start_date = Date(start_date)
       end_date = Date(end_date)
+
+      fail(ArgumentError, 'end_date must be equal to or after start_date') if end_date < start_date
+
       (start_date..end_date).select { |date| include?(date) }
     end
 
-    def next_occurrence(start_date = Date.today)
+    def next_occurrence(start_date = Date.today, include_start: false, limit: 36525)
       date = Date(start_date)
-      until include?(date)
+
+      return date if include_start && include?(date)
+
+      1.step do |i|
         date = date.next_day
+
+        break date if include?(date)
+        break if i == limit.to_i
       end
-      date
     end
 
     def include?(date = Date.today)

data/lib/repeatable/version.rb

@@ -1,3 +1,3 @@
 module Repeatable
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repeatable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mo Lawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport