active_period 6.2.1 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31de1be46b05886d6be69b936ad0d708e0b5169f57e8c96be53be4073196bbf5
-  data.tar.gz: 6972b4d8c4178901863d9a2e6d5155ce9c1406fc1895c4d54980756652585ab5
+  metadata.gz: b844daa7cc7ef648456cbfca6a0160a4cc6f12da6977066ad8a4a310d78bad2e
+  data.tar.gz: 520d626a06a54380df33877babdb6854f338c10908d8b03a644aab2e8416b7e8
 SHA512:
-  metadata.gz: deb9549d9a5752cd99b98fa3943d6a1b19f07b505319e99439bcfd9f1b1d716d1424c21fc2f60ac1fc9954e06b96ee3473646a3472deb4a28d8cfb3ad6367ea5
-  data.tar.gz: ed10625ee2779f305739b4ff1f3295d2d66a8cd21cb8371cbe2cde6d2686eedce85d21e845a9171d837b9db075cd0ffefdc6f27693538d57b25f9972720040aa
+  metadata.gz: 63a99d4de2e83d52f0c24e1110ad4e37acbad1d7980ea5b6d4c1084dfaae1a676e05a4850f3bb903e725f8c1ca98d09db9b1a14d102cd9686a844b12ca9f84d3
+  data.tar.gz: 11f0c8d57e2995e8a745885bddcc8b268920e65d30309048da2f0aeb9d4faa0cee43225f7686529995c6e919e0da1940f0c40d8b3b3ea93c299bf1662750798e

data/Gemfile.lock

@@ -1,26 +1,68 @@
 PATH
   remote: .
   specs:
-    active_period (6.2.0)
-      activesupport (~> 5)
+    active_period (6.3.0)
+      activesupport (~> 6, >= 5)
       i18n (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.5)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.1.8)
+      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)
+    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
@@ -28,6 +70,7 @@ PLATFORMS
 DEPENDENCIES
   active_period!
   bundler (~> 2.0)
+  cucumber
   rake (~> 10.0)
 
 BUNDLED WITH

data/README.md

@@ -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
@@ -333,21 +336,22 @@ 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 holidays in the next week
+Period.next_week.holidays(:us)
 
-# Get all US and CA holidays in the current month
-Period.this_month.holidays(:us, :ca)
+# Get all US and CA holidays in the prev quarter
+Period.prev_quarter.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 = (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 within the same options of the original `.holidays` collection
+# 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`
+: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)
@@ -356,7 +360,6 @@ Period.this_month.holidays
 ## Planned updates
 
 - [ ] ActiveRecord Serializer (maybe)
-- [ ] Holidays support (gem Holidays) -> COMING SOON
 
 ## Bug reports
 

data/active_period.gemspec

@@ -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/version.rb

@@ -1,5 +1,5 @@
 module ActivePeriod
 
-  VERSION = '6.2.1'.freeze
+  VERSION = '6.3.1'.freeze
 
 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/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.2.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: []