date_continuity 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b2c82afe0f2c75341f185beb73d42b342230a42b3a5a0c39c6d8eac0150e390
-  data.tar.gz: 3cbac97c4ef0e7180a4db12506ef1026ef718cb0b853b5b8b00b36e1b85626f2
+  metadata.gz: e1d7577b97382b9ed04948b62531e747b21117cc675443ece300ced7f64b4964
+  data.tar.gz: '03418a26403935db94bfe6a341150a24fb26fd3c06000a26387ddd6b3d68d7b7'
 SHA512:
-  metadata.gz: b8ebeb68346a77478840e90fe8014cb59f7d6008e77cf98ccc154a346948223b0b3ed468c6380aa6ca01095c6ca406f8cf6a9225e29d9b6065737e62c3124db1
-  data.tar.gz: 5d4e430a577158306fc7115cac688539e910bb9ed6190ade98507a61d6042493dbf71f38efef0380bff18d092e263e6cf3a9986363b72fb4dab8454fac2221d0
+  metadata.gz: ba63e8ae3b2ac8f05f799a0e3c03ce56355fcf163a27a0c430a86d9c1874461f3d3a016ee6b23c032aa7368cdba4026a67392e4f4086a7209b7e86149961b2ee
+  data.tar.gz: ac28c092029703ea2ebe515eb7bee03e7c57acd83bde4b27722f2198af82d96a38ff25ef5e65d1bba7085f7a2d10f6892fe889539f432f31dfd2191c147c64d5

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/time_between.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DateContinuity
+  module TimeBetween
+    extend ActiveSupport::Concern
+
+    def months_between(date1, date2)
+      earlier, later = [date1, date2].sort
+      (later.year - earlier.year) * 12 + later.month - earlier.month
+    end
+
+    def years_between(date1, date2)
+      earlier, later = [date1, date2].sort
+      diff = (later.year - earlier.year)
+
+      if earlier.month > later.month
+        diff -= 1
+      elsif earlier.month == later.month
+        if earlier.end_of_month == earlier && later.end_of_month == later
+          # no-op, account for leap years
+        elsif earlier.day > later.day
+          diff -= 1
+        end
+      end
+
+      diff
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: date_continuity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Merritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3'
 description: Calculate fields based on a minimum set of information.
 email: andrew.w.merritt@gmail.com
 executables: []
@@ -31,7 +31,12 @@ 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
+- lib/date_continuity/time_between.rb
+homepage: https://github.com/amerritt14/date_continuity
 licenses:
 - MIT
 metadata: {}