active_period 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 244cb233b1cdd1aeac905c1c7467cdb90a9bd4179ed28d2c14928ebd5cd95308
-  data.tar.gz: 98776fbef793f99dc2f0ac63bb8dbd380fb709878f9eb2985cb393e008622f99
+  metadata.gz: dba2a2ea208d8904f845e463f8f82f96590dce4f2ad10557a77f30bc9065380d
+  data.tar.gz: 869c18ddc605ccc8fa4cd23da17bfad196e4cdc92de3c1fed5f378d66c2351cc
 SHA512:
-  metadata.gz: 27251125b3cb392249e94eeeec0feb6faf4836dff714a1bd9996ffa032ea782b264798b07fea01ccf019fd8d2f2583a049fda7b0438156a297a4f20e0484fdf8
-  data.tar.gz: eae48296375f9d0323c4e2e2b5356a135dd9287dbe345f315526363b9e5c578ae858239434c1729fb0b9b01c6c80a5de01cbf259eb83cbe7637814d5dfb453bb
+  metadata.gz: b0287446e67fa3f801b70fcfe6fbf1190a9ac2f3957dc3ffd3cb499046e9f3ae8910ca01d5aa6142a0816012bc0db8505f93fccf432d7e1b7f4b624edcd112e2
+  data.tar.gz: aa43b0db9103fb16e82b84ea29c62783d100b83b742f89393f2aaca73348da6d0aaeef6ee9623252e55e7f7dd4c721bcdba0fdaff9e74d11cbe50c50d7ff356a

data/Gemfile.lock

@@ -1,31 +1,29 @@
 PATH
   remote: .
   specs:
-    active_period (6.0.0)
-      activesupport (~> 6)
+    active_period (6.2.0)
+      activesupport (~> 5)
       i18n (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (5.2.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     concurrent-ruby (1.1.8)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     rake (10.5.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
-  x86_64-darwin-19
 
 DEPENDENCIES
   active_period!
@@ -33,4 +31,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   2.2.3
+   2.1.2

data/README.md

@@ -1,7 +1,7 @@
-# ActivePeriod 
-[![Gem Version](https://badge.fury.io/rb/active_period.svg)](https://badge.fury.io/rb/active_period) 
-[![Code Climate](https://codeclimate.com/github/billaul/period.svg)](https://codeclimate.com/github/billaul/period) 
-[![Inline docs](http://inch-ci.org/github/billaul/period.svg)](http://inch-ci.org/github/billaul/period) 
+# ActivePeriod
+[![Gem Version](https://badge.fury.io/rb/active_period.svg)](https://badge.fury.io/rb/active_period)
+[![Code Climate](https://codeclimate.com/github/billaul/period.svg)](https://codeclimate.com/github/billaul/period)
+[![Inline docs](http://inch-ci.org/github/billaul/period.svg)](http://inch-ci.org/github/billaul/period)
 [![RubyGems](http://img.shields.io/gem/dt/active_period.svg?style=flat)](http://rubygems.org/gems/active_period)
 
 ActivePeriod aims to simplify Time-range manipulation.
@@ -320,6 +320,39 @@ Time zone are supported
 If you change the global `Time.zone` of your app
 If your Period [begin in a time zone and end in another](https://en.wikipedia.org/wiki/Daylight_saving_time), you have nothing to do
 
+## Holidays
+
+`ActivePeriod` include an optional support of the [gem holidays](https://github.com/holidays/holidays)      
+If your project include this gem you can use the power of `.holidays` and `.holiday?`
+
+`.holiday?` and `.holidays` take the same params as `Holidays.on` except the first one        
+`Holidays.on(Date.civil(2008, 4, 25), :au)` become `Period.day('24/04/2008').holidays(:au)` or `Period.day('24/04/2008').holiday?(:au)`
+
+```ruby
+require 'holidays'
+# Get all worldwide holidays in the current month
+Period.this_month.holidays
+
+# Get all US holidays in the current month
+Period.this_month.holidays(:us)
+
+# Get all US and CA holidays in the current month
+Period.this_month.holidays(:us, :ca)
+
+# First up coming `FR` holiday
+holiday = Period.new(Time.now..).holidays(:fr).first
+# return the next holiday within the same options of the original `.holidays` collection
+holiday.next
+# return the previous holiday within the same options of the original `.holidays` collection
+holiday.prev
+```
+
+:warning: If you call a `holidays` related method without the [gem holidays](https://github.com/holidays/holidays) in your project you will raise a `RuntimeError`
+```ruby
+Period.this_month.holidays
+#=> RuntimeError (The gem "holidays" is needed for this feature to work)
+```
+
 ## Planned updates
 
 - [ ] ActiveRecord Serializer (maybe)

data/lib/active_period/collection/free_period.rb

@@ -23,7 +23,7 @@ module ActivePeriod
         raise RangeError.new "cannot get the last element of endless range" if period.endless?
 
         Enumerator.new do |yielder|
-          current = klass.new(period.end)
+          current = klass.new(period.calculated_end)
           while period.begin.nil? || period.include?(current.begin) || period.include?(current.calculated_end)
             yielder << current
             current = current.prev

data/lib/active_period/collection/holiday_period.rb

@@ -19,7 +19,7 @@ module ActivePeriod
           days = period.try(:days) || [period]
           days.each do |day|
             Holidays.on(day.begin.to_date, *options).each do |hash|
-              yielder << ActivePeriod::Holiday.new(**hash)
+              yielder << ActivePeriod::Holiday.new(**hash, options: @options)
             end
           end
           # At the end (if there is one) the Collection will be return
@@ -32,7 +32,7 @@ module ActivePeriod
           days = period.try(:days) || [period]
           days.reverse_each do |day|
             Holidays.on(day.begin.to_date, *options).each do |hash|
-              yielder << ActivePeriod::Holiday.new(**hash)
+              yielder << ActivePeriod::Holiday.new(**hash, options: @options)
             end
           end
           # At the end (if there is one) the Collection will be return

data/lib/active_period/collection/standard_period.rb

@@ -8,7 +8,7 @@ module ActivePeriod
       def enumerator
         Enumerator.new do |yielder|
           current = klass.new(period.begin)
-          while current.end <= period.end || period.include?(current)
+          while current.calculated_end <= period.calculated_end || period.include?(current)
             yielder << current if period.include?(current)
             current = current.next
           end
@@ -19,7 +19,7 @@ module ActivePeriod
 
       def reverse_enumerator
         Enumerator.new do |yielder|
-          current = klass.new(period.end)
+          current = klass.new(period.calculated_end)
           while current.begin <= period.begin || period.include?(current)
             yielder << current if period.include?(current)
             current = current.prev

data/lib/active_period/holiday.rb

@@ -10,27 +10,32 @@ class ActivePeriod::Holiday < ActivePeriod::Day
   #   @return [<Symbol>] regions where the Holiday occure
   attr_reader :regions
 
+  # @!attribute [r] options
+  #   @return [Array] The array of options for Holidays.on
+  attr_reader :options
 
   # @param date [...] A valid param for Period.day(...)
   # @param name [String] The name of the Holiday
   # @param regions [<Symbol>] region where the Holiday occure
+  # @param options [...] The array of options for Holidays.on
   # @return [Type] ActivePeriod::Holiday
   # @raise RuntimeError if the gem "holidays" is not included
-  def initialize(date: , name:, regions: )
+  def initialize(date: , name:, regions: , options: )
     raise I18n.t(:gem_require, scope: %i[active_period holiday_period]) unless Object.const_defined?('Holidays')
     super(date)
 
     @name = name
     @regions = regions
+    @options = options
   end
 
   def next
-    raise NotImplementedError
+    Period.new(beginning+1.day..).holidays(options).first
   end
   alias succ next
 
   def prev
-    raise NotImplementedError
+    Period.new(...ending).holidays(options).last
   end
 
   def _period
@@ -62,7 +67,7 @@ class ActivePeriod::Holiday < ActivePeriod::Day
   end
 
   def i18n(&block)
-    return yield(from, to) if block.present?
+    return yield(self) if block.present?
 
     I18n.t(:default_format,
            scope:   i18n_scope,
@@ -72,6 +77,7 @@ class ActivePeriod::Holiday < ActivePeriod::Day
            month:   I18n.l(from, format: '%B').capitalize,
            year:    from.year)
   end
+  alias inspect i18n
 
   def i18n_scope
     [:active_period, :holiday_period]

data/lib/active_period/version.rb

@@ -1,5 +1,5 @@
 module ActivePeriod
 
-  VERSION = '6.1.1'.freeze
+  VERSION = '6.2.0'.freeze
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_period
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - billau_l