active_period 7.1.2 → 7.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e197dc4558fd215fc7090f5a14ad074e769457abfa7665b4b2393e5ba2a23d52
-  data.tar.gz: 54c3de6172706d0f08e2885b6401b3f1c964526498193a63c13af4fbfab6eb99
+  metadata.gz: 29fd67cfde1ddca02696bf27400b13b0f1887d6bd64bf4e0749d3b2395f87730
+  data.tar.gz: fdba3eaf0997e0a4ad05948269b5a09f3ec18980caa2394d3fc41fb98aee7e99
 SHA512:
-  metadata.gz: a228d61ffcb56d1f9206127e22775e2a3ec109822ce0b8242e6e778d8edb08531dd9b2834cc7def80cb42ec7cf148b2abc8776059228c5fb7b7d9cb90ec68562
-  data.tar.gz: 25550cbd55706774bfd34e68690be5d39b2e01b6681f33b3134d3c7169949c9e1d017ac40cadd24d041eef2c85d3ce6c05dbb8fe76761d6a2fabebe501230e24
+  metadata.gz: 4107662e9c026dd3d2390534ab22800bf352b51f72747f2b018443d95a7d12982f5e2f6638ea1e78630c9a889551091af2bbf4d41e9504209f50fbd441b6872d
+  data.tar.gz: 5f06ee831b6199212561ef01352c7f02b6ba455f96381bda6ec3fe2b03af627a4223f924713e811848ad34098581eef876d863f09a9c65a8c80c6e45851730bc

data/README.md

@@ -134,7 +134,7 @@ Period.week('10/02/2000') + 67.day
 **StandardPeriod** also respond to `.next` and `.prev`
 ```ruby
 Period.month('01/01/2000').next.next.next
-# Return the month of April 2020
+# Return the month of April 2000
 ```
 
 You can quickly access convenient periods of time with `.(last|this|next)_(day|week|month|quarter|year)` and `.yesterday` `.today` `.tomorrow`
@@ -242,6 +242,27 @@ Period['01/01/2021'...'09/01/2021'] | Period['10/01/2021'..'20/01/2021']
 => nil
 ```
 
+## Period clamping with `clamp_on`
+
+You can use `clamp_on` to clamp a `Period`, a date or a range of dates, within a `Period`.
+If you user `clamp_on` on a range of dates, the return value will also be a range of dates, this is to preserve hours/minutes/second precision
+:warning: The classic `clamp` apply the param to the caller. It's `42.clamp(1..10) -> 10` **and this don't exist** `(1..10).clamp(42)`      
+`clamp_on` reverse this logic, and apply the caller to the params.     
+This choice has been made to avoid a monkey patch on `clamp`
+:warning: If you `clamp_on` a `range` that don't overlap with the caller, the return value is `nil`
+
+```ruby
+Period.today.clamp_on(Period.this_week) 
+=> Period.today
+
+Period.today.clamp_on(Period.last_week)
+=> nil
+
+Period.today.clamp_on(3.from_now)
+=> # 3.from_now or today ending's time
+
+```
+
 ## Boundless Period
 
 Boundless period are fully supported and work as you expect them to do    

data/lib/active_period/comparable.rb

@@ -10,21 +10,75 @@ module ActivePeriod
         include_period?(ActivePeriod::Day.new(other))
       when ActivePeriod::Period
         include_period?(other)
+      when Range
+        include?(other.first) && include?(other.last)
       else
         raise ArgumentError, I18n.t(:incomparable_error, scope: %i[active_period comparable])
       end
     end
 
     def <=>(other)
-      raise ArgumentError, I18n.t(:incomparable_error, scope: %i[active_period comparable]) unless other.is_a?(ActiveSupport::Duration)
-
-      if other.is_a?(ActiveSupport::Duration) || other.is_a?(Numeric)
+      case other
+      when DateTime, Time, ActiveSupport::TimeWithZone
+        if first < other && last < other
+          -1
+        elsif first > other && last > other
+          1
+        else
+          0
+        end
+      when ActiveSupport::Duration, Numeric
         to_i <=> other.to_i
-      elsif self.class != other.class
-        raise ArgumentError, I18n.t(:incomparable_error, scope: %i[active_period comparable])
       else
-        (self.begin <=> other)
+        if self.class != other.class
+          raise ArgumentError, I18n.t(:incomparable_error, scope: %i[active_period comparable])
+        else
+          (self.begin <=> other)
+        end
+      end
+    end
+
+    # Reverse clamp where the `other` is clamped by `self`
+    #   If other is an ActivePeriod::Period then `clamp_on` will return an ActivePeriod::Period
+    #   If other is not an ActivePeriod::Period then `clamp_on` will return a range
+    def clamp_on(other)
+      case other
+      when DateTime, Time, ActiveSupport::TimeWithZone
+        case self <=> other
+        when -1
+          last
+        when 0
+          other
+        when 1
+          first
+        end
+      when ActivePeriod::Period
+        self & other
+      when Range
+        if (other.first > last && other.last > last) ||
+           (other.first < first && other.last < first)
+          return nil
+        end
+
+        clamped = clamp_on(other.first) .. clamp_on(other.last)
+
+        if other.is_a? ActivePeriod::Period
+          clamped.to_period
+        else
+          clamped
+        end
+      else
+        raise ArgumentError, I18n.t(:incomparable_error, scope: %i[active_period comparable])
       end
+      #
+      # new_first = other.first < first ? first : other.first
+      # new_last = other.last > last ? last : other.last
+      #
+      # if other.is_a? ActivePeriod::Period
+      #   Period.new(new_first .. new_last)
+      # else
+      #   new_first .. new_last
+      # end
     end
 
     private
@@ -32,8 +86,6 @@ module ActivePeriod
     def include_period?(other)
       if self.class.in?([Month, Quarter, Year]) && other.is_a?(Week)
         self.include_time?(other.include_date)
-      # elsif (other.class.in?([Month, Quarter, Year]) && self.is_a?(Week)
-      #   other.include_time?(self.include_date)
       else
         self.include_time?(other.begin) && self.include_time?(other.calculated_end)
       end

data/lib/active_period/period.rb

@@ -107,11 +107,11 @@ class ActivePeriod::Period < Range
     # self      5-----8
     # other  1-----------10
     elsif other.include?(self)
-      other
+      self
     # self   1-----------10
     # other      5-----8
     elsif self.include?(other)
-      self
+      other
     else
       nil
     end

data/lib/active_period/version.rb

@@ -1,5 +1,5 @@
 module ActivePeriod
 
-  VERSION = '7.1.2'.freeze
+  VERSION = '7.1.4'.freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_period
 version: !ruby/object:Gem::Version
-  version: 7.1.2
+  version: 7.1.4
 platform: ruby
 authors:
 - billau_l
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Manage time ranges without brain damage.