nextday 0.0.1 → 0.1.0

data/README.md

@@ -2,7 +2,7 @@
 
 Finds the Next Working Day even if holidays are in the way.
 
-Extends ```Date``` to allow you to find the next working day
+Extends ```Date```, ```Time``` and ```DateTime``` to allow you to find the next working day
 
 Nextday only checks for English public holidays at the moment, I aim to extend it to support locales in the near future.
 
@@ -10,16 +10,10 @@ Nextday only checks for English public holidays at the moment, I aim to extend i
 
 ```ruby
 Date.today.next_working_day
+DateTime.today.next_working_day
+Time.now.next_working_day
 ```
 
-To use this with ```DateTime``` and ```Time``` convert to ```Date``` first, for instance.
-
-```ruby
-Time.now.to_date.next_working_day
-DateTime.new(2030,11,30).to_date.next_working_day
-```
-
-
 ## Installation
 
 To use with bundler just add nextday to your gem file.

data/lib/nextday/config.rb

@@ -0,0 +1,23 @@
+module Nextday
+  
+  CUT_OFF_TIME = "16:00"
+  
+  class Config
+    
+    class << self
+      attr_writer :cut_off_time
+      
+      def cut_off_time
+        @cut_off_time || CUT_OFF_TIME
+      end
+      
+      def cut_off_hour
+        cut_off_time.split(":")[0].to_i
+      end
+
+      def cut_off_minute
+        cut_off_time.split(":")[1].to_i
+      end
+    end
+  end
+end

data/lib/nextday/core_ext/time.rb

@@ -0,0 +1,3 @@
+class Time
+  include Nextday::DateExtension
+end

data/lib/nextday/date_extension.rb

@@ -1,12 +1,37 @@
 module Nextday
   
   module DateExtension
+    
+    ##
+    #
+    def despatch_day
+      if working_day?
+        if to_time < cut_off_time
+          to_date
+        else
+          next_working_day
+        end
+      else
+        next_working_day
+      end
+    end
+    
+    def delivery_day
+      despatch_day.next_working_day
+    end
+    
+    def cut_off_time
+      hour, minute = Config.cut_off_hour, Config.cut_off_minute
+      
+      Time.new(year, month, day, hour, minute)
+    end
+    
     ##
     # The next working day after the current date
     # 
     # @return [Date] Next Working Day
     def next_working_day
-      next_day = self + 1
+      next_day = to_date + 1
     
       # keep going until the next day is a working day
       while !next_day.working_day?
@@ -29,7 +54,7 @@ module Nextday
     #
     # @return [Boolean] 
     def public_holiday?
-      Holidays.dates.include?(self)
+      Holidays.dates.include?(to_date)
     end
     
     ##
@@ -45,7 +70,7 @@ module Nextday
     #
     # @return [Boolean]
     def saturday?
-      self.wday == 6
+      to_date.wday == 6
     end if RUBY_VERSION < '1.9'
     
     ##
@@ -53,7 +78,7 @@ module Nextday
     #
     # @return [Boolean]
     def sunday?
-      self.wday == 0
+      to_date.wday == 0
     end if RUBY_VERSION < '1.9'
   end
 end

data/lib/nextday/version.rb

@@ -1,3 +1,3 @@
 module Nextday
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/nextday.rb

@@ -1,7 +1,13 @@
+require 'date'
+require 'time'
+
 require "nextday/version"
+require "nextday/config"
+
 require "nextday/holiday"
-require "nextday/public_holidays"
 require "nextday/holidays"
+require "nextday/public_holidays"
 
 require "nextday/date_extension"
-require "nextday/core_ext/date"
+require "nextday/core_ext/time"
+require "nextday/core_ext/date"

data/spec/lib/nextday/config_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../../spec_helper.rb'
+
+describe Nextday::Config do
+
+  subject { Nextday::Config }
+
+  describe "cut_off_time" do
+    
+    describe "default" do
+      it { subject.cut_off_time.should eql(Nextday::CUT_OFF_TIME)}
+    end
+    
+    describe "with a new time" do
+      
+      before do
+        Nextday::Config.cut_off_time = "18:47"
+      end
+      
+      it { subject.cut_off_time.should eql("18:47")}
+    end
+  end
+end

data/spec/lib/nextday/core_ext/date_spec.rb

@@ -2,6 +2,47 @@ require_relative '../../../spec_helper.rb'
 
 describe Date do
   
+  describe "#despatch_day" do
+    
+    describe "before cut_off_time" do
+
+      weekdays.each do |date|
+                # on a Monday..Friday
+        describe "on a #{date.strftime('%A')}" do
+          
+          subject { Time.new(date.year, date.month, date.day, 0, 0).despatch_day.to_date }
+          
+          it "should be the same day" do
+            should eql(date)
+          end
+        end
+      end
+    end
+
+    describe "after_cut_off_time" do
+      weekdays.each do |date|
+                # on a Monday..Friday
+        describe "on a #{date.strftime('%A')}" do
+          
+          subject { Time.new(date.year, date.month, date.day, Nextday::Config.cut_off_hour + 1) }
+          
+          it "should be the next working day" do
+            subject.despatch_day.to_date.should eql(subject.next_working_day)
+          end
+        end
+      end
+    end
+  end
+  
+  describe "#delivery_day" do
+    
+    subject { Time.now.despatch_day }
+    
+    it "should be the next working day after the despatch day" do
+      subject.delivery_day.should eql(subject.despatch_day.next_working_day)
+    end
+  end
+  
   describe "#working_day?" do
     
     describe "on a saturday" do

data/spec/spec_helper.rb

@@ -1,5 +1,15 @@
 require 'nextday'
 
+def weekdays
+  today = Date.today
+  
+  today += 1 while (today.wday != 1) # step forward until it's monday
+  monday = today
+  
+  # monday, tuesday, wednesday, thursday, friday
+  [monday, monday+1, monday+2, monday+3, monday+4]
+end
+
 def weekends
   saturdays + sundays
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nextday
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-01 00:00:00.000000000Z
+date: 2011-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2151822900 !ruby/object:Gem::Requirement
+  requirement: &2152939220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2151822900
+  version_requirements: *2152939220
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152545660 !ruby/object:Gem::Requirement
+  requirement: &2152938800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152545660
+  version_requirements: *2152938800
 description: ! "\n    Finds the Next Working Day even if holidays are in the way.\n
   \   Extends Date with a .next_working_day instance method.\n  "
 email:
@@ -48,13 +48,16 @@ files:
 - README.md
 - Rakefile
 - lib/nextday.rb
+- lib/nextday/config.rb
 - lib/nextday/core_ext/date.rb
+- lib/nextday/core_ext/time.rb
 - lib/nextday/date_extension.rb
 - lib/nextday/holiday.rb
 - lib/nextday/holidays.rb
 - lib/nextday/public_holidays.rb
 - lib/nextday/version.rb
 - nextday.gemspec
+- spec/lib/nextday/config_spec.rb
 - spec/lib/nextday/core_ext/date_spec.rb
 - spec/lib/nextday/holiday_spec.rb
 - spec/lib/nextday/holidays_spec.rb
@@ -79,11 +82,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: nextday
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Finds the Next Working Day even if holidays are in the way.
 test_files:
+- spec/lib/nextday/config_spec.rb
 - spec/lib/nextday/core_ext/date_spec.rb
 - spec/lib/nextday/holiday_spec.rb
 - spec/lib/nextday/holidays_spec.rb