nextday 0.2.0 → 0.3.0

data/.gitignore

@@ -3,4 +3,5 @@
 Gemfile.lock
 pkg/*
 .yardoc
-doc/
+doc/
+coverage

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+ - 1.9.3

data/Gemfile

@@ -2,14 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in nextday.gemspec
 gemspec
-
-gem 'rake'
-
-require 'rbconfig'
-
-if RbConfig::CONFIG['target_os'] =~ /darwin/i
-  gem 'rb-fsevent', '>= 0.4.0', :require => false
-  gem 'growl_notify', :require => false
-  gem 'guard', '~> 0.6.0', :require => false
-  gem 'guard-rspec', '~> 0.4.0', :require => false
-end

data/README.md

@@ -1,5 +1,7 @@
 # Nextday
 
+[![Build Status](https://secure.travis-ci.org/robwilliams/nextday.png?branch=master)](http://travis-ci.org/robwilliams/nextday)
+
 Finds the Next Working Day even if holidays are in the way.
 
 Extends ```Date```, ```Time``` and ```DateTime``` to allow you to find the next working day
@@ -29,6 +31,28 @@ DateTime.today.working_day?
 Time.now.working_day?
 ```
 
+### When will an item be despatched?
+```ruby
+Date.today.despatch_day
+DateTime.today.despatch_day
+Time.now.despatch_day
+```
+
+### When will an item be delivered?
+```ruby
+Date.today.delivery_day
+DateTime.today.delivery_day
+Time.now.delivery_day
+```
+
+## Configuration
+
+To set the cut off time to a different value:
+
+```ruby
+Nextday::Config.cut_off_time = "18:47"
+```
+
 ## Installation
 
 To use with bundler add nextday to your gem file.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/nextday/config.rb

@@ -1,5 +1,8 @@
 module Nextday
-  
+ 
+  ##
+  # The time a warehouse or other shop closes. Used
+  # to specify which day an item will be despatched.
   CUT_OFF_TIME = "16:00"
   
   class Config
@@ -20,4 +23,4 @@ module Nextday
       end
     end
   end
-end
+end

data/lib/nextday/date_extension.rb

@@ -1,9 +1,12 @@
 module Nextday
-  
   module DateExtension
-    
     ##
+    # The day an item or service will be despatched.
+    # If the warehouse closes at say 4:00pm then this will
+    # be taken into account and the despatch day will be the 
+    # next working day.
     #
+    # @return [Date] 
     def despatch_day
       if working_day?
         if to_time < cut_off_time
@@ -15,29 +18,33 @@ module Nextday
         next_working_day
       end
     end
-    
+
+    ##
+    # The next working day after an item has been despatched.
+    #
+    # @return [Date]
     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 = to_date + 1
-    
+
       # keep going until the next day is a working day
       while !next_day.working_day?
         next_day = next_day + 1  
       end
-      
+
       next_day
     end
 
@@ -47,12 +54,12 @@ module Nextday
     # @return [Date] Previous Working Day
     def previous_working_day
       previous_day = to_date - 1
-    
+
       # keep going until the next day is a working day
       while !previous_day.working_day?
         previous_day = previous_day - 1  
       end
-      
+
       previous_day
     end
 
@@ -63,7 +70,7 @@ module Nextday
     def working_day?
       !weekend? and !public_holiday?
     end
-    
+
     ##
     # Is the current date a public holiday?
     #
@@ -71,7 +78,7 @@ module Nextday
     def public_holiday?
       Holidays.dates.include?(to_date)
     end
-    
+
     ##
     # Is the current date on the weekend?
     #
@@ -79,21 +86,5 @@ module Nextday
     def weekend?
       saturday? or sunday?
     end
-    
-    ##
-    # Is the current date a saturday?
-    #
-    # @return [Boolean]
-    def saturday?
-      to_date.wday == 6
-    end if RUBY_VERSION < '1.9'
-    
-    ##
-    # Is the current date a saturday?
-    #
-    # @return [Boolean]
-    def sunday?
-      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.2.0"
+  VERSION = "0.3.0"
 end

data/nextday.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency('rspec', '~> 2.6.0')
+  s.add_development_dependency('rspec', '~> 2.10.0')
   s.add_development_dependency('yard')
+  s.add_development_dependency('rake')
   # s.add_runtime_dependency "rest-client"
 end

data/spec/spec_helper.rb

@@ -30,4 +30,4 @@ def sundays
   sunday = today
   
   sunday.step(sunday + 365, 7).to_a
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nextday
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-14 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70211612224480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70211612224480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70211612224060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211612224060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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:
@@ -43,8 +69,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- Guardfile
 - README.md
 - Rakefile
 - lib/nextday.rb
@@ -74,15 +100,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 798981716380311647
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 798981716380311647
 requirements: []
 rubyforge_project: nextday
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Finds the Next Working Day even if holidays are in the way.
@@ -92,3 +124,4 @@ test_files:
 - spec/lib/nextday/holiday_spec.rb
 - spec/lib/nextday/holidays_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'rspec', :version => 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^spec/support/.+\.rb$}) { "spec/" }
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec/" }
-end