active_period 6.1.1

data/lib/active_period/quarter.rb

@@ -0,0 +1,42 @@
+require_relative 'standard_period.rb'
+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 'belongs_to.rb'
+require_relative 'belongs_to/year.rb'
+
+module ActivePeriod
+  # @author Lucas Billaudot <billau_l@modulotech.fr>
+  # @note One of the StandardPeriod defined in the gem
+  class Quarter < ActivePeriod::StandardPeriod
+    include ActivePeriod::HasMany::Days
+    include ActivePeriod::HasMany::Weeks
+    include ActivePeriod::HasMany::Months
+
+    include ActivePeriod::BelongsTo::Year
+
+    def strftime(format)
+      format = format.gsub(':quarter', quarter_nb.to_s)
+      from.strftime(format)
+    end
+
+    def quarter_nb
+      @quarter_nb ||= (from.month / 3.0).ceil
+    end
+
+    def to_s
+      i18n
+    end
+
+    def i18n(&block)
+      return yield(from, to) if block.present?
+
+      I18n.t(:default_format,
+             scope:       i18n_scope,
+             quarter_nb:  quarter_nb,
+             year:        from.year)
+    end
+
+  end
+end

data/lib/active_period/standard_period.rb

@@ -0,0 +1,51 @@
+module ActivePeriod
+  class StandardPeriod < ActivePeriod::Period
+
+    def initialize(object)
+      raise I18n.t(:base_class_id_abstract, scope: %i[active_period standard_period]) if self.class == StandardPeriod
+      time = time_parse(object, I18n.t(:date_is_invalid, scope: %i[active_period standard_period]) )
+      super(time.send("beginning_of_#{_period}")..time.send("end_of_#{_period}"))
+    end
+
+    def next
+      self.class.new(from.send("next_#{_period}"))
+    end
+    alias succ next
+
+    def prev
+      self.class.new(from.send("prev_#{_period}"))
+    end
+
+    def _period
+      self.class._period
+    end
+
+    # @return [String] get the name of the standard period
+    def self._period
+      name.split('::').last.downcase
+    end
+
+    # Don't realy return an Integer. ActiveSupport::Duration is a better numeric
+    # representation a in time manipulation context
+    # @return [ActiveSupport::Duration]
+    def to_i
+      1.send(_period)
+    end
+
+    # Shift a period to the past acording to her starting point
+    # @return [self] A new period of the same kind
+    def -(duration)
+      self.class.new(from - duration)
+    end
+
+    # Shift a period to the past acording to her ending point
+    # @return [self] A new period of the same kind
+    def +(duration)
+      self.class.new(to + duration)
+    end
+
+    def i18n_scope
+      [:active_period, :standard_period, _period]
+    end
+  end
+end

data/lib/active_period/version.rb

@@ -0,0 +1,5 @@
+module ActivePeriod
+
+  VERSION = '6.1.1'.freeze
+
+end

data/lib/active_period/week.rb

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

data/lib/active_period/year.rb

@@ -0,0 +1,34 @@
+require_relative 'standard_period.rb'
+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'
+
+module ActivePeriod
+  # @author Lucas Billaudot <billau_l@modulotech.fr>
+  # @note One of the StandardPeriod defined in the gem
+  class Year < ActivePeriod::StandardPeriod
+    include ActivePeriod::HasMany::Days
+    include ActivePeriod::HasMany::Weeks
+    include ActivePeriod::HasMany::Months
+    include ActivePeriod::HasMany::Quarters
+
+    def strftime(format)
+      from.strftime(format)
+    end
+
+    def to_s(format: '%Y')
+      strftime(format)
+    end
+
+    def i18n(&block)
+      return yield(from, to) if block.present?
+
+      I18n.t(:default_format,
+             scope: i18n_scope,
+             year:  from.year)
+    end
+
+  end
+end

data/lib/active_period.rb

@@ -0,0 +1,28 @@
+require_relative 'active_period/version.rb'
+require 'active_support/all'
+require 'i18n'
+
+I18n.load_path << File.expand_path("../config/locales/en.yml", __dir__)
+I18n.load_path << File.expand_path("../config/locales/fr.yml", __dir__)
+
+require_relative 'numeric.rb'
+require_relative 'range.rb'
+require_relative 'active_period/collection.rb'
+require_relative 'active_period/collection/free_period.rb'
+require_relative 'active_period/collection/standard_period.rb'
+require_relative 'active_period/collection/holiday_period.rb'
+require_relative 'active_period/comparable.rb'
+require_relative 'active_period/period.rb'
+require_relative 'active_period/free_period.rb'
+require_relative 'active_period/standard_period.rb'
+require_relative 'active_period/day.rb'
+require_relative 'active_period/week.rb'
+require_relative 'active_period/month.rb'
+require_relative 'active_period/quarter.rb'
+require_relative 'active_period/year.rb'
+require_relative 'active_period/holiday.rb'
+require_relative 'period.rb'
+
+module ActivePeriod
+
+end

data/lib/numeric.rb

@@ -0,0 +1,6 @@
+class Numeric
+  def quarters
+    ActiveSupport::Duration.months(self * 3)
+  end
+  alias :quarter :quarters
+end

data/lib/period.rb

@@ -0,0 +1,63 @@
+module Period
+  def self.new(*args)
+    ActivePeriod::FreePeriod.new(*args)
+  end
+
+  def self.bounded(range)
+    ActivePeriod::FreePeriod.new(range, allow_beginless: false, allow_endless: false)
+  end
+
+  def self.env_time
+    (Time.zone || Time)
+  end
+
+  class << self
+    %i[day week month quarter year].each do |period|
+      define_method "last_#{period}" do
+        date = env_time.now.send(period == :day ? 'yesterday' : "last_#{period}")
+        Object.const_get("ActivePeriod::#{period.capitalize}").new(date)
+      end
+
+      define_method "this_#{period}" do
+        Object.const_get("ActivePeriod::#{period.capitalize}").new(env_time.now)
+      end
+
+      define_method "next_#{period}" do
+        date = env_time.now.send(period == :day ? 'tomorrow' : "next_#{period}")
+        Object.const_get("ActivePeriod::#{period.capitalize}").new(date)
+      end
+
+      define_method period.to_s do |range|
+        Object.const_get("ActivePeriod::#{period.capitalize}").new(range)
+      end
+    end
+
+    alias yesterday last_day
+    alias tomorrow next_day
+    alias today this_day
+
+    def method_missing(method_name, *arguments, &block)
+      super unless method_name.match?(/(last|next)_\d+_(day|week|month|quarter|year)s?(_from_now)?/)
+      last_next, count, klass = method_name.to_s.split('_')
+      klass = klass.singularize
+
+      case last_next
+      when 'last'
+        from = count.to_i.send(klass).ago.send("beginning_of_#{klass}")
+        to = env_time.now
+        to -= 1.send(klass) unless method_name.match?(/from_now$/)
+        to = to.send("end_of_#{klass}")
+      when 'next'
+        from = env_time.now
+        from += 1.send(klass) unless method_name.match?(/from_now$/)
+        from = from.send("beginning_of_#{klass}")
+        to = count.to_i.send(klass).from_now.send("end_of_#{klass}")
+      end
+      self.new(from..to)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.match?(/(last|next)_\d+_(day|week|month|quarter|year)s?(_from_now)?/) || super
+    end
+  end
+end

data/lib/range.rb

@@ -0,0 +1,8 @@
+class Range
+
+  # @return [ActivePeriod::FreePeriod] a new free period
+  # @raise see ActivePeriod::FreePeriod.new
+  def to_period
+    ::Period.new(self)
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: active_period
+version: !ruby/object:Gem::Version
+  version: 6.1.1
+platform: ruby
+authors:
+- billau_l
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_period.gemspec
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- config/locales/fr.yml
+- lib/.DS_Store
+- lib/active_period.rb
+- lib/active_period/belongs_to.rb
+- lib/active_period/belongs_to/month.rb
+- lib/active_period/belongs_to/quarter.rb
+- lib/active_period/belongs_to/week.rb
+- lib/active_period/belongs_to/year.rb
+- lib/active_period/collection.rb
+- lib/active_period/collection/free_period.rb
+- lib/active_period/collection/holiday_period.rb
+- lib/active_period/collection/standard_period.rb
+- lib/active_period/comparable.rb
+- lib/active_period/day.rb
+- lib/active_period/free_period.rb
+- lib/active_period/has_many.rb
+- lib/active_period/has_many/days.rb
+- lib/active_period/has_many/holidays.rb
+- lib/active_period/has_many/months.rb
+- lib/active_period/has_many/quarters.rb
+- lib/active_period/has_many/weeks.rb
+- lib/active_period/has_many/years.rb
+- lib/active_period/holiday.rb
+- lib/active_period/month.rb
+- lib/active_period/period.rb
+- lib/active_period/quarter.rb
+- lib/active_period/standard_period.rb
+- lib/active_period/version.rb
+- lib/active_period/week.rb
+- lib/active_period/year.rb
+- lib/numeric.rb
+- lib/period.rb
+- lib/range.rb
+homepage: https://github.com/billaul/period
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/billaul/period/issues
+  homepage_uri: https://github.com/billaul/period
+  documentation_uri: https://github.com/billaul/period
+  source_code_uri: https://github.com/billaul/period
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- config
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Manage time ranges without brain damage.
+test_files: []