active_period 6.1.1

data/lib/active_period/free_period.rb

@@ -0,0 +1,86 @@
+require_relative 'has_many.rb'
+require_relative 'has_many/days.rb'
+require_relative 'has_many/weeks.rb'
+require_relative 'has_many/months.rb'
+require_relative 'has_many/quarters.rb'
+require_relative 'has_many/years.rb'
+
+module ActivePeriod
+  class FreePeriod < ActivePeriod::Period
+    include ActivePeriod::HasMany::Days
+    include ActivePeriod::HasMany::Weeks
+    include ActivePeriod::HasMany::Months
+    include ActivePeriod::HasMany::Quarters
+    include ActivePeriod::HasMany::Years
+
+    # Don't return an Integer. ActiveSupport::Duration is a better numeric
+    # representation a in time manipulation context
+    # @return [ActiveSupport::Duration] Number of day
+    def to_i
+      return Float::INFINITY if infinite?
+      days.count.days
+    end
+
+    # Shift a period to the past
+    # @params see https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html#method-i-2B
+    # @return [self] A new period of the same kind
+    def -(duration)
+      self.class.new((from - duration)..(to - duration))
+    end
+
+    # Shift a period to the future
+    # @params see https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html#method-i-2B
+    # @return [self] A new period of the same kind
+    def +(duration)
+      self.class.new((from + duration)..(to + duration))
+    end
+
+    # @param format [String] A valid format for I18n.l
+    # @return [String] Formated string
+    def strftime(format)
+      to_s(format: format)
+    end
+
+    # @param format [String] A valid format for I18n.l
+    # @return [String] Formated string
+    def to_s(format: '%d %B %Y')
+      I18n.t(bounding_format,
+             scope: %i[active_period free_period],
+             from:  I18n.l(self.begin, format: format, default: nil),
+             to:    I18n.l(self.end,   format: format, default: nil),
+             ending: I18n.t(ending, scope: %i[active_period]))
+    end
+
+    def bounding_format
+      if boundless?
+        :boundless_format
+      elsif beginless?
+        :beginless_format
+      elsif endless?
+        :endless_format
+      else
+        :default_format
+      end
+    end
+
+    def ending
+      if exclude_end?
+        :excluded
+      else
+        :included
+      end
+    end
+
+    # If no block given, it's an alias to to_s
+    # For a block {|from,to| ... }
+    # @yieldparam from [DateTime|Nil] the start of the period
+    # @yieldparam to [DateTime|Nil] the end of the period
+    # @yieldparam exclude_end? [Boolean] is the ending of the period excluded
+    def i18n(&block)
+      return yield(from, to, exclude_end?) if block.present?
+
+      to_s
+    end
+
+  end
+end

data/lib/active_period/has_many/days.rb

@@ -0,0 +1,14 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide access to the days of the
+    # FreePeriod
+    module Days
+      include ActivePeriod::HasMany
+
+      def days
+        @days ||= ActivePeriod::Collection.new(ActivePeriod::Day, self)
+      end
+    end
+  end
+end

data/lib/active_period/has_many/holidays.rb

@@ -0,0 +1,15 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide access to the holidays of the
+    # FreePeriod
+    module Holidays
+      include ActivePeriod::HasMany
+
+      def holidays(*args, &block)
+        raise I18n.t(:gem_require, scope: %i[active_period holiday_period]) unless Object.const_defined?('Holidays')
+        ActivePeriod::Collection::HolidayPeriod.new(ActivePeriod::Holiday, self, *args, &block)
+      end
+    end
+  end
+end

data/lib/active_period/has_many/months.rb

@@ -0,0 +1,14 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide itterable access to the months of
+    # the FreePeriod
+    module Months
+      include ActivePeriod::HasMany
+
+      def months
+        @months ||= ActivePeriod::Collection.new(ActivePeriod::Month, self)
+      end
+    end
+  end
+end

data/lib/active_period/has_many/quarters.rb

@@ -0,0 +1,14 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide itterable access to the quarters of
+    # the FreePeriod
+    module Quarters
+      include ActivePeriod::HasMany
+
+      def quarters
+        @quarters ||= ActivePeriod::Collection.new(ActivePeriod::Quarter, self)
+      end
+    end
+  end
+end

data/lib/active_period/has_many/weeks.rb

@@ -0,0 +1,15 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide itterable access to the weeks of
+    # the FreePeriod
+    module Weeks
+      include ActivePeriod::HasMany
+
+      def weeks
+        @weeks ||= ActivePeriod::Collection.new(ActivePeriod::Week, self)
+      end
+
+    end
+  end
+end

data/lib/active_period/has_many/years.rb

@@ -0,0 +1,15 @@
+module ActivePeriod
+  module HasMany
+    # @author Lucas Billaudot <billau_l@modulotech.fr>
+    # @note when include this module provide itterable access to the years of
+    # the FreePeriod
+    module Years
+      include ActivePeriod::HasMany
+
+      def years
+        @years ||= ActivePeriod::Collection.new(ActivePeriod::Year, self)
+      end
+      
+    end
+  end
+end

data/lib/active_period/has_many.rb

@@ -0,0 +1,7 @@
+# @author Lucas Billaudot <billau_l@modulotech.fr>
+# @note This module define all period of time, who can be included in period
+module ActivePeriod
+  module HasMany
+    
+  end
+end

data/lib/active_period/holiday.rb

@@ -0,0 +1,80 @@
+require_relative 'day.rb'
+
+class ActivePeriod::Holiday < ActivePeriod::Day
+
+  # @!attribute [r] name
+  #   @return [String] The name of the holiday
+  attr_reader :name
+
+  # @!attribute [r] regions
+  #   @return [<Symbol>] regions where the Holiday occure
+  attr_reader :regions
+
+
+  # @param date [...] A valid param for Period.day(...)
+  # @param name [String] The name of the Holiday
+  # @param regions [<Symbol>] region where the Holiday occure
+  # @return [Type] ActivePeriod::Holiday
+  # @raise RuntimeError if the gem "holidays" is not included
+  def initialize(date: , name:, regions: )
+    raise I18n.t(:gem_require, scope: %i[active_period holiday_period]) unless Object.const_defined?('Holidays')
+    super(date)
+
+    @name = name
+    @regions = regions
+  end
+
+  def next
+    raise NotImplementedError
+  end
+  alias succ next
+
+  def prev
+    raise NotImplementedError
+  end
+
+  def _period
+    self.class._period
+  end
+
+  def self._period
+    'day'
+  end
+
+  # Shift a period to the past acording to her starting point
+  # @return [self] A new period of the same kind
+  def -(duration)
+    raise NotImplementedError
+  end
+
+  # Shift a period to the past acording to her ending point
+  # @return [self] A new period of the same kind
+  def +(duration)
+    raise NotImplementedError
+  end
+
+  def strftime(format)
+    from.strftime(format)
+  end
+
+  def to_s(format: '%d/%m/%Y')
+    strftime(format)
+  end
+
+  def i18n(&block)
+    return yield(from, to) if block.present?
+
+    I18n.t(:default_format,
+           scope:   i18n_scope,
+           name:    name,
+           wday:    I18n.l(from, format: '%A').capitalize,
+           day:     from.day,
+           month:   I18n.l(from, format: '%B').capitalize,
+           year:    from.year)
+  end
+
+  def i18n_scope
+    [:active_period, :holiday_period]
+  end
+
+end

data/lib/active_period/month.rb

@@ -0,0 +1,37 @@
+require_relative 'standard_period.rb'
+require_relative 'has_many.rb'
+require_relative 'has_many/days.rb'
+require_relative 'has_many/weeks.rb'
+require_relative 'belongs_to.rb'
+require_relative 'belongs_to/quarter.rb'
+require_relative 'belongs_to/year.rb'
+
+# @author Lucas Billaudot <billau_l@modulotech.fr>
+# @note One of the StandardPeriod defined in the gem
+module ActivePeriod
+  class Month < ActivePeriod::StandardPeriod
+    include ActivePeriod::HasMany::Days
+    include ActivePeriod::HasMany::Weeks
+
+    include ActivePeriod::BelongsTo::Quarter
+    include ActivePeriod::BelongsTo::Year
+
+    def strftime(format)
+      from.strftime(format)
+    end
+
+    def to_s(format: '%m/%Y')
+      strftime(format)
+    end
+
+    def i18n(&block)
+      return yield(from, to) if block.present?
+
+      I18n.t(:default_format,
+             scope:  i18n_scope,
+             month:  I18n.l(from, format: '%B').capitalize,
+             year:   from.year)
+    end
+
+  end
+end

data/lib/active_period/period.rb

@@ -0,0 +1,158 @@
+require_relative 'comparable.rb'
+require_relative 'has_many/holidays.rb'
+
+class ActivePeriod::Period < Range
+  include ActivePeriod::Comparable
+  include ActivePeriod::HasMany::Holidays
+
+  # @author Lucas Billaudot <billau_l@modulotech.fr>
+  # @param range [Range] A valid range
+  # @param allow_beginless [Boolean] Is it allow to creat a beginless range
+  # @param allow_endless [Boolean] Is it allow to creat an endless range
+  # @return [self] A new instance of ActivePeriod::FreePeriod
+  # @raise ArgumentError if the params range is not a Range
+  # @raise ArgumentError if the params range is invalid
+  def initialize(range, allow_beginless: true, allow_endless: true)
+    I18n.t(:base_class_is_abstract, scope: %i[active_period period]) if self.class == ActivePeriod::Period
+
+    raise ::ArgumentError, I18n.t(:param_must_be_a_range, scope: %i[active_period period]) unless range.class.ancestors.include?(Range)
+
+    from = time_parse(range.begin, I18n.t(:begin_date_is_invalid, scope: %i[active_period period]))
+    raise ::ArgumentError, I18n.t(:begin_date_is_invalid, scope: %i[active_period period]) if !allow_beginless && from.nil?
+    from = from.try(:beginning_of_day) || from
+
+    to = time_parse(range.end, I18n.t(:end_date_is_invalid, scope: %i[active_period period]))
+    raise ::ArgumentError, I18n.t(:end_date_is_invalid, scope: %i[active_period period]) if !allow_endless && to.nil?
+    to = to.try(:end_of_day) || to
+
+    # raise ::ArgumentError, I18n.t(:endless_excluded_end_is_forbiden, scope: %i[active_period period]) if to.nil? && range.exclude_end?
+    # to = to.prev_day if range.exclude_end?
+    if range.exclude_end? && from && to && from.to_date == to.to_date
+      raise ::ArgumentError, I18n.t(:start_is_equal_to_end_excluded, scope: %i[active_period period])
+    end
+
+    if from && to && from > to
+      raise ::ArgumentError, I18n.t(:start_is_greater_than_end, scope: %i[active_period period])
+    end
+
+    super(from, to, range.exclude_end?)
+  end
+
+  alias from first
+  alias beginning first
+
+  alias to last
+  alias ending last
+
+  # @raise NotImplementedError This method cen be implemented in daughter class
+  def next
+    raise NotImplementedError
+  end
+  alias succ next
+
+  # @raise NotImplementedError This method cen be implemented in daughter class
+  def prev
+    raise NotImplementedError
+  end
+
+  # @raise NotImplementedError This method should be implemented in daughter class
+  def to_i
+    raise NotImplementedError
+  end
+
+  # @raise NotImplementedError This method should be implemented in daughter class
+  def -(duration)
+    raise NotImplementedError
+  end
+
+  # @raise NotImplementedError This method should be implemented in daughter class
+  def +(duration)
+    raise NotImplementedError
+  end
+
+  # @param other [ActivePeriod::FreePeriod] Any kind of ActivePeriod::FreePeriod object
+  # @return [Boolean] true if period are equals, false otherwise
+  # @raise ArgumentError if params other is not a ActivePeriod::FreePeriod of some kind
+  def ==(other)
+    if other.class.ancestors.include?(ActivePeriod::Period)
+      from == other.from && self.calculated_end == other.calculated_end
+    elsif other.is_a?(ActiveSupport::Duration) || other.is_a?(Numeric)
+      super(other)
+    else
+      raise ArgumentError
+    end
+  end
+
+  # @raise NotImplementedError This method should be implemented in daughter class
+  def strftime
+    raise NotImplementedError
+  end
+
+  # @raise NotImplementedError This method should be implemented in daughter class
+  def to_s
+    raise NotImplementedError
+  end
+
+  # @raise NotImplementedError This method must be implemented in daughter class
+  def i18n
+    raise NotImplementedError
+  end
+
+  # @author Lucas Billaudot <billau_l@modulotech.fr>
+  # @return [DateTime] The real value of end acording to exclude_end
+  def calculated_end
+    if endless?
+      Date::Infinity.new
+    else
+      if exclude_end?
+        self.end.prev_day
+      else
+        self.end
+      end
+    end
+  end
+
+  def calculated_begin
+    if beginless?
+      -Date::Infinity.new
+    else
+      self.begin
+    end
+  end
+
+  def endless?
+    self.end.nil?
+  end
+
+  def beginless?
+    self.begin.nil?
+  end
+
+  def boundless?
+    beginless? && endless?
+  end
+
+  def infinite?
+    beginless? || endless?
+  end
+
+  private
+
+  def time_parse(time, msg)
+    time = time.presence
+    case time
+    when NilClass, Date::Infinity, Float::INFINITY, -Float::INFINITY
+      nil
+    when String, Date
+      Period.env_time.parse(time.to_s)
+    when Numeric
+      Time.at time
+    when Time, ActiveSupport::TimeWithZone
+      time
+    else
+      raise ::ArgumentError, msg
+    end
+  rescue StandardError
+    raise ::ArgumentError, msg
+  end
+end