sof-cycle 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a3b894aa388fbe5e272203915060486d219d54872ee3f54bbbc9aed3c343d7
-  data.tar.gz: 4023edaf4b2c668680d4fb7147f920b7dff727ade6bc02a64c5d928dabc5bbd5
+  metadata.gz: 0eb9458907426d68d8fc05c159a9bb782819b2ec821baf2ec24109b45c6794ff
+  data.tar.gz: e4c0b55074d59aad3f4e562e579759d8d85413b1fd93c93c873b79bdbff1c629
 SHA512:
-  metadata.gz: 32ed188de45051c75b5e9fc41f26f59ccba11e2432eb7714601eed2baa581a70b00136cd7b7e8c5bac50d5966dca221540b92e570c6ac06aa7bbfe9a1be72123
-  data.tar.gz: e2b243c6387a5a79b7c1dfda6c7a2efb31f692f5196924abf7351bcfbf9ba87e7416e5528533f9a7ab29c7200c709e9b2d426a00db8222c570621bd16b040210
+  metadata.gz: c799aed72bf8973a8b6438cab7d2635f2563575fcf3d16eac4b4bf38df409953000d78afc8b691ed4b5e4eb40b39a7969858e79d9ee844697ce113e1f0170ae5
+  data.tar.gz: c99b76559985729d0ea59ee3ff5be523500965578c450c85a90c24fd2d958ebd6eb4ff4ad550d101e8178423f2f39d02ffe79a47a28f716e34865c4028ce83a5

data/CHANGELOG.md

@@ -5,10 +5,22 @@ 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.11] - 2025-09-05
+## [0.1.13] - 2026-03-20
+
+### Added
+
+- Interval cycle kind (`I` notation) — repeating windows anchored to a from_date that re-anchor from completion date (e.g., `V1I24MF2026-03-31`)
 
 ### Changed
 
-- Use `time_span.notation` instead of `TimeSpan.notation` in `Cycle#notation`.
+- Dormant capability is now declared on each cycle class (`def self.dormant_capable? = true`) instead of only in `Parser.dormant_capable_kinds`
+
+### Fixed
+
+- EndOf cycle `final_date` was off by one period — `V1E12M` now correctly expires at the end of the 12th month, not the 11th
+
+## [0.1.12] - 2025-09-05
+
+### Added
 
-## [0.1.10] - 2025-09-04
+- Missing code coverage and updated EndOf to properly handle dormant cycles.

data/README.md

@@ -25,7 +25,9 @@ cycle.to_s # => "3x in the prior 3 days"
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+This project is managed with [Reissue](https://github.com/SOFware/reissue). Releases are automated via the [shared release workflow](https://github.com/SOFware/reissue/blob/main/.github/workflows/SHARED_WORKFLOW_README.md). Trigger a release by running the "Release gem to RubyGems.org" workflow from the Actions tab.
 
 ## Contributing
 

data/Rakefile

@@ -14,4 +14,5 @@ require "reissue/gem"
 
 Reissue::Task.create do |task|
   task.version_file = "lib/sof/cycle/version.rb"
+  task.push_finalize = :branch
 end

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

@@ -0,0 +1 @@
+3ce0dfe7d95a5cde507d7563ca9aa834457913dff9861d36547cff571fa9371be9fdeb60ec6892edb23b14945ab7a25f569d86cb023b67adfd3028a4570ac381

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

@@ -0,0 +1 @@
+e7091d8a602dd216e947b2c0207ad66383b0322646c1b3ab4eacd670cd885035d3bf6e1e5ba3c848466aa9989f298ef8993fd1a260559953bb47a866cc613a52

data/lib/sof/cycle/version.rb

@@ -2,6 +2,6 @@
 
 module SOF
   class Cycle
-    VERSION = "0.1.11"
+    VERSION = "0.1.13"
   end
 end

data/lib/sof/cycle.rb

@@ -130,6 +130,8 @@ module SOF
       attr_reader :notation_id, :kind, :valid_periods
       def volume_only? = @volume_only
 
+      def dormant_capable? = false
+
       def recurring? = raise "#{name} must implement #{__method__}"
 
       # Raises an error if the given period isn't in the list of valid periods.
@@ -215,12 +217,13 @@ module SOF
 
     attr_reader :parser
 
-    delegate [:activated_notation, :volume, :from, :from_date, :time_span, :period,
+    delegate [:activated_notation, :volume, :from,
+      :from_date, :time_span, :period,
       :humanized_period, :period_key, :active?] => :@parser
     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
+    delegate [:calendar?, :dormant?, :end_of?, :interval?, :lookback?,
+      :volume_only?, :within?] => :kind_inquiry
 
     def kind_inquiry = ActiveSupport::StringInquirer.new(kind.to_s)
 

data/lib/sof/cycles/end_of.rb

@@ -2,7 +2,7 @@
 
 # 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.
+#     You're good until the end of the 18th month from 2020-01-05.
 #     Complete 1 by that date to reset the cycle.
 #
 # Some of the calculations are quite different from other cycles.
@@ -18,6 +18,8 @@ module SOF
 
       def self.recurring? = true
 
+      def self.dormant_capable? = true
+
       def self.description
         "End of - occurrences by the end of a time period"
       end
@@ -27,7 +29,7 @@ module SOF
       end
 
       def to_s
-        return dormant_to_s if dormant?
+        return dormant_to_s if parser.dormant? || from_date.nil?
 
         "#{volume}x by #{final_date.to_fs(:american)}"
       end
@@ -45,39 +47,45 @@ module SOF
       #   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
+      def expiration_of(_ = nil, anchor: nil)
+        return nil if parser.dormant? || from_date.nil?
+        final_date
+      end
 
       # 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
+      def satisfied_by?(_ = nil, anchor: Date.current)
+        return false if parser.dormant? || from_date.nil?
+        anchor <= final_date
+      end
 
       # 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)
+      #   nth period after the FROM date
       #
       # @example
       #   Cycle.for("V1E18MF2020-01-09").final_date
-      #   # => #<Date: 2021-06-30>
-      def final_date(_ = nil) = time_span
-        .end_date(start_date - 1.send(period))
-        .end_of_month
+      #   # => #<Date: 2021-07-31>
+      def final_date(_ = nil)
+        return nil if parser.dormant? || from_date.nil?
+        time_span
+          .end_date(start_date)
+          .end_of_month
+      end
 
-      def start_date(_ = nil) = from_date.to_date
+      def start_date(_ = nil) = from_date&.to_date
 
       private
 
       def dormant_to_s
-        <<~DESC.squish
-          #{volume}x by the last day of the #{subsequent_ordinal}
-          subsequent #{period}
-        DESC
+        "#{volume}x by the last day of the #{ordinalized_period_count} #{period}"
       end
 
-      def subsequent_ordinal
-        ActiveSupport::Inflector.ordinalize(period_count - 1)
+      def ordinalized_period_count
+        ActiveSupport::Inflector.ordinalize(period_count)
       end
     end
   end

data/lib/sof/cycles/interval.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Captures the logic for enforcing the Interval cycle variant
+#   E.g. "V1I24MF2026-03-31" means:
+#     Complete 1 every 24 months, current window from 2026-03-31.
+#     After completion, the consuming app re-anchors from the completion date.
+#
+# Unlike EndOf, there is no end-of-month rounding.
+# Unlike Lookback, the window is anchored to a from_date, not sliding from today.
+# Unlike Within, the window is repeating — it re-anchors from the completion date.
+module SOF
+  module Cycles
+    class Interval < Cycle
+      @volume_only = false
+      @notation_id = "I"
+      @kind = :interval
+      @valid_periods = %w[D W M Y]
+
+      def self.recurring? = true
+
+      def self.dormant_capable? = true
+
+      def self.description
+        "Interval - occurrences within a repeating window that re-anchors from completion date"
+      end
+
+      def self.examples
+        ["V1I24MF2026-03-31 - once every 24 months from March 31, 2026 (re-anchors after completion)"]
+      end
+
+      def to_s
+        return dormant_to_s unless active?
+
+        "#{volume}x every #{humanized_span} from #{start_date.to_fs(:american)}"
+      end
+
+      # Returns the expiration date for the current window
+      #
+      # @return [Date, nil] The final date of the current window
+      def expiration_of(_ = nil, anchor: nil)
+        final_date
+      end
+
+      # Is the supplied anchor date within the current window?
+      #
+      # @return [Boolean] true if the anchor is before or on the final date
+      def satisfied_by?(_ = nil, anchor: Date.current)
+        anchor <= final_date
+      end
+
+      # Returns the from_date as the last completed date
+      def last_completed(_ = nil) = from_date&.to_date
+
+      # Calculates the final date of the current window
+      #
+      # @return [Date] from_date + period (no end-of-month rounding)
+      #
+      # @example
+      #   Cycle.for("V1I24MF2026-03-31").final_date
+      #   # => #<Date: 2028-03-31>
+      def final_date(_ = nil)
+        return nil if start_date.nil?
+        time_span.end_date(start_date)
+      end
+
+      def start_date(_ = nil) = from_date&.to_date
+
+      private
+
+      def dormant_to_s
+        "#{volume}x every #{humanized_span}"
+      end
+    end
+  end
+end

data/lib/sof/cycles/volume_only.rb

@@ -12,7 +12,7 @@ module SOF
         def handles?(sym) = sym.nil? || sym.to_s == "volume_only"
 
         def validate_period(period)
-          raise InvalidPeriod, <<~ERR.squish unless period.nil?
+          raise Cycle::InvalidPeriod, <<~ERR.squish unless period.nil?
             Invalid period value of '#{period}' provided. Valid periods are:
             #{valid_periods.join(", ")}
           ERR

data/lib/sof/cycles/within.rb

@@ -10,6 +10,8 @@ module SOF
 
       def self.recurring? = false
 
+      def self.dormant_capable? = true
+
       def self.description
         "Within - occurrences within a time period from a specific date"
       end

data/lib/sof/parser.rb

@@ -14,13 +14,15 @@ module SOF
     extend Forwardable
     PARTS_REGEX = /
       ^(?<vol>V(?<volume>\d*))? # optional volume
-      (?<set>(?<kind>L|C|W|E) # kind
+      (?<set>(?<kind>L|C|W|E|I) # kind
       (?<period_count>\d+) # period count
       (?<period_key>D|W|M|Q|Y)?)? # period_key
       (?<from>F(?<from_date>\d{4}-\d{2}-\d{2}))?$ # optional from
     /ix
 
-    def self.dormant_capable_kinds = %w[E W]
+    def self.dormant_capable_kinds
+      Cycle.cycle_handlers.select(&:dormant_capable?).map(&:notation_id).compact
+    end
 
     def self.for(notation_or_parser)
       return notation_or_parser if notation_or_parser.is_a? self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sof-cycle
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Jim Gay
@@ -54,6 +54,8 @@ files:
 - checksums/sof-cycle-0.1.0.gem.sha512
 - checksums/sof-cycle-0.1.1.gem.sha512
 - checksums/sof-cycle-0.1.10.gem.sha512
+- checksums/sof-cycle-0.1.11.gem.sha512
+- checksums/sof-cycle-0.1.12.gem.sha512
 - checksums/sof-cycle-0.1.2.gem.sha512
 - checksums/sof-cycle-0.1.6.gem.sha512
 - checksums/sof-cycle-0.1.7.gem.sha512
@@ -65,6 +67,7 @@ files:
 - lib/sof/cycles/calendar.rb
 - lib/sof/cycles/dormant.rb
 - lib/sof/cycles/end_of.rb
+- lib/sof/cycles/interval.rb
 - lib/sof/cycles/lookback.rb
 - lib/sof/cycles/volume_only.rb
 - lib/sof/cycles/within.rb