upcoming 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 250bbc397078aab7189913788bfce89c84195389
-  data.tar.gz: 5cdce22ca4d56607b031dddecd961b9e7db3e26b
+  metadata.gz: ccef27184948b16da3feecded92350ac1fe53983
+  data.tar.gz: 00efad8af30f96ffe666be793e581af3d02c40f0
 SHA512:
-  metadata.gz: a40d327bda39041f5f4bc56b5ffedbc11a4fbd690e32074d89df1783ea80063776d10d5c9e935be165a0174cb0456055a645746e32d4b54ed21762463c85a523
-  data.tar.gz: 6b1918388fc8cb9d481780dda93f0bd2e99d0beee033035cd9f9f623a50dbb4b3253cdf182a9ddd7564f4fb7a646803c55c96455a872466514fe35597a86bf16
+  metadata.gz: 27976606835d81a76dfcc4204fe186d880e693db5e056d4e8b86e536ab70dea2d284110544e2d67b03149f54a7c498f1de18fa4da9c7ec0b55185aa7bf3aedc0
+  data.tar.gz: 67c27a1f8a237a102aef6f45250726285633a51d84c0da81f957e855c230f062cd42415883a9706233754a5a5980fa6689c08a6a8e5368180fc85316c7aec9d6

data/README.md

@@ -1,9 +1,46 @@
 # upcoming
 
+[![Gem Version](https://badge.fury.io/rb/upcoming.png)](http://badge.fury.io/rb/upcoming)
 [![Build Status](https://travis-ci.org/sldblog/upcoming.svg)](https://travis-ci.org/sldblog/upcoming)
+[![Code Climate](https://codeclimate.com/github/sldblog/upcoming.png)](https://codeclimate.com/github/sldblog/upcoming)
+[![Dependency Status](https://gemnasium.com/sldblog/upcoming.svg)](https://gemnasium.com/sldblog/upcoming)
 
 Recurring date sequence generator.
 
+## Examples
+
+`Upcoming::Factory.every` will generate sequences using the given method. This uses an enumerator so any number of dates can be queried.
+
+```ruby
+# running on 20th of June, 2014
+> factory = Upcoming::Factory.every(:last_day_of_month)
+=> #<Upcoming::Factory:0xb82fb490 @options={:from=>#<Date: 2014-06-20 ((2456829j,0s,0n),+0s,2299161j)>}, @chain=[#<Upcoming::LastDayOfMonthGenerator:0xb82fb094>]>
+
+> factory.first
+=> #<Date: 2014-06-30 ((2456839j,0s,0n),+0s,2299161j)>
+
+> factory.take(12).map(&:iso8601)
+=> ["2014-06-30", "2014-07-31", "2014-08-31", "2014-09-30", "2014-10-31", "2014-11-30", "2014-12-31", "2015-01-31", "2015-02-28", "2015-03-31", "2015-04-30", "2015-05-31"]
+```
+
+It is possible to chain methods together. Running sequentially, the methods will first test whether the date given for them is valid and if it is not, alter the previous result. Any number of chains can be added.
+
+```ruby
+> factory.then_find_first(:working_day).take(12).map(&:iso8601)
+=> ["2014-06-30", "2014-07-31", "2014-09-01", "2014-09-30", "2014-10-31", "2014-12-01", "2014-12-31", "2015-02-02", "2015-03-02", "2015-03-31", "2015-04-30", "2015-06-01"]
+```
+
+Chaining backwards:
+
+```ruby
+> Upcoming::Factory.every(:last_day_of_month, from: '2014-08-20').then_find_latest(:working_day).first
+=> 2014-08-29
+```
+
+## Generators
+
+The available generators are in `lib/upcoming/generators`. They are mapped to the symbol by converting snake case to camel case and postfixing `Generator`. They can be anywhere in the load path.
+
 ## License
 
 MIT

data/lib/upcoming/factory.rb

@@ -4,36 +4,52 @@ require 'active_support/core_ext/string'
 module Upcoming
   class Factory
     include Enumerable
-    attr_reader :options
 
     def initialize(options = {})
       @options = parse(options)
+      @chain = []
+    end
+
+    def self.every(method, options = {})
+      new(options).then_find_first(method)
+    end
+
+    def then_find_first(method)
+      @chain << create_generator(method, :first)
+      self
+    end
+
+    def then_find_latest(method)
+      @chain << create_generator(method, :latest)
+      self
     end
 
     def each
       from = @options[:from]
-      generator = Upcoming.const_get("#{@options[:every].to_s.classify}Generator").new
-      (1..Float::INFINITY).each do |n|
-        date = generator.next(from)
-        yield date
-        from = date
+      while true do
+        from += 1
+        next_date = @chain.first.step(from)
+        yield @chain[1..-1].inject(next_date) { |date, generator| generator.step(date) }
+        from = next_date
       end
     end
 
     private
 
     def parse(options)
-      options.dup.tap do |result|
-        result[:every] ||= :day
-        result[:from] ||= :today
-
-        if result[:from].is_a? String
-          iso = result[:from] =~ /\d{4}-\d{2}-\d{2}/
-          raise ArgumentError, 'Please use ISO dates (YYYY-MM-DD) as those are not ambigious.' unless iso
-          result[:from] = Date.parse(result[:from])
-        end
-        result[:from] = Date.today if result[:from] == :today
+      options[:from] ||= Date.today
+      if options[:from].is_a? String
+        iso = options[:from] =~ /\d{4}-\d{2}-\d{2}/
+        raise ArgumentError, 'Please use ISO dates (YYYY-MM-DD) as those are not ambigious.' unless iso
       end
+      options[:from] = options[:from].to_date if options[:from].respond_to? :to_date
+      options
+    end
+
+    def create_generator(name, direction)
+      class_name = name.to_s.classify + 'Generator'
+      generator_class = Upcoming.const_get class_name
+      generator_class.new(choose: direction)
     end
 
   end

data/lib/upcoming/generators/generator.rb

@@ -0,0 +1,24 @@
+require 'active_support/core_ext/string'
+
+module Upcoming
+  class Generator
+
+    attr_reader :choose
+
+    def initialize(options = {})
+      @choose = options.fetch(:choose, :first)
+    end
+
+    def step(from)
+      date_range(from).find { |date| valid?(date) }
+    end
+
+    private
+
+    def date_range(date)
+      return date.downto(date.prev_year) if choose == :latest
+      date.upto(date.next_year)
+    end
+
+  end
+end

data/lib/upcoming/generators/last_day_of_month_generator.rb

@@ -0,0 +1,7 @@
+module Upcoming
+  class LastDayOfMonthGenerator < Generator
+    def valid?(date)
+      (date + 1).month != date.month
+    end
+  end
+end

data/lib/upcoming/generators/working_day_generator.rb

@@ -1,11 +1,9 @@
 module Upcoming
-  class WorkingDayGenerator
+  class WorkingDayGenerator < Generator
     WEEKDAYS = (1..5)
 
-    def next(from)
-      date = from + 1
-      date += 1 until WEEKDAYS.include?(date.wday)
-      date
+    def valid?(date)
+      WEEKDAYS.include? date.wday
     end
   end
 end

data/lib/upcoming/upcoming.rb

@@ -1,5 +1,2 @@
 module Upcoming
-  def self.for(config = {})
-    Upcoming::Factory.new(config)
-  end
 end

data/lib/upcoming/version.rb

@@ -1,3 +1,3 @@
 module Upcoming
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/upcoming.rb

@@ -2,6 +2,7 @@ require 'upcoming/version'
 require 'upcoming/factory'
 require 'upcoming/upcoming'
 
+require 'upcoming/generators/generator'
 Dir[File.join(File.dirname(__FILE__), 'upcoming', 'generators', '**/*.rb')].each do |generator|
   require generator
 end

data/spec/factory_spec.rb

@@ -2,70 +2,87 @@ require 'spec_helper'
 
 describe Upcoming::Factory do
 
-  let(:today) { Date.today }
-
-  context 'generates any number of dates' do
-    Given(:upcoming) { Upcoming::Factory.new }
-    Then { upcoming.take(2).size == 2 }
-    And { upcoming.take(20).size == 20 }
+  class Upcoming::FizzGenerator < Upcoming::Generator
+    def valid?(date)
+      date.day % 3 == 0
+    end
   end
 
-  context 'configuration' do
-    When(:upcoming) { Upcoming::Factory.new(config) }
-    When(:options) { upcoming.options }
+  class Upcoming::BuzzGenerator < Upcoming::Generator
+    def valid?(date)
+      date.day % 5 == 0
+    end
+  end
 
-    context 'defaults to daily recurrence from today' do
-      Given(:config) { {} }
-      Then { options == {every: :day, from: today} }
+  Given(:fixed_date) { Date.parse('2014-06-15') }
+  When(:result) do
+    Date.stub :today, fixed_date do
+      subject.take(3).map(&:iso8601)
     end
+  end
 
-    context 'options is configured through constructor' do
-      Given(:config) { {every: :bazooka, from: :other} }
-      Then { options == config }
+  context 'must be enumerable' do
+    Given(:subject) { Upcoming::Factory.every(:fizz) }
+    Then { subject.class.include? Enumerable }
+    Then { subject.respond_to? :each }
+  end
+
+  context '#every' do
+    context 'generates a sequence of days matching method given' do
+      Given(:subject) { Upcoming::Factory.every(:fizz) }
+      Then { result == %w(2014-06-18 2014-06-21 2014-06-24) }
     end
 
-    context 'dates' do
-      context 'from dates other than strings are copied as-is' do
-        Given(:config) { {from: 42} }
-        Then { options[:from] == 42 }
+    context 'generates a sequence from the given start date' do
+      Given(:subject) { Upcoming::Factory.every(:fizz, from: date) }
+
+      context 'given as ISO date' do
+        Given(:date) { '2014-06-20' }
+        Then { result == %w(2014-06-21 2014-06-24 2014-06-27) }
       end
 
-      context 'from date can be given as Date' do
-        Given(:config) { {from: Date.parse('2001-10-10')} }
-        Then { options[:from] == config[:from] }
+      context 'given as Date object' do
+        Given(:date) { Date.parse('2014-05-01') }
+        Then { result == %w(2014-05-03 2014-05-06 2014-05-09) }
       end
 
-      context 'string ISO dates are converted automatically' do
-        Given(:config) { {from: '2000-01-01'} }
-        Then { options[:from] == Date.parse('2000-01-01') }
+      context 'given something responding to :to_date' do
+        Given(:date) { OpenStruct.new(to_date: Date.parse('2014-08-17')) }
+        Then { result == %w(2014-08-18 2014-08-21 2014-08-24) }
       end
 
-      context 'non-ISO strings raise ambiguity error' do
-        Given(:config) { {from: '12/01/2000'} }
-        Then { upcoming.must_raise ArgumentError, /Please use ISO dates (YYYY-MM-DD) as those are not ambigious./ }
+      context 'generates error if given as non-ISO date' do
+        Given(:date) { '01/05/2014' }
+        Then { result == Failure(ArgumentError, /Please use ISO dates \(YYYY-MM-DD\) as those are not ambigious/) }
       end
     end
   end
 
-  context 'execution' do
-    module Upcoming
-      class DeepThoughtGenerator
-        def next(from)
-          from + 42
-        end
+  context 'chained generators' do
+    class Upcoming::MonthAgoIfTwentyFifthGenerator < Upcoming::Generator
+      def step(date)
+        return date.prev_month if date.day == 25
+        date
       end
     end
 
-    Given(:upcoming) { Upcoming::Factory.new(every: :deep_thought) }
+    context 'chains do not alter main sequence' do
+      Given(:subject) { Upcoming::Factory.every(:buzz).then_find_latest(:month_ago_if_twenty_fifth) }
+      Then { result == %w(2014-06-20 2014-05-25 2014-06-30) }
+    end
 
-    context 'invokes generator based on the name of "every" parameter' do
-      When(:result) { upcoming.first }
-      Then { result == today + 42 }
+    context '#then_find_first' do
+      context 'modifies date found by moving to the next date that is a match' do
+        Given(:subject) { Upcoming::Factory.every(:buzz).then_find_first(:fizz) }
+        Then { result == %w(2014-06-21 2014-06-27 2014-06-30) }
+      end
     end
 
-    context 'invokes generator with previous result iteratively' do
-      When(:result) { upcoming.take(3) }
-      Then { result == [today + 42, today + 84, today + 126] }
+    context '#then_find_latest' do
+      context 'modifies date found by moving to the previous date that is a match' do
+        Given(:subject) { Upcoming::Factory.every(:buzz).then_find_latest(:fizz) }
+        Then { result == %w(2014-06-18 2014-06-24 2014-06-30) }
+      end
     end
   end
 

data/spec/generators/generator_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Upcoming::Generator do
+
+  class Upcoming::FakeGenerator < Upcoming::Generator
+    def initialize(options = {})
+      super
+      @valid_dates = {}
+    end
+
+    def make_valid(date)
+      @valid_dates[Date.parse(date)] = true
+    end
+
+    def valid?(date)
+      @valid_dates[date]
+    end
+  end
+
+  def step(date)
+    result = subject.step(Date.parse(date))
+    result and result.iso8601
+  end
+
+  Given(:subject) { Upcoming::FakeGenerator.new }
+
+  context 'returns the same date if it is valid' do
+    Given(:start_date) { '2014-05-19' }
+    When { subject.make_valid(start_date) }
+    Then { step(start_date) == start_date }
+  end
+
+  context 'forward in time' do
+    context 'returns the first valid date, checking all dates in sequence' do
+      When { subject.make_valid('2014-05-20') }
+      When { subject.make_valid('2014-06-20') }
+      Then { step('2014-05-19') == '2014-05-20' }
+      Then { step('2014-05-21') == '2014-06-20' }
+      Then { step('2014-06-10') == '2014-06-20' }
+    end
+
+    context 'returns nil if there is no valid date within 1 year' do
+      # implement a custom +step+ method in your generator if you need this
+      When { subject.make_valid('2020-01-01') }
+      Then { step('2018-12-31') == nil }
+      Then { step('2019-01-01') == '2020-01-01' }
+    end
+  end
+
+  context 'backward in time' do
+    Given(:subject) { Upcoming::FakeGenerator.new(choose: :latest) }
+
+    context 'returns the closest past date, checking all dates in sequence' do
+      When { subject.make_valid('2010-03-04') }
+      When { subject.make_valid('2010-09-21') }
+      Then { step('2010-09-22') == '2010-09-21' }
+      Then { step('2010-09-20') == '2010-03-04' }
+      Then { step('2010-06-01') == '2010-03-04' }
+    end
+
+    context 'returns nil if there is no valid date within -1 year' do
+      # implement a custom +step+ method in your generator if you need this
+      When { subject.make_valid('2010-01-01') }
+      Then { step('2011-01-02') == nil }
+      Then { step('2011-01-01') == '2010-01-01' }
+    end
+  end
+
+end

data/spec/generators/last_day_of_month_generator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Upcoming::LastDayOfMonthGenerator do
+
+  Given(:subject) { Upcoming::LastDayOfMonthGenerator.new }
+  When(:valid) { subject.valid?(date) }
+
+  context 'not valid on not last day of month' do
+    Given(:date) { Date.parse('2014-06-15') }
+    Then { !valid }
+  end
+
+  context 'valid on last day of month' do
+    Given(:date) { Date.parse('2014-05-31') }
+    Then { valid }
+  end
+
+  context 'valid on leap day' do
+    Given(:date) { Date.parse('2012-02-29') }
+    Then { valid }
+  end
+
+end

data/spec/generators/working_day_generator_spec.rb

@@ -4,15 +4,12 @@ describe Upcoming::WorkingDayGenerator do
 
   Given(:subject) { Upcoming::WorkingDayGenerator.new }
 
-  context 'returns upcoming Monday when Friday, Saturday or Sunday are given' do
-    Given(:friday) { Date.parse('2014-06-13') }
+  context 'returns invalid for weekends' do
     Given(:saturday) { Date.parse('2014-06-14') }
     Given(:sunday) { Date.parse('2014-06-15') }
-    Given(:monday) { Date.parse('2014-06-16') }
 
-    Then { subject.next(friday) == monday }
-    Then { subject.next(saturday) == monday }
-    Then { subject.next(sunday) == monday }
+    Then { !subject.valid?(saturday) }
+    Then { !subject.valid?(sunday) }
   end
 
   context 'returns next workday when given workday' do
@@ -22,10 +19,11 @@ describe Upcoming::WorkingDayGenerator do
     Given(:thursday) { wednesday + 1 }
     Given(:friday) { thursday + 1 }
 
-    Then { subject.next(monday) == tuesday }
-    Then { subject.next(tuesday) == wednesday }
-    Then { subject.next(wednesday) == thursday }
-    Then { subject.next(thursday) == friday }
+    Then { subject.valid?(monday) }
+    Then { subject.valid?(tuesday) }
+    Then { subject.valid?(wednesday) }
+    Then { subject.valid?(thursday) }
+    Then { subject.valid?(friday) }
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upcoming
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - David Lantos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,12 +65,14 @@ files:
 - Rakefile
 - lib/upcoming.rb
 - lib/upcoming/factory.rb
-- lib/upcoming/generators/day_generator.rb
+- lib/upcoming/generators/generator.rb
+- lib/upcoming/generators/last_day_of_month_generator.rb
 - lib/upcoming/generators/working_day_generator.rb
 - lib/upcoming/upcoming.rb
 - lib/upcoming/version.rb
 - spec/factory_spec.rb
-- spec/generators/day_generator_spec.rb
+- spec/generators/generator_spec.rb
+- spec/generators/last_day_of_month_generator_spec.rb
 - spec/generators/working_day_generator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sldblog/upcoming
@@ -99,6 +101,7 @@ specification_version: 4
 summary: Recurring date generator
 test_files:
 - spec/factory_spec.rb
-- spec/generators/day_generator_spec.rb
+- spec/generators/generator_spec.rb
+- spec/generators/last_day_of_month_generator_spec.rb
 - spec/generators/working_day_generator_spec.rb
 - spec/spec_helper.rb

data/lib/upcoming/generators/day_generator.rb

@@ -1,7 +0,0 @@
-module Upcoming
-  class DayGenerator
-    def next(from)
-      from + 1
-    end
-  end
-end

data/spec/generators/day_generator_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe Upcoming::DayGenerator do
-
-  Given(:subject) { Upcoming::DayGenerator.new }
-
-  context 'returns the following day' do
-    When(:result) { subject.next(Date.parse('2001-12-31')) }
-    Then { result == Date.parse('2002-01-01') }
-  end
-
-end