active_period 6.1.1 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 244cb233b1cdd1aeac905c1c7467cdb90a9bd4179ed28d2c14928ebd5cd95308
-  data.tar.gz: 98776fbef793f99dc2f0ac63bb8dbd380fb709878f9eb2985cb393e008622f99
+  metadata.gz: b844daa7cc7ef648456cbfca6a0160a4cc6f12da6977066ad8a4a310d78bad2e
+  data.tar.gz: 520d626a06a54380df33877babdb6854f338c10908d8b03a644aab2e8416b7e8
 SHA512:
-  metadata.gz: 27251125b3cb392249e94eeeec0feb6faf4836dff714a1bd9996ffa032ea782b264798b07fea01ccf019fd8d2f2583a049fda7b0438156a297a4f20e0484fdf8
-  data.tar.gz: eae48296375f9d0323c4e2e2b5356a135dd9287dbe345f315526363b9e5c578ae858239434c1729fb0b9b01c6c80a5de01cbf259eb83cbe7637814d5dfb453bb
+  metadata.gz: 63a99d4de2e83d52f0c24e1110ad4e37acbad1d7980ea5b6d4c1084dfaae1a676e05a4850f3bb903e725f8c1ca98d09db9b1a14d102cd9686a844b12ca9f84d3
+  data.tar.gz: 11f0c8d57e2995e8a745885bddcc8b268920e65d30309048da2f0aeb9d4faa0cee43225f7686529995c6e919e0da1940f0c40d8b3b3ea93c299bf1662750798e

data/Gemfile.lock

@@ -1,36 +1,77 @@
 PATH
   remote: .
   specs:
-    active_period (6.0.0)
-      activesupport (~> 6)
+    active_period (6.3.0)
+      activesupport (~> 6, >= 5)
       i18n (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.8)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    cucumber (7.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-html-formatter (~> 16.0, >= 16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-wire (~> 6.0, >= 6.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.0.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
+    cucumber-create-meta (6.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (12.1.1)
+    cucumber-gherkin (20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-html-formatter (16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-messages (17.0.1)
+    cucumber-tag-expressions (3.0.1)
+    cucumber-wire (6.0.1)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    diff-lcs (1.4.4)
+    ffi (1.15.3)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
     minitest (5.14.4)
+    multi_test (0.1.2)
     rake (10.5.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
     zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
-  x86_64-darwin-19
 
 DEPENDENCIES
   active_period!
   bundler (~> 2.0)
+  cucumber
   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.
@@ -51,6 +51,9 @@ Period.new(..Time.now).months.reverse_each # => Enumerable
 # Write a date for me (I18n supported)
 Period.new('20/01/2017'...'20/01/2021').to_s
 => "From the 20 January 2017 to the 20 January 2021 excluded"
+
+# Get all US holidays in the next week (see holiday's section below)
+Period.next_week.holidays(:us)
 ```
 
 ## Detailed view
@@ -311,7 +314,7 @@ For a FreePeriod or if you need to print the start and the end of your period di
 ## The tricky case of Weeks
 
 Weeks are implemented following the [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date)      
-So `Period.this_month.weeks.first` doesn't necessarily include the first days of the month
+So `Period.this_month.weeks.first` doesn't necessarily include the first days of the month     
 Also a **StandardPeriod** and a **FreePeriod** covering the same range of time, may not includes the same `Weeks`
 
 ## TimeZone
@@ -320,10 +323,43 @@ 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 next week
+Period.next_week.holidays(:us)
+
+# Get all US and CA holidays in the prev quarter
+Period.prev_quarter.holidays(:us, :ca)
+
+# First up coming `FR` holiday
+holiday = (Time.now..).to_period.holidays(:fr).first
+# return the next holiday with same options as the original `.holidays` collection
+holiday.next
+# return the previous holiday with same options as 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)
-- [ ] Holidays support (gem Holidays) -> COMING SOON
 
 ## Bug reports
 

data/active_period.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Manage time ranges without brain damage.'
   # spec.description   = "Period.new('01/01/2020'..Time.now)"
-  spec.homepage      = "https://github.com/billaul/period"
+  spec.homepage      = "https://github.com/billaul/active_period"
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -37,8 +37,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib config]
 
   spec.required_ruby_version = '>= 2.7'
-  spec.add_runtime_dependency 'activesupport', '~> 5'
+
+  spec.add_runtime_dependency 'activesupport', '>= 5', '~> 6'
   spec.add_runtime_dependency 'i18n', '~> 1'
+
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'cucumber'
 end

data/lib/active_period.rb

@@ -23,6 +23,8 @@ require_relative 'active_period/year.rb'
 require_relative 'active_period/holiday.rb'
 require_relative 'period.rb'
 
+# TODO find a way to cleanup this require_relative mess >< 
+
 module ActivePeriod
 
 end

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.3.1'.freeze
 
 end

data/lib/period.rb

@@ -1,34 +1,43 @@
+# This module is intended to hide the complexity of ActivePeriod
+# And permit the user to write less and doing more
 module Period
+
+  # Shorthand to ActivePeriod::FreePeriod.new
   def self.new(*args)
     ActivePeriod::FreePeriod.new(*args)
   end
 
+  # Shorthand ActivePeriod::FreePeriod.new(range, allow_beginless: false, allow_endless: false)
   def self.bounded(range)
     ActivePeriod::FreePeriod.new(range, allow_beginless: false, allow_endless: false)
   end
 
+  # env_time provide a Fallback if the project dont specify any Time.zone
   def self.env_time
     (Time.zone || Time)
   end
 
+  # Dynamic definition of `.(last|this|next)_(day|week|month|quarter|year)`
+  # and `.yesterday` `.today` `.tomorrow`
+  # TODO implement (last|next)_holiday
   class << self
-    %i[day week month quarter year].each do |period|
-      define_method "last_#{period}" do
-        date = env_time.now.send(period == :day ? 'yesterday' : "last_#{period}")
-        Object.const_get("ActivePeriod::#{period.capitalize}").new(date)
+    %i[day week month quarter year].each do |standard_period|
+      define_method "last_#{standard_period}" do
+        date = env_time.now.send(standard_period == :day ? 'yesterday' : "last_#{standard_period}")
+        Object.const_get("ActivePeriod::#{standard_period.capitalize}").new(date)
       end
 
-      define_method "this_#{period}" do
-        Object.const_get("ActivePeriod::#{period.capitalize}").new(env_time.now)
+      define_method "this_#{standard_period}" do
+        Object.const_get("ActivePeriod::#{standard_period.capitalize}").new(env_time.now)
       end
 
-      define_method "next_#{period}" do
-        date = env_time.now.send(period == :day ? 'tomorrow' : "next_#{period}")
-        Object.const_get("ActivePeriod::#{period.capitalize}").new(date)
+      define_method "next_#{standard_period}" do
+        date = env_time.now.send(standard_period == :day ? 'tomorrow' : "next_#{standard_period}")
+        Object.const_get("ActivePeriod::#{standard_period.capitalize}").new(date)
       end
 
-      define_method period.to_s do |range|
-        Object.const_get("ActivePeriod::#{period.capitalize}").new(range)
+      define_method standard_period.to_s do |range|
+        Object.const_get("ActivePeriod::#{standard_period.capitalize}").new(range)
       end
     end
 
@@ -36,6 +45,10 @@ module Period
     alias tomorrow next_day
     alias today this_day
 
+    # Experimental non-documented feature
+    # Inpired form ActiveRecord dynamic find_by_x like User.find_by_name
+    # Example: Period.last_3_weeks_from_now == Period.mew(2.weeks.ago.beginning_of_week..Time.now.end_of_week)
+    # Note : Maybe it should return a collection of StandardPeriod
     def method_missing(method_name, *arguments, &block)
       super unless method_name.match?(/(last|next)_\d+_(day|week|month|quarter|year)s?(_from_now)?/)
       last_next, count, klass = method_name.to_s.split('_')

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: active_period
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.3.1
 platform: ruby
 authors:
 - billau_l
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []
@@ -115,14 +135,14 @@ files:
 - lib/numeric.rb
 - lib/period.rb
 - lib/range.rb
-homepage: https://github.com/billaul/period
+homepage: https://github.com/billaul/active_period
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/billaul/period/issues
-  homepage_uri: https://github.com/billaul/period
-  documentation_uri: https://github.com/billaul/period
-  source_code_uri: https://github.com/billaul/period
+  bug_tracker_uri: https://github.com/billaul/active_period/issues
+  homepage_uri: https://github.com/billaul/active_period
+  documentation_uri: https://github.com/billaul/active_period
+  source_code_uri: https://github.com/billaul/active_period
 post_install_message:
 rdoc_options: []
 require_paths: