sof-cycle 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a371875b67c2b91bcda00cd042bfa8f4daed5c0ecdbdff66b5680f546b039435
-  data.tar.gz: 720805643f533158704ad8316a95f0cf1d31b02681a4a7654a4e859951216242
+  metadata.gz: e06eb27369a120ec1af76b5d96d6131e10dd7c5293a77a3a9f9a871f7782ccf9
+  data.tar.gz: f11c960b91981332057aba2bf3d5226d841b3e87b558f1b526f5e9a33fc7b011
 SHA512:
-  metadata.gz: 48aa749e3b0c8a8c810d8e863025af1dadc964348f4f98670f03fade2da9aded8be063c2fe7893ee50b3f9836de3658dc93137a8c41fa9e7afd33e8a51e8c3b3
-  data.tar.gz: 18148c4e037cd7edd5749ac2c216d13e63ac581065a2a6d45101947dfa5b9d041e611bbc64d36d20336c846cc0272c7eb3eeb077831372661de1512d2f0e3f2c
+  metadata.gz: '0808c221b655153d9bb4ae49cbf004586e320bc83f445a493b8dce07d0c15ab6c4c4b6675f1a7ff0f5be0698cd6d2b3961ee9cf0cfebfdd8173c812dc9c672ad'
+  data.tar.gz: 551deeaedd7f8a54667af773685e46d19d24b43a49a4f1578ac04e2482038f21ae4ac20a17a0adc99d91189f5a7966712e9b271eb45c14d46baa6b1dba8e568c

data/CHANGELOG.md

@@ -5,18 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.1] - 2024-08-09
+## [0.1.3] - 2024-09-01
 
-### Added
+### Fixed
 
-- Basic example in README.md
-- Add `Cycles::EndOf` to handle cycles that cover through the end of the nth
-  subsequent period
-- Add predicate methods for each `Cycle` subclass. E.g. `#dormant?`, `#within?`, etc
-- Refactor into namespaces
+- `Cycles::EndOf` to have the correct behavior
 
-## [0.1.0] - 2024-07-09
+## [0.1.2] - 2024-08-09
 
 ### Added
 
-- Initial extraction
+- `Cycle#recurring?` to reveal if a given Cycle is one-and-done or must be repeated.

data/checksums/sof-cycle-0.1.2.gem.sha512

@@ -0,0 +1 @@
+78a488a4cea134800aeca3e3e06461a413c564b111d96b25a74c4ae44b5afa66a04d4c59be33cc455bab0c9b1d80cfdd3af1b980859ae3955cb1fd7350fe1459

data/lib/sof/cycle/version.rb

@@ -2,6 +2,6 @@
 
 module SOF
   class Cycle
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end

data/lib/sof/cycle.rb

@@ -25,7 +25,7 @@ module SOF
 
     delegate [:activated_notation, :volume, :from, :from_date, :time_span, :period,
       :humanized_period, :period_key, :active?] => :@parser
-    delegate [:kind, :volume_only?, :valid_periods] => "self.class"
+    delegate [:kind, :recurring?, :volume_only?, :valid_periods] => "self.class"
     delegate [:period_count, :duration] => :time_span
     delegate [:calendar?, :dormant?, :end_of?, :lookback?, :volume_only?,
       :within?] => :kind_inquiry
@@ -130,10 +130,11 @@ module SOF
     @kind = nil
     @valid_periods = []
 
-    def self.volume_only? = @volume_only
-
     class << self
       attr_reader :notation_id, :kind, :valid_periods
+      def volume_only? = @volume_only
+
+      def recurring? = raise "#{name} must implement #{__method__}"
     end
 
     # Raises an error if the given period isn't in the list of valid periods.

data/lib/sof/cycles/calendar.rb

@@ -12,6 +12,8 @@ module SOF
         def frame_of_reference = "total"
       end
 
+      def self.recurring? = true
+
       def to_s
         "#{volume}x every #{period_count} calendar #{humanized_period}"
       end

data/lib/sof/cycles/dormant.rb

@@ -10,6 +10,8 @@ module SOF
 
       attr_reader :cycle, :parser
 
+      def self.recurring? = false
+
       def kind = :dormant
 
       def dormant? = true

data/lib/sof/cycles/end_of.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+# Captures the logic for enforcing the EndOf cycle variant
+#   E.g. "V1E18MF2020-01-05" means:
+#     You're good until the end of the 17th subsequent month from 2020-01-05.
+#     Complete 1 by that date to reset the cycle.
+#
+# Some of the calculations are quite different from other cycles.
+# Whereas other cycles look at completion dates to determine if the cycle is
+# satisfied, this cycle checks whether the anchor date is prior to the final date.
 module SOF
   module Cycles
     class EndOf < Cycle
@@ -8,14 +16,42 @@ module SOF
       @kind = :end_of
       @valid_periods = %w[W M Q Y]
 
+      def self.recurring? = true
+
       def to_s
         return dormant_to_s if dormant?
 
         "#{volume}x by #{final_date.to_fs(:american)}"
       end
 
+      # Returns the expiration date for the cycle
+      #
+      # @param [nil] _ Unused parameter, maintained for compatibility
+      # @param anchor [nil] _ Unused parameter, maintained for compatibility
+      # @return [Date] The final date of the cycle
+      #
+      # @example
+      #   Cycle.for("V1E18MF2020-01-09")
+      #     .expiration_of(anchor: "2020-06-04".to_date)
+      #   # => #<Date: 2021-06-30>
+      def expiration_of(_ = nil, anchor: nil) = final_date
+
+      # Is the supplied anchor date prior to the final date?
+      #
+      # @return [Boolean] true if the cycle is satisfied, false otherwise
+      def satisfied_by?(_ = nil, anchor: Date.current) = anchor <= final_date
+
+      # Calculates the final date of the cycle
+      #
+      # @param [nil] _ Unused parameter, maintained for compatibility
+      # @return [Date] The final date of the cycle calculated as the end of the
+      #   nth subsequent period after the FROM date, where n = (period count - 1)
+      #
+      # @example
+      #   Cycle.for("V1E18MF2020-01-09").final_date
+      #   # => #<Date: 2021-06-30>
       def final_date(_ = nil) = time_span
-        .end_date(start_date)
+        .end_date(start_date - 1.send(period))
         .end_of_month
 
       def start_date(_ = nil) = from_date.to_date

data/lib/sof/cycles/lookback.rb

@@ -8,6 +8,8 @@ module SOF
       @kind = :lookback
       @valid_periods = %w[D W M Y]
 
+      def self.recurring? = true
+
       def to_s = "#{volume}x in the prior #{period_count} #{humanized_period}"
 
       def volume_to_delay_expiration(completion_dates, anchor:)

data/lib/sof/cycles/volume_only.rb

@@ -19,6 +19,8 @@ module SOF
         end
       end
 
+      def self.recurring? = false
+
       def to_s = "#{volume}x total"
 
       def covered_dates(dates, ...) = dates

data/lib/sof/cycles/within.rb

@@ -8,6 +8,8 @@ module SOF
       @kind = :within
       @valid_periods = %w[D W M Y]
 
+      def self.recurring? = false
+
       def to_s = "#{volume}x within #{date_range}"
 
       def date_range

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sof-cycle
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwardable
@@ -52,6 +52,7 @@ files:
 - Rakefile
 - checksums/sof-cycle-0.1.0.gem.sha512
 - checksums/sof-cycle-0.1.1.gem.sha512
+- checksums/sof-cycle-0.1.2.gem.sha512
 - lib/sof-cycle.rb
 - lib/sof/cycle.rb
 - lib/sof/cycle/version.rb
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Parse and interact with SOF cycle notation.