working_hours 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44ded3c576ee838fd8e2a6160499e60f2c7e585e
-  data.tar.gz: 2f1bab0453dd93d3b3cd70d72a829ea8eac82ac4
+  metadata.gz: 1b22e4d023c26a46743000425945952ab1bab9fd
+  data.tar.gz: cbed8ec547a77301003e9dc7ed0686c08f2cac46
 SHA512:
-  metadata.gz: c0b37d42c5460735f2b80e2e92e34d74b1fb0355ad87e0c2ff34d1149418d20e92572a3ec867f4513b2cb486bc0918d40fbf242ab2e398b6f8ef7ed5bcfcc6a3
-  data.tar.gz: 512fdd659f82340e7b1d5b88a564032e27a61f739cd2c5b70947947a78b0cab09201e5492c29455ef2bb7501a0fe04c9595003edc67955aeb3cccff18e9c0107
+  metadata.gz: a63290c01a8c6f78782a7abc917b655e16d97c115f44c1c3a075cfe067ddc8a68a4df7fc609d10ba81beb471e963032b7491df872b0ea372e8585377832b938b
+  data.tar.gz: a65bebd4a98cd33caccd717924166bbc89057f7b0800385cca6902ef2a76a1d5367cda365de1926000f37816f028fbb728154db5ae1d9ac08fe43050e279152f

data/.travis.yml

@@ -3,12 +3,17 @@ rvm:
   - 2.0.0
   - 2.1.3
   - ruby-head
+  - jruby-1.7.19
   - jruby-head
+env: JRUBY_OPTS=--2.0
 gemfile:
   - gemfiles/Gemfile.activesupport-3.2.x
   - gemfiles/Gemfile.activesupport-4.0.x
   - gemfiles/Gemfile.activesupport-4.1.x
+  - gemfiles/Gemfile.activesupport-4.2.x
   - gemfiles/Gemfile.activesupport-edge
 matrix:
   allow_failures:
     - gemfile: gemfiles/Gemfile.activesupport-edge
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 [Compare master with v1.0.3](https://github.com/intrepidd/working_hours/compare/v1.0.3...master)
 
+# v1.0.4
+* Fixed a nasty stack level too deep error on DateTime#+ and DateTime#- (thanks @jlanatta)
+
 # v1.0.3
 
 * Relax configuration input formats - [#10](https://github.com/Intrepidd/working_hours/pull/10)

data/README.md

@@ -71,8 +71,8 @@ WorkingHours::Config.working_hours = {
   :tue => {'09:00' => '12:00', '13:00' => '17:00'},
   :wed => {'09:00' => '12:00', '13:00' => '17:00'},
   :thu => {'09:00' => '12:00', '13:00' => '17:00'},
-  :fri => {'09:00' => '12:00', '13:00' => '17:00'},
-  :sat => {'10:00' => '15:00'}
+  :fri => {'09:00' => '12:00', '13:00' => '17:05:30'},
+  :sat => {'19:00' => '24:00'}
 }
 
 # Configure timezone (uses activesupport, defaults to UTC)
@@ -82,6 +82,19 @@ WorkingHours::Config.time_zone = 'Paris'
 WorkingHours::Config.holidays = [Date.new(2014, 12, 31)]
 ```
 
+Alternatively, you can apply a particular config in a block with the ``with_config`` method :
+
+```ruby
+WorkingHours::Config.with_config(working_hours: {mon:{'09:00' => '18:00'}}, holidays: [], time_zone: 'Paris') do
+  # Intense calculations
+end
+```
+``with_config`` uses keyword arguments, you can pass all or some of the supported arguments :
+- ``working_hours``
+- ``holidays``
+- ``time_zone``
+
+
 ## No core extensions / monkey patching
 
 Core extensions (monkey patching to add methods on Time, Date, Numbers, etc.) are handy but not appreciated by everyone. WorkingHours can also be used **without any monkey patching**:
@@ -133,7 +146,7 @@ require 'working_hours/module'
 class Order
   include WorkingHours
 
-  def shipping_date_estibmate
+  def shipping_date_estimate
     Duration.new(2, :days).since(payment_received_at)
   end
 
@@ -145,12 +158,14 @@ end
 
 ## Timezones
 
-This gem uses a simple but efficient approach in dealing with timezones. When you define your working hours **you have to choose** a timezone associated with it (in the config example, the working hours are in Paris time). Then, any time used in calcultation will be converted to this timezone first, so you don't have to worry if your times are local or UTC as long as they are correct :)
+This gem uses a simple but efficient approach in dealing with timezones. When you define your working hours **you have to choose** a timezone associated with it (in the config example, the working hours are in Paris time). Then, any time used in calculation will be converted to this timezone first, so you don't have to worry if your times are local or UTC as long as they are correct :)
 
 ## Alternatives
 
 There is a gem called [business_time](https://github.com/bokmann/business_time) already available to do this kind of computation and it was of great help to us. But we decided to start another one because business_time is suffering from a few [bugs](https://github.com/bokmann/business_time/pull/84) and [inconsistencies](https://github.com/bokmann/business_time/issues/50). It also lacks essential features to us (like working minutes computation).
 
+Another gem called [biz](https://github.com/zendesk/biz) was released after working_hours to bring some alternative.
+
 ## Contributing
 
 1. Fork it ( http://github.com/intrepidd/working_hours/fork )

data/gemfiles/Gemfile.activesupport-4.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'activesupport', '~> 4.2'

data/lib/working_hours/computation.rb

@@ -39,7 +39,7 @@ module WorkingHours
         config[:working_hours][time.wday].each do |from, to|
           if time_in_day >= from and time_in_day < to
             # take all we can
-            take = [to - time_in_day, seconds].min
+            take = [to - time_in_day, seconds].min.round
             # advance time
             time += take
             # decrease seconds
@@ -55,7 +55,7 @@ module WorkingHours
         config[:working_hours][time.wday].reverse_each do |from, to|
           if time_in_day > from and time_in_day <= to
             # take all we can
-            take = [time_in_day - from, -seconds].min
+            take = [time_in_day - from, -seconds].min.round
             # advance time
             time -= take
             # decrease seconds
@@ -162,7 +162,7 @@ module WorkingHours
           # roll to next business period
           from = advance_to_working_time(from, config: config)
         end
-        distance
+        distance.round # round up to supress miliseconds introduced by 24:00 hack
       end
     end
 

data/lib/working_hours/config.rb

@@ -5,7 +5,7 @@ module WorkingHours
 
   class Config
 
-    TIME_FORMAT = /\A([0-1][0-9]|2[0-3]):([0-5][0-9])\z/
+    TIME_FORMAT = /\A([0-2][0-9])\:([0-5][0-9])(?:\:([0-5][0-9]))?\z/
     DAYS_OF_WEEK = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
 
     class << self
@@ -39,6 +39,9 @@ module WorkingHours
         end
 
         config[:precompiled] ||= begin
+          validate_working_hours! config[:working_hours]
+          validate_holidays! config[:holidays]
+          validate_time_zone! config[:time_zone]
           compiled = {working_hours: []}
           working_hours.each do |day, hours|
             compiled[:working_hours][DAYS_OF_WEEK.index(day)] = {}
@@ -66,6 +69,20 @@ module WorkingHours
         Thread.current[:working_hours] = default_config
       end
 
+      def with_config(working_hours: nil, holidays: nil, time_zone: nil)
+        original_working_hours = self.working_hours
+        original_holidays = self.holidays
+        original_time_zone = self.time_zone
+        self.working_hours = working_hours if working_hours
+        self.holidays = holidays if holidays
+        self.time_zone = time_zone if time_zone
+        yield
+      ensure
+        self.working_hours = original_working_hours
+        self.holidays = original_holidays
+        self.time_zone = original_time_zone
+      end
+
       private
 
       def config
@@ -89,7 +106,11 @@ module WorkingHours
       def compile_time time
         hour = time[TIME_FORMAT,1].to_i
         min = time[TIME_FORMAT,2].to_i
-        hour * 3600 + min * 60
+        sec = time[TIME_FORMAT,3].to_i
+        time = hour * 3600 + min * 60 + sec
+        # Converts 24:00 to 23:59:59.999999
+        return 86399.999999 if time == 86400
+        time
       end
 
       def validate_working_hours! week
@@ -108,9 +129,11 @@ module WorkingHours
           last_time = nil
           hours.sort.each do |start, finish|
             if not start =~ TIME_FORMAT
-              raise InvalidConfiguration.new "Invalid time: #{start} - must be 'HH:MM'"
+              raise InvalidConfiguration.new "Invalid time: #{start} - must be 'HH:MM(:SS)'"
             elsif not finish =~ TIME_FORMAT
-              raise InvalidConfiguration.new "Invalid time: #{finish} - must be 'HH:MM'"
+              raise InvalidConfiguration.new "Invalid time: #{finish} - must be 'HH:MM(:SS)'"
+            elsif compile_time(finish) >= 24 * 60 * 60
+              raise InvalidConfiguration.new "Invalid time: #{finish} - outside of day"
             elsif start >= finish
               raise InvalidConfiguration.new "Invalid range: #{start} => #{finish} - ends before it starts"
             elsif last_time and start < last_time

data/lib/working_hours/core_ext/date_and_time.rb

@@ -53,14 +53,10 @@ class Date
   include WorkingHours::CoreExt::DateAndTime
 end
 
-class DateTime
-  include WorkingHours::CoreExt::DateAndTime
-end
-
 class Time
   include WorkingHours::CoreExt::DateAndTime
 end
 
 class ActiveSupport::TimeWithZone
   include WorkingHours::CoreExt::DateAndTime
-end
+end

data/lib/working_hours/version.rb

@@ -1,3 +1,3 @@
 module WorkingHours
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/spec_helper.rb

@@ -10,7 +10,6 @@ require 'timecop'
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
-  config.filter_run :focus
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

data/spec/working_hours/computation_spec.rb

@@ -98,6 +98,11 @@ describe WorkingHours::Computation do
       add_seconds(time, 120)
     end
 
+    it 'supports midnight' do
+      WorkingHours::Config.working_hours = {:mon => {'00:00' => '24:00'}}
+      time = Time.utc(2014, 4, 7, 23, 59, 30) # Friday
+      expect(add_seconds(time, 60)).to eq(Time.utc(2014, 4, 14, 0, 0, 30))
+    end
   end
 
   describe '#advance_to_working_time' do
@@ -310,6 +315,14 @@ describe WorkingHours::Computation do
       )).to eq(8.hours)
     end
 
+    it 'supports midnight' do
+      WorkingHours::Config.working_hours = {:mon => {'00:00' => '24:00'}}
+      expect(working_time_between(
+        Time.utc(2014, 4, 6, 12),
+        Time.utc(2016, 4, 6, 12)
+      )).to eq(24.hours * 105) # 105 complete mondays in 2 years
+    end
+
     it 'handles multiple timespans' do
       WorkingHours::Config.working_hours = {
         mon: {'07:00' => '12:00', '13:00' => '18:00'}

data/spec/working_hours/config_spec.rb

@@ -83,11 +83,11 @@ describe WorkingHours::Config do
       it 'rejects invalid time format' do
         expect {
           WorkingHours::Config.working_hours = {:mon => {'8:0' => '12:00'}}
-        }.to raise_error(WorkingHours::InvalidConfiguration, "Invalid time: 8:0 - must be 'HH:MM'")
+        }.to raise_error(WorkingHours::InvalidConfiguration, "Invalid time: 8:0 - must be 'HH:MM(:SS)'")
 
         expect {
-          WorkingHours::Config.working_hours = {:mon => {'08:00' => '24:00'}}
-        }.to raise_error(WorkingHours::InvalidConfiguration, "Invalid time: 24:00 - must be 'HH:MM'")
+          WorkingHours::Config.working_hours = {:mon => {'08:00' => '24:10'}}
+        }.to raise_error(WorkingHours::InvalidConfiguration, "Invalid time: 24:10 - outside of day")
       end
 
       it 'rejects invalid range' do
@@ -107,6 +107,15 @@ describe WorkingHours::Config do
           WorkingHours::Config.working_hours = {:mon => {'10:00' => '11:00', '08:00' => '09:00'}}
         }.not_to raise_error
       end
+
+      it 'raises an error when precompiling if working hours are invalid after assignment' do
+        WorkingHours::Config.working_hours = {:mon => {'10:00' => '11:00', '08:00' => '09:00'}}
+        WorkingHours::Config.working_hours[:mon] = 'Not correct'
+        expect {
+          1.working.hour.ago
+        }.to raise_error(WorkingHours::InvalidConfiguration, 'Invalid type for `mon`: String - must be Hash')
+      end
+
     end
   end
 
@@ -140,6 +149,15 @@ describe WorkingHours::Config do
           WorkingHours::Config.holidays = [Date.today, 42]
         }.to raise_error(WorkingHours::InvalidConfiguration, "Invalid holiday: 42 - must be Date")
       end
+
+      it 'raises an error when precompiling if holidays are invalid after assignment' do
+        WorkingHours::Config.holidays = [Date.today]
+        WorkingHours::Config.holidays << 42
+        expect {
+          1.working.hour.ago
+        }.to raise_error(WorkingHours::InvalidConfiguration, 'Invalid holiday: 42 - must be Date')
+      end
+
     end
   end
 
@@ -178,6 +196,14 @@ describe WorkingHours::Config do
           WorkingHours::Config.time_zone = 'Bordeaux'
         }.to raise_error(WorkingHours::InvalidConfiguration, "Unknown time zone: Bordeaux")
       end
+
+      it 'raises an error when precompiling if timezone is invalid after assignment' do
+        WorkingHours::Config.time_zone = 'Paris'
+        WorkingHours::Config.holidays << ' NotACity'
+        expect {
+          1.working.hour.ago
+        }.to raise_error(WorkingHours::InvalidConfiguration, 'Invalid holiday:  NotACity - must be Date')
+      end
     end
   end
 
@@ -192,6 +218,24 @@ describe WorkingHours::Config do
         })
     end
 
+    it 'supports seconds' do
+      WorkingHours::Config.working_hours = {:mon => {'20:32:59' => '22:59:59'}}
+      expect(subject).to eq({
+        :working_hours => [nil, {73979 => 82799}],
+        :holidays => Set.new([]),
+        :time_zone => ActiveSupport::TimeZone['UTC']
+      })
+    end
+
+    it 'supports 24:00 (converts to 23:59:59.999999)' do
+      WorkingHours::Config.working_hours = {:mon => {'20:00' => '24:00'}}
+      expect(subject).to eq({
+        :working_hours => [nil, {72000 => 86399.999999}],
+        :holidays => Set.new([]),
+        :time_zone => ActiveSupport::TimeZone['UTC']
+      })
+    end
+
     it 'changes if working_hours changes' do
       expect {
         WorkingHours::Config.working_hours = {:mon => {'08:00' => '14:00'}}
@@ -235,4 +279,57 @@ describe WorkingHours::Config do
       expect(WorkingHours::Config.precompiled).to be(precompiled)
     end
   end
+
+  describe '.with_config' do
+
+    let(:working_hours) { { mon: {'08:00' => '19:00'} } }
+    let(:holidays) { [Date.new(2014, 11, 15)]}
+    let(:time_zone) { ActiveSupport::TimeZone.new('Paris') }
+
+    it 'sets the corresponding config inside the block' do
+      WorkingHours::Config.with_config(working_hours: working_hours, holidays: holidays, time_zone: time_zone) do
+        expect(WorkingHours::Config.working_hours).to eq(working_hours)
+        expect(WorkingHours::Config.holidays).to eq(holidays)
+        expect(WorkingHours::Config.time_zone).to eq(time_zone)
+      end
+    end
+
+    it 'resets to old config after the block' do
+      WorkingHours::Config.working_hours = {tue: {'09:00' => '16:00'} }
+      WorkingHours::Config.holidays = [Date.new(2014, 01, 01)]
+      WorkingHours::Config.time_zone = ActiveSupport::TimeZone.new('Tokyo')
+      WorkingHours::Config.with_config(working_hours: working_hours, holidays: holidays, time_zone: time_zone) {}
+      expect(WorkingHours::Config.working_hours).to eq({tue: {'09:00' => '16:00'} })
+      expect(WorkingHours::Config.holidays).to eq([Date.new(2014, 01, 01)])
+      expect(WorkingHours::Config.time_zone).to eq(ActiveSupport::TimeZone.new('Tokyo'))
+    end
+
+    it 'resets to old config after the block even if things go bad' do
+      WorkingHours::Config.working_hours = {tue: {'09:00' => '16:00'} }
+      WorkingHours::Config.holidays = [Date.new(2014, 01, 01)]
+      WorkingHours::Config.time_zone = ActiveSupport::TimeZone.new('Tokyo')
+      begin
+        WorkingHours::Config.with_config(working_hours: working_hours, holidays: holidays, time_zone: time_zone) do
+          raise
+        end
+      rescue
+      end
+      expect(WorkingHours::Config.working_hours).to eq({tue: {'09:00' => '16:00'} })
+      expect(WorkingHours::Config.holidays).to eq([Date.new(2014, 01, 01)])
+      expect(WorkingHours::Config.time_zone).to eq(ActiveSupport::TimeZone.new('Tokyo'))
+    end
+
+    it 'raises if working_hours are invalid' do
+      expect { WorkingHours::Config.with_config(working_hours: {}) {}}.to raise_error(WorkingHours::InvalidConfiguration)
+    end
+
+    it 'raises if holidays are invalid' do
+      expect { WorkingHours::Config.with_config(holidays: [1]) {}}.to raise_error(WorkingHours::InvalidConfiguration)
+    end
+
+    it 'raises if timezone is invalid' do
+      expect { WorkingHours::Config.with_config(time_zone: '67P Comet') {}}.to raise_error(WorkingHours::InvalidConfiguration)
+    end
+
+  end
 end

data/spec/working_hours/core_ext/date_and_time_spec.rb

@@ -28,11 +28,30 @@ describe WorkingHours::CoreExt::DateAndTime do
       time + duration
     end
 
-    it "doesn't break original operator" do
+    it "doesn't break original Time operator" do
       time = Time.now
       expect(WorkingHours).not_to receive(:add_days)
       expect(time + 3600).to eq(time + 1.hour)
     end
+
+    it "doesn't break original Date operator" do
+      date = Date.today
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(date + 1).to eq(date + 1.day)
+    end
+
+    it "doesn't break original DateTime operator" do
+      datetime = DateTime.now.change(usec: 0)
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(datetime + 1).to eq(datetime + 1.day)
+    end
+
+    it "doesn't break original TimeWithZone operator" do
+      Time.zone = 'UTC'
+      time = Time.zone.now
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(time + 1).to eq(time + 1.second)
+    end
   end
 
   describe 'operator -' do
@@ -60,11 +79,30 @@ describe WorkingHours::CoreExt::DateAndTime do
       time - duration
     end
 
-    it "doesn't break original operator" do
+    it "doesn't break original Time operator" do
       time = Time.now
       expect(WorkingHours).not_to receive(:add_days)
       expect(time - 3600).to eq(time - 1.hour)
     end
+
+    it "doesn't break original Date operator" do
+      date = Date.today
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(date - 1).to eq(date - 1.day)
+    end
+
+    it "doesn't break original DateTime operator" do
+      datetime = DateTime.now.change(usec: 0)
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(datetime - 1).to eq(datetime - 1.day)
+    end
+
+    it "doesn't break original TimeWithZone operator" do
+      Time.zone = 'UTC'
+      time = Time.zone.now
+      expect(WorkingHours).not_to receive(:add_days)
+      expect(time - 1).to eq(time - 1.second)
+    end
   end
 
   describe '#working_days_until' do

data/working_hours.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: working_hours
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Adrien Jarthon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - gemfiles/Gemfile.activesupport-3.2.x
 - gemfiles/Gemfile.activesupport-4.0.x
 - gemfiles/Gemfile.activesupport-4.1.x
+- gemfiles/Gemfile.activesupport-4.2.x
 - gemfiles/Gemfile.activesupport-head
 - lib/working_hours.rb
 - lib/working_hours/computation.rb
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: time calculation with working hours