working_hours 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f3a760854612e389ff263f670c2ddbd3206c5895f13a753267e44a92ca12f1
-  data.tar.gz: f9f30c0aaf3c7004a68b7f18ef39767e30c497bedc14361c2ad450894272997e
+  metadata.gz: 9d51f59c3456e35117b42605450d911595a331ef6a72303aba33a6eedcdabd6f
+  data.tar.gz: '0527249d73eb1da76205e5b02bd7d67226a105c91f2a14240ddfd39abc0daeb6'
 SHA512:
-  metadata.gz: c63b351486621dca69deb0b827dc51024f74b4304e6639c9272b01d5a5fd9a58013e1d9874ed13466ce6f5fb60ccab67c9f2712a0af2b4d5e4a94bbf214ac996
-  data.tar.gz: 8662b6a40f4ee6bc734cd2f87eecf1e6b51a474638dc5b9a867525cbdc0c7a4b329a34054fff395e71e36b5b93e26d01d3205b2965fd0573c70bbe764c1e450b
+  metadata.gz: b276429238c21dbb526c53d4be5082450c99b5c5414d9b21786ec4278ef83ff07c6e2a952cdf6bbb9125f0b32b013f7d2b009cadb020b062a780dcf119d733aa
+  data.tar.gz: 77524f554091fccfdd9b96ea0ff64295fb55a8358f010adac5f008455428fd91c3b8ef80111f515529f2059b4e3db6081177b3563b2c16c83ee5d6e829e27789

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Unreleased
 
-[Compare master with v1.4.0](https://github.com/intrepidd/working_hours/compare/v1.4.0...master)
+[Compare master with v1.4.1](https://github.com/intrepidd/working_hours/compare/v1.4.1...master)
+
+# 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

@@ -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/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.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: working_hours
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Adrien Jarthon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport