sof-cycle 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea1c2c9a48bba72114b7681278cd467c57ee147f6f8b1ff176b4508de355920b
-  data.tar.gz: 93a7560799df4730a5eaf2d14708b9a24199c0a95d2b01f1487ddc587b0846da
+  metadata.gz: e06eb27369a120ec1af76b5d96d6131e10dd7c5293a77a3a9f9a871f7782ccf9
+  data.tar.gz: f11c960b91981332057aba2bf3d5226d841b3e87b558f1b526f5e9a33fc7b011
 SHA512:
-  metadata.gz: baf569f5fb7e0500b8a28915c8f19b86dc97ebee380301787182216d162fd02e659645345d369440959ebde737b59bb8ddd4372dae0bf014a9e3b448e8455e03
-  data.tar.gz: 84756e0428c56a7f6dd72e5dc7aa545a587bbffd49479a436e4f8bee2d60ec3496e128f713a36b0169799ff908e0690e4518b147e750eaa0fb662681f0e036a0
+  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.2] - 2024-08-09
+## [0.1.3] - 2024-09-01
 
-### Added
+### Fixed
 
-- `Cycle#recurring?` to reveal if a given Cycle is one-and-done or must be repeated.
+- `Cycles::EndOf` to have the correct behavior
 
-## [0.1.1] - 2024-08-09
+## [0.1.2] - 2024-08-09
 
 ### Added
 
-- 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
+- `Cycle#recurring?` to reveal if a given Cycle is one-and-done or must be repeated.

data/lib/sof/cycle/version.rb

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

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
@@ -16,8 +24,34 @@ module SOF
         "#{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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sof-cycle
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  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
@@ -84,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.