active_period 6.2.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba2a2ea208d8904f845e463f8f82f96590dce4f2ad10557a77f30bc9065380d
-  data.tar.gz: 869c18ddc605ccc8fa4cd23da17bfad196e4cdc92de3c1fed5f378d66c2351cc
+  metadata.gz: f52b743020890ffb49224e7b0dd129901233a4d1cdd639d412a88872c66b97d0
+  data.tar.gz: 0eb862ce0e5aa128ce81fd93e28dd887c64f0f70ec000c9dd7988e281288be39
 SHA512:
-  metadata.gz: b0287446e67fa3f801b70fcfe6fbf1190a9ac2f3957dc3ffd3cb499046e9f3ae8910ca01d5aa6142a0816012bc0db8505f93fccf432d7e1b7f4b624edcd112e2
-  data.tar.gz: aa43b0db9103fb16e82b84ea29c62783d100b83b742f89393f2aaca73348da6d0aaeef6ee9623252e55e7f7dd4c721bcdba0fdaff9e74d11cbe50c50d7ff356a
+  metadata.gz: bce08f3f5b1b10347469b43a832d525bec3a470b09e798539f84bc80b4aca768898734565acadf5600670fcbb9e7a3e6a427b9c4fcbccc402e5b5c0109a05a62
+  data.tar.gz: 5e3dcdb1f0328b1baf28ad298e951d893c9e9102faa703890ba47f3c6983947c666dad61e810364ff2bb2b4648542be859d7bfee5f081472da4bb7d3293da07a

data/Gemfile.lock

@@ -1,26 +1,65 @@
 PATH
   remote: .
   specs:
-    active_period (6.2.0)
-      activesupport (~> 5)
+    active_period (7.0.0)
+      activesupport (~> 7, >= 5)
       i18n (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.5)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.8)
-    i18n (1.8.10)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    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.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    minitest (5.15.0)
+    multi_test (0.1.2)
     rake (10.5.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   ruby
@@ -28,6 +67,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,30 +336,31 @@ 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)
 ```
 
-## Planned updates
+## Planned updates & Idea
 
 - [ ] ActiveRecord Serializer (maybe)
-- [ ] Holidays support (gem Holidays) -> COMING SOON
+- [ ] Dedicated Exception for each possible error
 
 ## 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', '~> 7'
   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.0'.freeze
+  VERSION = '7.0.0'.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
-  def self.new(*args)
-    ActivePeriod::FreePeriod.new(*args)
+
+  # Shorthand to ActivePeriod::FreePeriod.new
+  def self.new(range, allow_beginless: true, allow_endless: true)
+    ActivePeriod::FreePeriod.new(range, allow_beginless: allow_beginless, allow_endless: allow_endless)
   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.0
+  version: 7.0.0
 platform: ruby
 authors:
 - billau_l
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2022-02-22 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: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !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: