upcoming 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccef27184948b16da3feecded92350ac1fe53983
-  data.tar.gz: 00efad8af30f96ffe666be793e581af3d02c40f0
+  metadata.gz: f262a85c40d0c408b913135974601da00d4d89d1
+  data.tar.gz: 6dbac7937346f821d7c0aa7611d7f1d5954b7a00
 SHA512:
-  metadata.gz: 27976606835d81a76dfcc4204fe186d880e693db5e056d4e8b86e536ab70dea2d284110544e2d67b03149f54a7c498f1de18fa4da9c7ec0b55185aa7bf3aedc0
-  data.tar.gz: 67c27a1f8a237a102aef6f45250726285633a51d84c0da81f957e855c230f062cd42415883a9706233754a5a5980fa6689c08a6a8e5368180fc85316c7aec9d6
+  metadata.gz: 1be5ca77077ce49852a700796164db3cd94611e535fa81139fa69db513257baeab5db0dd80b61273a34e59658a3d00b5f3d74065e7120996b51a027a68e4c932
+  data.tar.gz: 746ef6accdd1c981004b49819d61cd0796297abbc925d9e92a6716efc4cae621c6b353abeb11a3dcce50325adefe60199a73f429b2f262215c0f00e6a736ecb5

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (C) 2014 David Lantos
+Copyright (C) 2014-2016 David Lantos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,6 +1,6 @@
 # upcoming
 
-[![Gem Version](https://badge.fury.io/rb/upcoming.png)](http://badge.fury.io/rb/upcoming)
+[![Gem Version](https://badge.fury.io/rb/upcoming.svg)](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)
@@ -14,27 +14,48 @@ Recurring date sequence generator.
 ```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>]>
+=> #<Upcoming::Factory:0xb8ba6838 @options={:from=>#<Date: 2014-06-20 ((2456829j,0s,0n),+0s,2299161j)>},
+     @chain=[#<Upcoming::LastDayOfMonthGenerator:0xb8ba6310 @choose=:first>]>
 
 > 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"]
+=> ["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.
+It is possible to chain methods together. Any number of chains can be added.
+
+Chaining forward in time is done via `then_find_upcoming`:
+
+```ruby
+> Upcoming::Factory.every(:last_day_of_month).then_find_upcoming(: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"]
+```
+
+Stepping backwards in time is done via `then_find_preceding`:
 
 ```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"]
+> Upcoming::Factory.every(:last_day_of_month, from: '2014-08-20').then_find_preceding(:working_day).first
+=> #<Date: 2014-08-29 ((2456899j,0s,0n),+0s,2299161j)>
 ```
 
-Chaining backwards:
+Chaining the same method has no effect:
 
 ```ruby
-> Upcoming::Factory.every(:last_day_of_month, from: '2014-08-20').then_find_latest(:working_day).first
-=> 2014-08-29
+Upcoming::Factory.every(:last_day_of_month, from: '2014-06-20')
+  .then_find_upcoming(:working_day)
+  .take(3).map(&:iso8601)
+=> ["2014-06-30", "2014-07-31", "2014-09-01"]
+
+Upcoming::Factory.every(:last_day_of_month, from: '2014-06-20')
+  .then_find_upcoming(:working_day)
+  .then_find_upcoming(:working_day)
+  .then_find_upcoming(:working_day)
+  .take(3).map(&:iso8601)
+=> ["2014-06-30", "2014-07-31", "2014-09-01"]
 ```
 
 ## Generators

data/lib/upcoming/factory.rb

@@ -11,16 +11,16 @@ module Upcoming
     end
 
     def self.every(method, options = {})
-      new(options).then_find_first(method)
+      new(options).then_find_upcoming(method)
     end
 
-    def then_find_first(method)
-      @chain << create_generator(method, :first)
+    def then_find_upcoming(method)
+      @chain << create_generator(method, :upcoming)
       self
     end
 
-    def then_find_latest(method)
-      @chain << create_generator(method, :latest)
+    def then_find_preceding(method)
+      @chain << create_generator(method, :preceding)
       self
     end
 
@@ -51,6 +51,5 @@ module Upcoming
       generator_class = Upcoming.const_get class_name
       generator_class.new(choose: direction)
     end
-
   end
 end

data/lib/upcoming/generators/generator.rb

@@ -1,12 +1,9 @@
-require 'active_support/core_ext/string'
-
 module Upcoming
   class Generator
-
     attr_reader :choose
 
     def initialize(options = {})
-      @choose = options.fetch(:choose, :first)
+      @choose = options.fetch(:choose, :upcoming)
     end
 
     def step(from)
@@ -16,9 +13,8 @@ module Upcoming
     private
 
     def date_range(date)
-      return date.downto(date.prev_year) if choose == :latest
+      return date.downto(date.prev_year) if choose == :preceding
       date.upto(date.next_year)
     end
-
   end
 end

data/lib/upcoming/version.rb

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

data/spec/factory_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Upcoming::Factory do
-
   class Upcoming::FizzGenerator < Upcoming::Generator
     def valid?(date)
       date.day % 3 == 0
@@ -67,23 +66,22 @@ describe Upcoming::Factory do
     end
 
     context 'chains do not alter main sequence' do
-      Given(:subject) { Upcoming::Factory.every(:buzz).then_find_latest(:month_ago_if_twenty_fifth) }
+      Given(:subject) { Upcoming::Factory.every(:buzz).then_find_preceding(:month_ago_if_twenty_fifth) }
       Then { result == %w(2014-06-20 2014-05-25 2014-06-30) }
     end
 
-    context '#then_find_first' do
+    context '#then_find_upcoming' 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) }
+        Given(:subject) { Upcoming::Factory.every(:buzz).then_find_upcoming(:fizz) }
         Then { result == %w(2014-06-21 2014-06-27 2014-06-30) }
       end
     end
 
-    context '#then_find_latest' do
+    context '#then_find_preceding' 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) }
+        Given(:subject) { Upcoming::Factory.every(:buzz).then_find_preceding(:fizz) }
         Then { result == %w(2014-06-18 2014-06-24 2014-06-30) }
       end
     end
   end
-
 end

data/spec/generators/generator_spec.rb

@@ -1,14 +1,13 @@
 require 'spec_helper'
 
 describe Upcoming::Generator do
-
   class Upcoming::FakeGenerator < Upcoming::Generator
     def initialize(options = {})
       super
       @valid_dates = {}
     end
 
-    def make_valid(date)
+    def mark_as_valid(date)
       @valid_dates[Date.parse(date)] = true
     end
 
@@ -22,18 +21,22 @@ describe Upcoming::Generator do
     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 }
+  def self.returns_the_starting_date_if_it_is_valid
+    context 'returns the starting date if it is valid' do
+      Given(:start_date) { '2014-05-19' }
+      When { subject.mark_as_valid(start_date) }
+      Then { step(start_date) == start_date }
+    end
   end
 
   context 'forward in time' do
+    Given(:subject) { Upcoming::FakeGenerator.new(choose: :upcoming) }
+
+    returns_the_starting_date_if_it_is_valid
+
     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') }
+      When { subject.mark_as_valid('2014-05-20') }
+      When { subject.mark_as_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' }
@@ -41,18 +44,20 @@ describe Upcoming::Generator do
 
     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') }
+      When { subject.mark_as_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) }
+    Given(:subject) { Upcoming::FakeGenerator.new(choose: :preceding) }
+
+    returns_the_starting_date_if_it_is_valid
 
     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') }
+      When { subject.mark_as_valid('2010-03-04') }
+      When { subject.mark_as_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' }
@@ -60,10 +65,9 @@ describe Upcoming::Generator do
 
     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') }
+      When { subject.mark_as_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

@@ -1,23 +1,26 @@
 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
+  context 'start of the month is invalid' do
+    Given(:date) { Date.parse('2014-06-01') }
+    Then { !valid }
+  end
+
+  context 'middle of the month is invalid' do
     Given(:date) { Date.parse('2014-06-15') }
     Then { !valid }
   end
 
-  context 'valid on last day of month' do
+  context 'last day of the month is valid' do
     Given(:date) { Date.parse('2014-05-31') }
     Then { valid }
   end
 
-  context 'valid on leap day' do
+  context 'last day of February in a leap year is valid' do
     Given(:date) { Date.parse('2012-02-29') }
     Then { valid }
   end
-
 end

data/spec/generators/working_day_generator_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
 describe Upcoming::WorkingDayGenerator do
-
   Given(:subject) { Upcoming::WorkingDayGenerator.new }
 
-  context 'returns invalid for weekends' do
+  context 'weekends are invalid' do
     Given(:saturday) { Date.parse('2014-06-14') }
     Given(:sunday) { Date.parse('2014-06-15') }
 
@@ -12,7 +11,7 @@ describe Upcoming::WorkingDayGenerator do
     Then { !subject.valid?(sunday) }
   end
 
-  context 'returns next workday when given workday' do
+  context 'weekdays are valid' do
     Given(:monday) { Date.parse('2014-06-16') }
     Given(:tuesday) { monday + 1 }
     Given(:wednesday) { tuesday + 1 }
@@ -25,5 +24,4 @@ describe Upcoming::WorkingDayGenerator do
     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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Lantos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Recurring date generator