sof-cycle 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e06eb27369a120ec1af76b5d96d6131e10dd7c5293a77a3a9f9a871f7782ccf9
-  data.tar.gz: f11c960b91981332057aba2bf3d5226d841b3e87b558f1b526f5e9a33fc7b011
+  metadata.gz: f9b1ae30ef2bd0d0fb9dbc08efb701b9813d997c216a22bf1df67fcbed7efe29
+  data.tar.gz: ac73534e2d48354722e929e41fccf0bae4a913466b181802daa8afe3daa9beae
 SHA512:
-  metadata.gz: '0808c221b655153d9bb4ae49cbf004586e320bc83f445a493b8dce07d0c15ab6c4c4b6675f1a7ff0f5be0698cd6d2b3961ee9cf0cfebfdd8173c812dc9c672ad'
-  data.tar.gz: 551deeaedd7f8a54667af773685e46d19d24b43a49a4f1578ac04e2482038f21ae4ac20a17a0adc99d91189f5a7966712e9b271eb45c14d46baa6b1dba8e568c
+  metadata.gz: 6b4a0d60e48feed105e71c6410e4ba22152e88ed8502b43b32974e585cc1abce432867b0c635ada9376258df79d799d2f3f383e4499742f5023db623a4ac8ebe
+  data.tar.gz: e506926aed85332f02e8f5790ec752416679fe9a0c1542bd750f6097d204c4ed4237a866cc4552e67f612218ae58dbb819f68260de67e84fcf32b3d78351e0ba

data/CHANGELOG.md

@@ -5,14 +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.3] - 2024-09-01
+## [0.1.4] - 2024-09-02
 
-### Fixed
+### Added
 
-- `Cycles::EndOf` to have the correct behavior
+- `Cycle#last_completed` to return the last completion given the cycle and an array of dates
 
-## [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

data/lib/sof/cycle/version.rb

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

data/lib/sof/cycle.rb

@@ -11,142 +11,142 @@ module SOF
 
     class InvalidKind < InvalidInput; end
 
-    def initialize(notation, parser: Parser.new(notation))
-      @notation = notation
-      @parser = parser
-      validate_period
+    class << self
+      # Turn a cycle or notation string into a hash
+      def dump(cycle_or_string)
+        if cycle_or_string.is_a? Cycle
+          cycle_or_string
+        else
+          Cycle.for(cycle_or_string)
+        end.to_h
+      end
 
-      return if @parser.valid?
+      # Return a Cycle object from a hash
+      def load(hash)
+        symbolized_hash = hash.symbolize_keys
+        cycle_class = class_for_kind(symbolized_hash[:kind])
 
-      raise InvalidInput, "'#{notation}' is not a valid input"
-    end
+        unless cycle_class.valid_periods.empty?
+          cycle_class.validate_period(
+            TimeSpan.notation_id_from_name(symbolized_hash[:period])
+          )
+        end
 
-    attr_reader :parser
+        Cycle.for notation(symbolized_hash)
+      rescue TimeSpan::InvalidPeriod => exc
+        raise InvalidPeriod, exc.message
+      end
 
-    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
+      # Retun a notation string from a hash
+      #
+      # @param hash [Hash] hash of data for a valid Cycle
+      # @return [String] string representation of a Cycle
+      def notation(hash)
+        volume_notation = "V#{hash.fetch(:volume) { 1 }}"
+        return volume_notation if hash[:kind].nil? || hash[:kind].to_sym == :volume_only
+
+        cycle_class = class_for_kind(hash[:kind].to_sym)
+        [
+          volume_notation,
+          cycle_class.notation_id,
+          TimeSpan.notation(hash.slice(:period, :period_count)),
+          hash.fetch(:from, nil)
+        ].compact.join
+      end
 
-    # Turn a cycle or notation string into a hash
-    def self.dump(cycle_or_string)
-      if cycle_or_string.is_a? Cycle
-        cycle_or_string
-      else
-        Cycle.for(cycle_or_string)
-      end.to_h
-    end
+      # Return a Cycle object from a notation string
+      #
+      # @param notation [String] a string notation representing a Cycle
+      # @example
+      #   Cycle.for('V2C1Y)
+      # @return [Cycle] a Cycle object representing the provide string notation
+      def for(notation)
+        return notation if notation.is_a? Cycle
+        return notation if notation.is_a? Cycles::Dormant
+        parser = Parser.new(notation)
+        unless parser.valid?
+          raise InvalidInput, "'#{notation}' is not a valid input"
+        end
+
+        cycle = cycle_handlers.find do |klass|
+          parser.parses?(klass.notation_id)
+        end.new(notation, parser:)
+        return cycle if parser.active?
+
+        Cycles::Dormant.new(cycle, parser:)
+      end
 
-    # Return a Cycle object from a hash
-    def self.load(hash)
-      symbolized_hash = hash.symbolize_keys
-      cycle_class = class_for_kind(symbolized_hash[:kind])
+      # Return the appropriate class for the give notation id
+      #
+      # @param notation [String] notation id matching the kind of Cycle class
+      # @example
+      #   class_for_notation_id('L')
+      #
+      def class_for_notation_id(notation_id)
+        cycle_handlers.find do |klass|
+          klass.notation_id == notation_id
+        end || raise(InvalidKind, "'#{notation_id}' is not a valid kind of #{name}")
+      end
 
-      unless cycle_class.valid_periods.empty?
-        cycle_class.validate_period(
-          TimeSpan.notation_id_from_name(symbolized_hash[:period])
-        )
+      # Return the class handling the kind
+      #
+      # @param sym [Symbol] symbol matching the kind of Cycle class
+      # @example
+      #   class_for_kind(:lookback)
+      def class_for_kind(sym)
+        Cycle.cycle_handlers.find do |klass|
+          klass.handles?(sym)
+        end || raise(InvalidKind, "':#{sym}' is not a valid kind of Cycle")
       end
 
-      Cycle.for notation(symbolized_hash)
-    rescue TimeSpan::InvalidPeriod => exc
-      raise InvalidPeriod, exc.message
-    end
+      def cycle_handlers = @cycle_handlers ||= Set.new
 
-    # Retun a notation string from a hash
-    #
-    # @param hash [Hash] hash of data for a valid Cycle
-    # @return [String] string representation of a Cycle
-    def self.notation(hash)
-      volume_notation = "V#{hash.fetch(:volume) { 1 }}"
-      return volume_notation if hash[:kind].nil? || hash[:kind].to_sym == :volume_only
-
-      cycle_class = class_for_kind(hash[:kind].to_sym)
-      [
-        volume_notation,
-        cycle_class.notation_id,
-        TimeSpan.notation(hash.slice(:period, :period_count)),
-        hash.fetch(:from, nil)
-      ].compact.join
-    end
+      def inherited(klass) = cycle_handlers << klass
 
-    # Return a Cycle object from a notation string
-    #
-    # @param notation [String] a string notation representing a Cycle
-    # @example
-    #   Cycle.for('V2C1Y)
-    # @return [Cycle] a Cycle object representing the provide string notation
-    def self.for(notation)
-      return notation if notation.is_a? Cycle
-      return notation if notation.is_a? Cycles::Dormant
-      parser = Parser.new(notation)
-      unless parser.valid?
-        raise InvalidInput, "'#{notation}' is not a valid input"
+      def handles?(sym)
+        sym && kind == sym.to_sym
       end
 
-      cycle = cycle_handlers.find do |klass|
-        parser.parses?(klass.notation_id)
-      end.new(notation, parser:)
-      return cycle if parser.active?
+      @volume_only = false
+      @notation_id = nil
+      @kind = nil
+      @valid_periods = []
 
-      Cycles::Dormant.new(cycle, parser:)
-    end
+      attr_reader :notation_id, :kind, :valid_periods
+      def volume_only? = @volume_only
 
-    # Return the appropriate class for the give notation id
-    #
-    # @param notation [String] notation id matching the kind of Cycle class
-    # @example
-    #   class_for_notation_id('L')
-    #
-    def self.class_for_notation_id(notation_id)
-      cycle_handlers.find do |klass|
-        klass.notation_id == notation_id
-      end || raise(InvalidKind, "'#{notation_id}' is not a valid kind of #{name}")
-    end
+      def recurring? = raise "#{name} must implement #{__method__}"
 
-    # Return the class handling the kind
-    #
-    # @param sym [Symbol] symbol matching the kind of Cycle class
-    # @example
-    #   class_for_kind(:lookback)
-    def self.class_for_kind(sym)
-      Cycle.cycle_handlers.find do |klass|
-        klass.handles?(sym)
-      end || raise(InvalidKind, "':#{sym}' is not a valid kind of Cycle")
+      # Raises an error if the given period isn't in the list of valid periods.
+      #
+      # @param period [String] period matching the class valid periods
+      # @raise [InvalidPeriod]
+      def validate_period(period)
+        raise InvalidPeriod, <<~ERR.squish unless valid_periods.include?(period)
+          Invalid period value of '#{period}' provided. Valid periods are:
+          #{valid_periods.join(", ")}
+        ERR
+      end
     end
 
-    def self.cycle_handlers = @cycle_handlers ||= Set.new
+    def initialize(notation, parser: Parser.new(notation))
+      @notation = notation
+      @parser = parser
+      validate_period
 
-    def self.inherited(klass) = cycle_handlers << klass
+      return if @parser.valid?
 
-    def self.handles?(sym)
-      sym && kind == sym.to_sym
+      raise InvalidInput, "'#{notation}' is not a valid input"
     end
 
-    @volume_only = false
-    @notation_id = nil
-    @kind = nil
-    @valid_periods = []
-
-    class << self
-      attr_reader :notation_id, :kind, :valid_periods
-      def volume_only? = @volume_only
-
-      def recurring? = raise "#{name} must implement #{__method__}"
-    end
+    attr_reader :parser
 
-    # Raises an error if the given period isn't in the list of valid periods.
-    #
-    # @param period [String] period matching the class valid periods
-    # @raise [InvalidPeriod]
-    def self.validate_period(period)
-      raise InvalidPeriod, <<~ERR.squish unless valid_periods.include?(period)
-        Invalid period value of '#{period}' provided. Valid periods are:
-        #{valid_periods.join(", ")}
-      ERR
-    end
+    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
 
     def kind_inquiry = ActiveSupport::StringInquirer.new(kind.to_s)
 
@@ -162,6 +162,9 @@ module SOF
     # Cycles are considered equal if their hash representations are equal
     def ==(other) = to_h == other.to_h
 
+    # Return the most recent completion date from the supplied array of dates
+    def last_completed(dates) = dates.compact.map(&:to_date).max
+
     # From the supplied anchor date, are there enough in-window completions to
     # satisfy the cycle?
     #

data/lib/sof/cycles/end_of.rb

@@ -24,6 +24,9 @@ module SOF
         "#{volume}x by #{final_date.to_fs(:american)}"
       end
 
+      # Always returns the from_date
+      def last_completed(_) = from_date.to_date
+
       # Returns the expiration date for the cycle
       #
       # @param [nil] _ Unused parameter, maintained for compatibility

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sof-cycle
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwardable