working_hours 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f3a760854612e389ff263f670c2ddbd3206c5895f13a753267e44a92ca12f1
-  data.tar.gz: f9f30c0aaf3c7004a68b7f18ef39767e30c497bedc14361c2ad450894272997e
+  metadata.gz: 225b5949f517f52c261b36052038b14c5041f68c14ead85872a3fe5f62221b22
+  data.tar.gz: 753f528212ba0c641390383a0d2446f6291ef5aabf581fd338034083bee0a012
 SHA512:
-  metadata.gz: c63b351486621dca69deb0b827dc51024f74b4304e6639c9272b01d5a5fd9a58013e1d9874ed13466ce6f5fb60ccab67c9f2712a0af2b4d5e4a94bbf214ac996
-  data.tar.gz: 8662b6a40f4ee6bc734cd2f87eecf1e6b51a474638dc5b9a867525cbdc0c7a4b329a34054fff395e71e36b5b93e26d01d3205b2965fd0573c70bbe764c1e450b
+  metadata.gz: 979eb961fadd99a0997a361cc34f0e4d71df757a23103f40a76038dce547ea103f05c879eddf098b56af04eddb97dc297cbcae686a4026f2a09e94838dae6cb1
+  data.tar.gz: 93a6d6e4c69af754f593e69fb46afff7ea242bcccfb9c57627ede0bce4826d5bc25de1aaccb4ae4ed3c6b560929fa188871e2b6b342462bb154114ba21ddd1b6

data/.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: build
+on: push
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        ruby_version:
+          - 3.1.6
+          - 3.2.6
+          - 3.3.6
+          - jruby-9.4.9.0
+        gemfile:
+          - gemfiles/Gemfile.activesupport-7.1.x
+          - gemfiles/Gemfile.activesupport-7.2.x
+          - gemfiles/Gemfile.activesupport-8.x
+        exclude:
+            - gemfile: gemfiles/Gemfile.activesupport-8.x
+              ruby_version: 3.1.6
+            - gemfile: gemfiles/Gemfile.activesupport-8.x
+              ruby_version: jruby-9.4.9.0
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+            ruby-version: ${{ matrix.ruby_version }}
+            bundler-cache: true
+
+      - name: Run rspec
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Unreleased
 
-[Compare master with v1.4.0](https://github.com/intrepidd/working_hours/compare/v1.4.0...master)
+[Compare master with v1.5.0](https://github.com/intrepidd/working_hours/compare/v1.5.0...master)
+
+# v1.5.0
+This release does not include any code change, there is only a dependency bump to ActiveSupport >= 7.0 to reflect the actual versions the gem supports.
+
+* Drop support for unsupported Ruby & ActiveSupport versions
+* Add support to ActiveSupport 7 and 8
+* Changes gemspec dependency to ActiveSupport >= 7.0
+
+# v1.4.1
+* Add InvalidConfiguration error code to allow custom message or behavior - [#47](https://github.com/Intrepidd/working_hours/pull/47)
 
 # v1.4.0
 * New config option: holiday_hours - [#37](https://github.com/Intrepidd/working_hours/pull/37)

data/README.md

@@ -1,12 +1,12 @@
 # WorkingHours
 
-[![Build Status](https://travis-ci.com/Intrepidd/working_hours.svg?branch=master)](https://travis-ci.com/Intrepidd/working_hours)
+[![build](https://github.com/Intrepidd/working_hours/actions/workflows/build.yml/badge.svg)](https://github.com/Intrepidd/working_hours/actions/workflows/build.yml)
 
 A modern ruby gem allowing to do time calculation with working hours.
 
 Compatible and tested with:
-- Ruby `2.4`, `2.5`, `2.6`, `2.7`, `3.0`, JRuby `9.2`
-- ActiveSupport `4.x`, `5.x`, `6.x`
+- Ruby `3.1`, `3.2`, `3.3`, JRuby `9.4`
+- ActiveSupport `7.x`, `8.x`
 
 ## Installation
 
@@ -116,6 +116,21 @@ If *any* hours are set for a calendar day in `holiday_hours`, then the `working_
 WorkingHours::Config.holiday_hours = {Date.new(2020, 12, 24) => {'09:00' => '12:00', '13:00' => '15:00'}}
 ```
 
+### Handling errors
+
+If the configuration is erroneous, an ``WorkingHours::InvalidConfiguration`` exception will be raised containing the appropriate error message.
+
+You can also access the error code in case you want to implement custom behavior or changing one specific message, e.g:
+
+```ruby
+rescue WorkingHours::InvalidConfiguration => e
+  if e.error_code == :empty
+    raise StandardError.new "Config is required"
+  end
+  raise e
+end
+```
+
 ## 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**:

data/gemfiles/{Gemfile.activesupport-4.x → Gemfile.activesupport-7.1.x}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '..'
 
-gem 'activesupport', '~> 4.2'
+gem 'activesupport', '~> 7.1'

data/gemfiles/{Gemfile.activesupport-5.x → Gemfile.activesupport-7.2.x}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '..'
 
-gem 'activesupport', '~> 5.2'
+gem 'activesupport', '~> 7.2'

data/gemfiles/{Gemfile.activesupport-6.x → Gemfile.activesupport-8.x}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '..'
 
-gem 'activesupport', '~> 6.1'
+gem 'activesupport', '~> 8.0'

data/lib/working_hours/config.rb

@@ -1,7 +1,35 @@
 require 'set'
 
 module WorkingHours
-  InvalidConfiguration = Class.new StandardError
+  class InvalidConfiguration < StandardError
+    attr_reader :data, :error_code
+
+    def initialize(error_code, data: nil)
+      @data = data
+      @error_code = error_code
+      super compose_message(error_code)
+    end
+
+    def compose_message(error_code)
+      case error_code
+      when :empty then "No working hours given"
+      when :empty_day then "No working hours given for day `#{@data[:day]}`"
+      when :holidays_not_array then "Invalid type for holidays: #{@data[:holidays_class]} - must act like an array"
+      when :holiday_not_date then "Invalid holiday: #{@data[:day]} - must be Date"
+      when :invalid_day_keys then "Invalid day identifier(s): #{@data[:invalid_keys]} - must be 3 letter symbols"
+      when :invalid_format then "Invalid time: #{@data[:time]} - must be 'HH:MM(:SS)'"
+      when :invalid_holiday_keys then "Invalid day identifier(s): #{@data[:invalid_keys]} - must be a Date object"
+      when :invalid_timezone then "Invalid time zone: #{@data[:zone]} - must be String or ActiveSupport::TimeZone"
+      when :invalid_type then "Invalid type for `#{@data[:day]}`: #{@data[:hours_class]} - must be Hash"
+      when :outside_of_day then "Invalid time: #{@data[:time]} - outside of day"
+      when :overlap then "Invalid range: #{@data[:start]} => #{@data[:finish]} - overlaps previous range"
+      when :unknown_timezone then "Unknown time zone: #{@data[:zone]}"
+      when :wrong_order then "Invalid range: #{@data[:start]} => #{@data[:finish]} - ends before it starts"
+      else "Invalid Configuration"
+      end
+    end
+  end
+
 
   class Config
     TIME_FORMAT = /\A([0-2][0-9])\:([0-5][0-9])(?:\:([0-5][0-9]))?\z/
@@ -149,22 +177,22 @@ module WorkingHours
       def validate_hours! dates
         dates.each do |day, hours|
           if not hours.is_a? Hash
-            raise InvalidConfiguration.new "Invalid type for `#{day}`: #{hours.class} - must be Hash"
+            raise InvalidConfiguration.new :invalid_type, data: { day: day, hours_class: hours.class }
           elsif hours.empty?
-            raise InvalidConfiguration.new "No working hours given for day `#{day}`"
+            raise InvalidConfiguration.new :empty_day, data: { day: day }
           end
           last_time = nil
           hours.sort.each do |start, finish|
             if not start =~ TIME_FORMAT
-              raise InvalidConfiguration.new "Invalid time: #{start} - must be 'HH:MM(:SS)'"
+              raise InvalidConfiguration.new :invalid_format, data: { time: start }
             elsif not finish =~ TIME_FORMAT
-              raise InvalidConfiguration.new "Invalid time: #{finish} - must be 'HH:MM(:SS)'"
+              raise InvalidConfiguration.new :invalid_format, data: { time: finish }
             elsif compile_time(finish) >= 24 * 60 * 60
-              raise InvalidConfiguration.new "Invalid time: #{finish} - outside of day"
+              raise InvalidConfiguration.new :outside_of_day, data: { time: finish }
             elsif start >= finish
-              raise InvalidConfiguration.new "Invalid range: #{start} => #{finish} - ends before it starts"
+              raise InvalidConfiguration.new :wrong_order, data: { start: start, finish: finish }
             elsif last_time and start < last_time
-              raise InvalidConfiguration.new "Invalid range: #{start} => #{finish} - overlaps previous range"
+              raise InvalidConfiguration.new :overlap, data: { start: start, finish: finish }
             end
             last_time = finish
           end
@@ -173,28 +201,28 @@ module WorkingHours
 
       def validate_working_hours! week
         if week.empty?
-          raise InvalidConfiguration.new "No working hours given"
+          raise InvalidConfiguration.new :empty
         end
         if (invalid_keys = (week.keys - DAYS_OF_WEEK)).any?
-          raise InvalidConfiguration.new "Invalid day identifier(s): #{invalid_keys.join(', ')} - must be 3 letter symbols"
+          raise InvalidConfiguration.new :invalid_day_keys, data: { invalid_keys: invalid_keys.join(', ') }
         end
         validate_hours!(week)
       end
 
       def validate_holiday_hours! days
         if (invalid_keys = (days.keys.reject{ |day| day.is_a?(Date) })).any?
-          raise InvalidConfiguration.new "Invalid day identifier(s): #{invalid_keys.join(', ')} - must be a Date object"
+          raise InvalidConfiguration.new :invalid_holiday_keys, data: { invalid_keys: invalid_keys.join(', ') }
         end
         validate_hours!(days)
       end
 
       def validate_holidays! holidays
         if not holidays.respond_to?(:to_a)
-          raise InvalidConfiguration.new "Invalid type for holidays: #{holidays.class} - must act like an array"
+          raise InvalidConfiguration.new :holidays_not_array, data: { holidays_class: holidays.class }
         end
         holidays.to_a.each do |day|
           if not day.is_a? Date
-            raise InvalidConfiguration.new "Invalid holiday: #{day} - must be Date"
+            raise InvalidConfiguration.new :holiday_not_date, data: { day: day }
           end
         end
       end
@@ -203,12 +231,12 @@ module WorkingHours
         if zone.is_a? String
           res = ActiveSupport::TimeZone[zone]
           if res.nil?
-            raise InvalidConfiguration.new "Unknown time zone: #{zone}"
+            raise InvalidConfiguration.new :unknown_timezone, data: { zone: zone }
           end
         elsif zone.is_a? ActiveSupport::TimeZone
           res = zone
         else
-          raise InvalidConfiguration.new "Invalid time zone: #{zone.inspect} - must be String or ActiveSupport::TimeZone"
+          raise InvalidConfiguration.new :invalid_timezone, data: { zone: zone.inspect }
         end
         res
       end

data/lib/working_hours/version.rb

@@ -1,3 +1,3 @@
 module WorkingHours
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/spec/working_hours/computation_spec.rb

@@ -401,12 +401,12 @@ describe WorkingHours::Computation do
 
       it 'takes into account reduced holiday closing' do
         WorkingHours::Config.holiday_hours = { Date.new(2019, 12, 27) => { '10:00' => '17:00' } }
-        expect(advance_to_closing_time(Time.new(2019, 12, 26, 20))).to eq(Time.new(2019, 12, 27, 17))
+        expect(advance_to_closing_time(Time.utc(2019, 12, 26, 20))).to eq(Time.utc(2019, 12, 27, 17))
       end
 
       it 'takes into account extended holiday closing' do
         WorkingHours::Config.holiday_hours = { Date.new(2019, 12, 26) => { '10:00' => '21:00' } }
-        expect(advance_to_closing_time(Time.new(2019, 12, 26, 20))).to eq(Time.new(2019, 12, 26, 21))
+        expect(advance_to_closing_time(Time.utc(2019, 12, 26, 20))).to eq(Time.utc(2019, 12, 26, 21))
       end
     end
 

data/working_hours.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency 'activesupport', '>= 7.0'
   spec.add_dependency 'tzinfo'
 
   spec.add_development_dependency 'bundler', '>= 1.5'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: working_hours
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Adrien Jarthon
 - Intrepidd
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2024-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -103,17 +103,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/Gemfile.activesupport-4.x
-- gemfiles/Gemfile.activesupport-5.x
-- gemfiles/Gemfile.activesupport-6.x
+- gemfiles/Gemfile.activesupport-7.1.x
+- gemfiles/Gemfile.activesupport-7.2.x
+- gemfiles/Gemfile.activesupport-8.x
 - gemfiles/Gemfile.activesupport-edge
 - lib/working_hours.rb
 - lib/working_hours/computation.rb
@@ -137,7 +137,7 @@ homepage: https://github.com/intrepidd/working_hours
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.10
+signing_key:
 specification_version: 4
 summary: time calculation with working hours
 test_files:

data/.travis.yml

@@ -1,27 +0,0 @@
-language: ruby
-dist: bionic
-rvm:
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-  - jruby-9.2.14.0
-gemfile:
-  - gemfiles/Gemfile.activesupport-4.x
-  - gemfiles/Gemfile.activesupport-5.x
-  - gemfiles/Gemfile.activesupport-6.x
-jobs:
-  exclude:
-    - rvm: 2.4.10
-      gemfile: gemfiles/Gemfile.activesupport-6.x
-    - rvm: 2.7.2
-      gemfile: gemfiles/Gemfile.activesupport-4.x
-    - rvm: 3.0.0
-      gemfile: gemfiles/Gemfile.activesupport-4.x
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile.activesupport-edge
-  allow_failures:
-    - gemfile: gemfiles/Gemfile.activesupport-edge
-  fast_finish: true