date_continuity 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ee5b11ae14a9e2e58653f628b51f24a17d14d4ee29db368efd5694bcd7b7d1
-  data.tar.gz: d2624c3cd86dd005c36cf93b95bb3a31d35d11be59a97b35504668d8a2317df5
+  metadata.gz: 53e852c09e2708211c4e1e449ebb9dcb6be20c63b4194b0499896e3109576ab1
+  data.tar.gz: 1c3f7b52275f5119052e18cd7b27c394d3041b863061feb4e127e2094996ac12
 SHA512:
-  metadata.gz: 1771d384dcf7c1eb59a777de9e80ba18e3e32a3916f7105b20560c4ddba32d9abb3479ad5b7cc2b995fc0418eaeccf08d61ba63c0a7d64401066a411fac31b26
-  data.tar.gz: 695482edc786be5d2d3a51e4a2f7df7eb74339d221c6d1a51e0ee1f93aa8955e76d37308ee07cf74810cedcc8164ef1b62f8d99df3cc8c297e12fc7aa43e7ed4
+  metadata.gz: 951f4f4338f3c6dab46df4e5b5a929610fb41b48335001a8f9303e4af8704a9549421a5e741ec4bfe93703920181ff18a3e2ce4c182f79239ebcefb7e56b8f35
+  data.tar.gz: 1c83dd1a839c7d0293d189f5bab0940175473801592d4b050aaba71ac65a8fdd161277a96f6804d93973793017a80703d30ea74207daf36bea181aedab87a2a2

data/lib/date_continuity/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DateContinuity
+  class Configuration
+    attr_accessor :duration_method, :end_method, :frequency_count_method, :start_method, :time_unit_method
+
+    def initialize
+      @duration_method = :duration
+      @end_method = :end_at
+      @frequency_count_method = :frequency
+      @start_method = :start_at
+      @time_unit_method = :time_unit
+    end
+  end
+end

data/lib/date_continuity/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DateContinuity
+  class UnsupportedTimeUnitError < StandardError
+    def initialize(time_unit_value)
+      super(
+        "Unsupported time unit #{time_unit_value}. \
+        Must be one of the following: \
+        #{DateContinuity::Model::TIME_UNIT_VALUES.to_sentence(last_word_connector: " or ")}".squish
+        )
+    end
+  end
+
+  class NotEnoughInformationError < StandardError
+    def initialize(missing_columns)
+      super("Missing Information: #{missing_columns.to_sentence} must be set.")
+    end
+  end
+
+  module Errors
+    extend ActiveSupport::Concern
+
+    def _raise_unsupported_time_unit_error(value)
+      raise UnsupportedTimeUnitError.new(value)
+    end
+
+    def _raise_not_enough_information_error(required_columns)
+      raise NotEnoughInformationError.new(required_columns)
+    end
+  end
+end

data/lib/date_continuity/model.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "date_continuity/errors"
+require "date_continuity/time_between"
+require "date_continuity/occurrences"
+
+module DateContinuity
+  module Model
+    TIME_UNIT_VALUES = %w(second minute hour day week month year).freeze
+    DAY_EQUIVALENTS = {
+      second: 86_400,
+      minute: 1_440,
+      hour: 24,
+      day: 1,
+      week: (1.0 / 7.0)
+    }.freeze
+
+    extend ActiveSupport::Concern
+
+    delegate :duration_method, :end_method, :frequency_count_method,
+             :start_method, :time_unit_method, to: :config
+
+    included do
+      include DateContinuity::Errors
+      include DateContinuity::TimeBetween
+      include DateContinuity::Occurrences
+
+      alias_method "calc_#{DateContinuity.configuration.duration_method}".to_sym, :calc_duration
+      alias_method "calc_#{DateContinuity.configuration.end_method}".to_sym, :calc_end
+      alias_method "calc_#{DateContinuity.configuration.start_method}".to_sym, :calc_start
+    end
+
+    # Calculation Methods
+
+    def calc_end
+      if start_value.present? && duration_value.present?
+        start_value + duration_object
+      else
+        _raise_not_enough_information_error [start_method, duration_method]
+      end
+    end
+
+    def calc_start
+      if end_value.present? && duration_value.present?
+        end_value - duration_object
+      else
+        _raise_not_enough_information_error [end_method, duration_method]
+      end
+    end
+
+    def calc_duration(start_datetime = start_value, end_datetime = end_value)
+      # DateTime subtraction returns a fraction representing days
+      if start_datetime && end_datetime
+        duration = case time_unit_value
+                    when "month" then months_between(start_datetime, end_datetime)
+                    when "year" then years_between(start_datetime, end_datetime)
+                    else
+                      (end_datetime - start_datetime) * DAY_EQUIVALENTS[time_unit_value.to_sym]
+                    end + 1
+        (duration * frequency_value).to_i
+      else
+        _raise_not_enough_information_error [start_method, end_method]
+      end
+    end
+
+    def duration_object(duration = duration_value - 1)
+      (duration.public_send(time_unit_value) / frequency_value)
+    end
+
+    # Setter methods
+
+    def set_duration
+      send("#{duration_method}=", calc_duration)
+      self
+    end
+
+    def set_end
+      send("#{end_method}=", calc_end)
+      self
+    end
+
+    def set_start
+      send("#{start_method}=", calc_start)
+      self
+    end
+
+    private
+
+    def config
+      @config ||= DateContinuity.configuration
+    end
+
+    def interval_object
+      1.public_send(time_unit_value) / frequency_value
+    end
+
+    def time_unit_less_than_day?
+      DAY_EQUIVALENTS[time_unit_value.to_sym] && DAY_EQUIVALENTS[time_unit_value.to_sym] < 1
+    end
+
+    # Getter methods
+    def start_value
+      public_send(start_method)&.to_datetime
+    end
+
+    def end_value
+      public_send(end_method)&.to_datetime
+    end
+
+    def duration_value
+      public_send(duration_method).to_i
+    end
+
+    def frequency_value
+      if respond_to?(frequency_count_method)
+        send(frequency_count_method).to_f
+      else
+        1.0
+      end
+    end
+
+    def time_unit_value
+      send(time_unit_method).downcase.singularize.tap do |value|
+        _raise_unsupported_time_unit_error(value) unless TIME_UNIT_VALUES.include?(value)
+      end
+    end
+  end
+end

data/lib/date_continuity/occurrences.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DateContinuity
+  module Occurrences
+    extend ActiveSupport::Concern
+
+    def all_occurrences
+      if start_value.present? && duration_value.present?
+        Array.new(duration_value) do |count|
+          start_value + duration_object(count)
+        end
+      else
+        _raise_not_enough_information_error [start_method, duration_method]
+      end
+    end
+
+    def prev_occurrence(current_time = DateTime.current)
+      set_start if start_value.blank?
+      current_time = current_time.beginning_of_day unless time_unit_less_than_day?
+      return if start_value >= current_time
+
+      duration_from_start_to_now = calc_duration(start_value, current_time) - 1
+      start_value + duration_object(duration_from_start_to_now)
+    end
+
+    def next_occurrence(current_time = DateTime.current)
+      set_end if end_value.blank?
+      current_time = current_time.beginning_of_day unless time_unit_less_than_day?
+      return if current_time >= end_value
+      return start_value unless prev_occurrence(current_time)
+
+      prev_occurrence(current_time) + interval_object
+    end
+  end
+end

data/lib/date_continuity.rb

@@ -2,14 +2,19 @@
 
 require "active_record"
 
+require "date_continuity/configuration"
 require "date_continuity/model"
 
 module DateContinuity
-  class << self
-    attr_accessor :duration_method, :end_method, :frequency_count_method, :start_method, :time_unit_method
+  def self.configuration
+    @configuration ||= DateContinuity::Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
   end
 
   def self.configure
-    yield self
+    yield configuration
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: date_continuity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Merritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
-dependencies: []
+date: 2022-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Calculate fields based on a minimum set of information.
 email: andrew.w.merritt@gmail.com
 executables: []
@@ -17,7 +31,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/date_continuity.rb
-homepage: https://rubygems.org/gems/date_continuity
+- lib/date_continuity/configuration.rb
+- lib/date_continuity/errors.rb
+- lib/date_continuity/model.rb
+- lib/date_continuity/occurrences.rb
+homepage: https://github.com/amerritt14/date_continuity
 licenses:
 - MIT
 metadata: {}