upcoming 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 250bbc397078aab7189913788bfce89c84195389
+  data.tar.gz: 5cdce22ca4d56607b031dddecd961b9e7db3e26b
+SHA512:
+  metadata.gz: a40d327bda39041f5f4bc56b5ffedbc11a4fbd690e32074d89df1783ea80063776d10d5c9e935be165a0174cb0456055a645746e32d4b54ed21762463c85a523
+  data.tar.gz: 6b1918388fc8cb9d481780dda93f0bd2e99d0beee033035cd9f9f623a50dbb4b3253cdf182a9ddd7564f4fb7a646803c55c96455a872466514fe35597a86bf16

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (C) 2014 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# upcoming
+
+[![Build Status](https://travis-ci.org/sldblog/upcoming.svg)](https://travis-ci.org/sldblog/upcoming)
+
+Recurring date sequence generator.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb', 'spec/**/*_helper.rb']
+end
+
+task :default => [:test]

data/lib/upcoming/factory.rb

@@ -0,0 +1,40 @@
+require 'date'
+require 'active_support/core_ext/string'
+
+module Upcoming
+  class Factory
+    include Enumerable
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = parse(options)
+    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
+      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
+      end
+    end
+
+  end
+end

data/lib/upcoming/generators/day_generator.rb

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

data/lib/upcoming/generators/working_day_generator.rb

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

data/lib/upcoming/upcoming.rb

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

data/lib/upcoming/version.rb

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

data/lib/upcoming.rb

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

data/spec/factory_spec.rb

@@ -0,0 +1,72 @@
+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 }
+  end
+
+  context 'configuration' do
+    When(:upcoming) { Upcoming::Factory.new(config) }
+    When(:options) { upcoming.options }
+
+    context 'defaults to daily recurrence from today' do
+      Given(:config) { {} }
+      Then { options == {every: :day, from: today} }
+    end
+
+    context 'options is configured through constructor' do
+      Given(:config) { {every: :bazooka, from: :other} }
+      Then { options == config }
+    end
+
+    context 'dates' do
+      context 'from dates other than strings are copied as-is' do
+        Given(:config) { {from: 42} }
+        Then { options[:from] == 42 }
+      end
+
+      context 'from date can be given as Date' do
+        Given(:config) { {from: Date.parse('2001-10-10')} }
+        Then { options[:from] == config[:from] }
+      end
+
+      context 'string ISO dates are converted automatically' do
+        Given(:config) { {from: '2000-01-01'} }
+        Then { options[:from] == Date.parse('2000-01-01') }
+      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./ }
+      end
+    end
+  end
+
+  context 'execution' do
+    module Upcoming
+      class DeepThoughtGenerator
+        def next(from)
+          from + 42
+        end
+      end
+    end
+
+    Given(:upcoming) { Upcoming::Factory.new(every: :deep_thought) }
+
+    context 'invokes generator based on the name of "every" parameter' do
+      When(:result) { upcoming.first }
+      Then { result == today + 42 }
+    end
+
+    context 'invokes generator with previous result iteratively' do
+      When(:result) { upcoming.take(3) }
+      Then { result == [today + 42, today + 84, today + 126] }
+    end
+  end
+
+end

data/spec/generators/day_generator_spec.rb

@@ -0,0 +1,12 @@
+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

data/spec/generators/working_day_generator_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+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') }
+    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 }
+  end
+
+  context 'returns next workday when given workday' do
+    Given(:monday) { Date.parse('2014-06-16') }
+    Given(:tuesday) { monday + 1 }
+    Given(:wednesday) { tuesday + 1 }
+    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 }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/given'
+
+require 'upcoming'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: upcoming
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Lantos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate recurring dates based on slightly more complex rules than usual
+  (eg. last working day every month)
+email:
+- david.lantos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/upcoming.rb
+- lib/upcoming/factory.rb
+- lib/upcoming/generators/day_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/working_day_generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sldblog/upcoming
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Recurring date generator
+test_files:
+- spec/factory_spec.rb
+- spec/generators/day_generator_spec.rb
+- spec/generators/working_day_generator_spec.rb
+- spec/spec_helper.rb