fat_period 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8592241a9f75949afa4df46469ff74029aa57ad67ac46234717aa751ba4cfef8
-  data.tar.gz: 26658db3f5a219236ae9bc9132cafa58850051fdf5d67c389c51306bcd4cd748
+  metadata.gz: 5742b6c1b70e7477cb2b8e077c3b1e5d96fc417858f618a12ad64a457df692e4
+  data.tar.gz: 7965192d8da3ea88002089c52dc9344cae1f75e7fab28739185b5f290c3f1bc9
 SHA512:
-  metadata.gz: 48f7404be05db83ec57ceb7c2b4e75f584920422067bfc1600163cc58253db0ff3856201df4b6265145a5cbceee534e9d380b1ee44953fbb5fad0ffc772fa0df
-  data.tar.gz: 2ac2dcdb14642e774826f18b6ba7a5bd157fc067bc55495480b7ac91e7e95a21a30217725c4decf5e333e2b8b2cef581df72ee76afa5d18c459b510134c322b1
+  metadata.gz: 78bf26849daf793f3b2115e136599178817fd43a1a03bc2882eea408bd7995c44feb94998f22bb220afeb3c2b8270770aa7dc586736849af5f5506f6f7e1123b
+  data.tar.gz: dc0b08cb99a577a8fe11827e96ef1c9473a4536fe4ae0e7dd483fc7a1d1d0493a333eecbbcc8a2cd9f710d03489bc32aa4c8695b9787007dc51efddb9805e14b

data/.envrc

@@ -0,0 +1,7 @@
+PATH_add .bundle/bin
+PATH_add ./scripts
+# Ensure that we use the development DB when in the src dir.
+export DB=development
+export COMPOSE_FILE=.devcontainer/docker-compose.yml
+export COMPOSE_PROJECT_NAME=byr
+export BOOTSNAP_CACHE_DIR=tmp/cache

data/.github/workflows/gem-push.yml

@@ -0,0 +1,48 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 2.6
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/Gemfile

@@ -2,3 +2,15 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fat_period.gemspec
 gemspec
+
+gem 'bundler'
+gem 'debug'
+gem 'pry'
+gem 'pry-doc'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-shopify'

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => [:spec, :rubocop]

data/fat_period.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fat_period/version'
@@ -7,12 +8,12 @@ Gem::Specification.new do |spec|
   spec.name          = 'fat_period'
   spec.version       = FatPeriod::VERSION
   spec.authors       = ['Daniel E. Doherty']
-  spec.email         = ['ded-law@ddoherty.net']
+  spec.email         = ['ded@ddoherty.net']
 
-  spec.summary       = %q{Implements a Period class as a Range of Dates.}
+  spec.summary       = 'Implements a Period class as a Range of Dates.'
   spec.homepage      = 'https://github.com/ddoherty03/fat_period'
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   # Don't install any executables.
@@ -20,13 +21,5 @@ Gem::Specification.new do |spec|
   # spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'debug', '>= 1.0.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-doc'
-  spec.add_development_dependency 'simplecov'
-
-  spec.add_runtime_dependency 'fat_core', '>= 4.8.3'
+  spec.add_dependency 'fat_core', '>= 5.4'
 end

data/lib/fat_period/date.rb

@@ -1,5 +1,3 @@
-require 'date'
-
 module FatPeriod
   # An extension of Date for methods useful with respect to FatPeriod::Periods.
   module Date
@@ -20,53 +18,6 @@ module FatPeriod
       require 'fat_period'
       Period.new(beginning_of_chunk(chunk), end_of_chunk(chunk))
     end
-
-    # Return a period representing a chunk containing a given Date.
-    def day_containing
-      Period.new(self, self)
-    end
-
-    def week_containing
-      Period.new(self.beginning_of_week, self.end_of_week)
-    end
-
-    def biweek_containing
-      Period.new(self.beginning_of_biweek, self.end_of_biweek)
-    end
-
-    def semimonth_containing
-      Period.new(self.beginning_of_semimonth, self.end_of_semimonth)
-    end
-
-    def month_containing
-      Period.new(self.beginning_of_month, self.end_of_month)
-    end
-
-    def bimonth_containing
-      Period.new(self.beginning_of_bimonth, self.end_of_bimonth)
-    end
-
-    def quarter_containing
-      Period.new(self.beginning_of_quarter, self.end_of_quarter)
-    end
-
-    def half_containing
-      Period.new(self.beginning_of_half, self.end_of_half)
-    end
-
-    def year_containing
-      Period.new(self.beginning_of_year, self.end_of_year)
-    end
-
-    def chunk_containing(chunk)
-      raise ArgumentError, 'chunk is nil' unless chunk
-
-      chunk = chunk.to_sym
-      raise ArgumentError, "unknown chunk name: #{chunk}" unless CHUNKS.include?(chunk)
-
-      method = "#{chunk}_containing".to_sym
-      send(method, self)
-    end
   end
 end
 

data/lib/fat_period/period.rb

@@ -1,6 +1,5 @@
+require 'active_support'
 require 'fat_core/date'
-require 'fat_core/range'
-require 'fat_core/string'
 
 # The Period class represents a range of Dates and supports a variety of
 # operations on those ranges.
@@ -31,14 +30,13 @@ class Period
     @last = Date.ensure_date(last).freeze
     freeze
 
-    raise ArgumentError, "Period's first date is later than its last date" if @first > @last
+    return unless @first > @last
+
+    raise ArgumentError, "Period's first date is later than its last date"
   end
 
   # These need to come after initialize is defined
 
-  # Period from commercial beginning of time to today
-  TO_DATE = Period.new(Date::BOT, Date.current)
-
   # Period from commercial beginning of time to commercial end of time.
   FOREVER = Period.new(Date::BOT, Date::EOT)
 
@@ -68,60 +66,35 @@ class Period
     Period.new(first, second) if first && second
   end
 
-  PHRASE_RE = %r{\A
-      # One or both of from and to parts
-      (((from)?\s+(?<from_part>[-_a-z0-9]+)\s*)?
-      (to\s+(?<to_part>[-_a-z0-9]+))?)
-      # Wholly optional chunk part
-      (\s+per\s+(?<chunk_part>\w+))?\z}xi
-
-  private_constant :PHRASE_RE
-
-  # Return an array of periods, either a single period as in `Period.parse`
-  # from a String phrase in which a `from spec` is introduced with 'from' and,
-  # optionally, a `to spec` is introduced with 'to', or a number of periods if
-  # there is a 'per <chunk>' modifier.  A phrase with only a `to spec` is
-  # treated the same as one with only a from spec.  If neither 'from' nor 'to'
-  # appear in phrase, treat the whole string as a from spec.
+  # Return a period as in `Period.parse` from a String phrase in which the from
+  # spec is introduced with 'from' and, optionally, the to spec is introduced
+  # with 'to'.  A phrase with only a to spec is treated the same as one with
+  # only a from spec.  If neither 'from' nor 'to' appear in phrase, treat the
+  # whole string as a from spec.
   #
   # @example
-  #   Period.parse_phrase('from 2014-11 to 2015-3Q') #=> [Period('2014-11-01..2015-09-30')]
-  #   Period.parse_phrase('from 2014-11')            #=> [Period('2014-11-01..2014-11-30')]
-  #   Period.parse_phrase('from 2015-3Q')            #=> [Period('2015-09-01..2015-12-31')]
-  #   Period.parse_phrase('to 2015-3Q')              #=> [Period('2015-09-01..2015-12-31')]
-  #   Period.parse_phrase('from 2015-3Q')            #=> [Period('2015-09-01..2015-12-31')]
-  #   Period.parse_phrase('from 2015 per month')     #=> [
-  #                                                        Period('2015-01-01..2015-01-31'),
-  #                                                        Period('2015-02-01..2015-02-28'),
-  #                                                         ...
-  #                                                        Period('2015-12-01..2015-12-31')
-  #                                                       ]
-  #
-  # @param phrase [String] with 'from <spec> to <spec> [per <chunk>]'
-  # @return [Array<Period>] translated from phrase
-  def self.parse_phrase(phrase, partial_first: false, partial_last: false, round_up_last: false)
-    phrase = phrase.downcase.clean
-    mm = phrase.match(PHRASE_RE)
-    raise ArgumentError, "invalid period phrase: `#{phrase}`" unless mm
-
-    if mm[:from_part] && mm[:to_part].nil?
-      from_part = mm[:from_part]
-      to_part = nil
-    elsif mm[:from_part].nil? && mm[:to_part]
-      from_part = mm[:to_part]
-      to_part = nil
-    else
-      from_part = mm[:from_part]
-      to_part = mm[:to_part]
-    end
-
-    whole_period = parse(from_part, to_part)
-    if mm[:chunk_part].nil?
-      [whole_period]
+  #   Period.parse_phrase('from 2014-11 to 2015-3Q') #=> Period('2014-11-01..2015-09-30')
+  #   Period.parse_phrase('from 2014-11')            #=> Period('2014-11-01..2014-11-30')
+  #   Period.parse_phrase('from 2015-3Q')            #=> Period('2015-09-01..2015-12-31')
+  #   Period.parse_phrase('to 2015-3Q')              #=> Period('2015-09-01..2015-12-31')
+  #   Period.parse_phrase('2015-3Q')                 #=> Period('2015-09-01..2015-12-31')
+  #
+  # @param phrase [String] with 'from <spec> to <spec>'
+  # @return [Period] translated from phrase
+  def self.parse_phrase(phrase)
+    phrase = phrase.clean
+    case phrase
+    when /\Afrom (.*) to (.*)\z/
+      from_phrase = $1
+      to_phrase = $2
+    when /\Afrom (.*)\z/, /\Ato (.*)\z/
+      from_phrase = $1
+      to_phrase = nil
     else
-      whole_period.chunks(size: mm[:chunk_part], partial_first: partial_first,
-                         partial_last: partial_last, round_up_last: round_up_last)
+      from_phrase = phrase
+      to_phrase = nil
     end
+    parse(from_phrase, to_phrase)
   end
 
   # @group Conversion
@@ -191,7 +164,7 @@ class Period
   # @param other [Period] @return [Integer] -1 if self < other; 0 if self ==
   # other; 1 if self > other
   def <=>(other)
-    return nil unless other.is_a?(Period)
+    return unless other.is_a?(Period)
 
     [first, last] <=> [other.first, other.last]
   end
@@ -210,7 +183,7 @@ class Period
   end
 
   def eql?(other)
-    return nil unless other.is_a?(Period)
+    return unless other.is_a?(Period)
 
     hash == other.hash
   end
@@ -225,7 +198,7 @@ class Period
 
     to_range.cover?(date)
   end
-  alias === contains?
+  alias_method :===, :contains?
 
   include Enumerable
 
@@ -233,15 +206,10 @@ class Period
 
   # Yield each day in this Period.
   def each
-    if block_given?
-      d = first
-      while d <= last
-        yield d
-        d += 1.day
-      end
-      self
-    else
-      to_enum(:each)
+    d = first
+    while d <= last
+      yield d
+      d += 1.day
     end
   end
 
@@ -259,8 +227,8 @@ class Period
   def size
     (last - first + 1).to_i
   end
-  alias length size
-  alias days size
+  alias_method :length, :size
+  alias_method :days, :size
 
   # Return the fractional number of months in the period.  By default, use the
   # average number of days in a month, but allow the user to override the
@@ -306,8 +274,18 @@ class Period
 
   # An Array of the valid Symbols for calendar chunks plus the Symbol :irregular
   # for other periods.
-  CHUNKS = %i[day week biweek semimonth month bimonth quarter
-              half year irregular].freeze
+  CHUNKS = %i[
+    day
+    week
+    biweek
+    semimonth
+    month
+    bimonth
+    quarter
+    half
+    year
+    irregular
+  ].freeze
 
   CHUNK_ORDER = {}
   CHUNKS.each_with_index do |c, i|
@@ -317,13 +295,17 @@ class Period
 
   # An Array of Ranges for the number of days that can be covered by each chunk.
   CHUNK_RANGE = {
-    day: (1..1), week: (7..7), biweek: (14..14), semimonth: (15..16),
-    month: (28..31), bimonth: (59..62), quarter: (90..92),
-    half: (180..183), year: (365..366)
+    day: (1..1),
+    week: (7..7),
+    biweek: (14..14),
+    semimonth: (15..16),
+    month: (28..31),
+    bimonth: (59..62),
+    quarter: (90..92),
+    half: (180..183),
+    year: (365..366)
   }.freeze
 
-  private_constant :CHUNK_ORDER, :CHUNK_RANGE
-
   def self.chunk_cmp(chunk1, chunk2)
     CHUNK_ORDER[chunk1] <=> CHUNK_ORDER[chunk2]
   end
@@ -611,8 +593,8 @@ class Period
   # @param round_up_last [Boolean] allow the last period in the returned array
   #   to extend beyond the end of self.
   # @return [Array<Period>] periods that subdivide self into chunks of size, `size`
-  def chunks(size: :month, partial_first: false, partial_last: false,
-             round_up_last: false)
+  def chunks(size: :month, partial_first: true, partial_last: true,
+    round_up_last: false)
     chunk_size = size.to_sym
     raise ArgumentError, "unknown chunk size '#{chunk_size}'" unless CHUNKS.include?(chunk_size)
 
@@ -636,7 +618,6 @@ class Period
       return result
     end
 
-    # The first chunk
     chunk_start = first.dup
     chunk_end = chunk_start.end_of_chunk(chunk_size)
     if chunk_start.beginning_of_chunk?(chunk_size) || partial_first
@@ -645,16 +626,14 @@ class Period
     end
     chunk_start = chunk_end + 1.day
     chunk_end = chunk_start.end_of_chunk(chunk_size)
-
     # Add Whole chunks
     while chunk_end <= last
       result << Period.new(chunk_start, chunk_end)
       chunk_start = chunk_end + 1.day
       chunk_end = chunk_start.end_of_chunk(chunk_size)
     end
-
     # Possibly append the final chunk to result
-    if chunk_start <= last
+    if chunk_start < last
       if round_up_last
         result << Period.new(chunk_start, chunk_end)
       elsif partial_last
@@ -747,8 +726,8 @@ class Period
       Period.new(result.first, result.last)
     end
   end
-  alias & intersection
-  alias narrow_to intersection
+  alias_method :&, :intersection
+  alias_method :narrow_to, :intersection
 
   # Return the Period that is the union of self with `other` or nil if
   # they neither overlap nor are contiguous
@@ -765,11 +744,11 @@ class Period
   # @return [Period, nil] self union `other`?
   def union(other)
     result = to_range.union(other.to_range)
-    return nil if result.nil?
+    return if result.nil?
 
     Period.new(result.first, result.last)
   end
-  alias + union
+  alias_method :+, :union
 
   # Return an array of periods that are this period excluding any overlap with
   # other. If there is no overlap, return an array with a period equal to self
@@ -787,7 +766,7 @@ class Period
     ranges = to_range.difference(other.to_range)
     ranges.each.map { |r| Period.new(r.first, r.last) }
   end
-  alias - difference
+  alias_method :-, :difference
 
   # Return whether this period overlaps the `other` period.  To overlap, the
   # periods must have at least one day in common.

data/lib/fat_period/version.rb

@@ -1,3 +1,3 @@
 module FatPeriod
-  VERSION = '1.4.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/fat_period.rb

@@ -1,3 +1,9 @@
+require 'date'
+
 require 'fat_period/version'
 require 'fat_period/date'
 require 'fat_period/period'
+
+require 'fat_core/date'
+require 'fat_core/range'
+require 'fat_core/string'

metadata

@@ -1,137 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: fat_period
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel E. Doherty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fat_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.8.3
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.8.3
-description: 
+        version: '5.4'
+description:
 email:
-- ded-law@ddoherty.net
+- ded@ddoherty.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -147,7 +50,7 @@ files:
 homepage: https://github.com/ddoherty03/fat_period
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Implements a Period class as a Range of Dates.
 test_files: []

data/.simplecov

@@ -1,18 +0,0 @@
-# -*- mode: ruby -*-
-
-SimpleCov.start do
-  # any custom configs like groups and filters can be here at a central place
-  add_filter '/spec/'
-  add_filter '/tmp/'
-  add_group "Models", "lib/fat_period"
-  # add_group "Core Extension", "lib/ext"
-  # After this many seconds between runs, old coverage stats are thrown out,
-  # so 3600 => 1 hour
-  merge_timeout 3600
-  # Make this true to merge rspec and cucumber coverage together
-  use_merging false
-  command_name 'Rspec'
-  nocov_token 'no_cover'
-  # Branch coverage
-  enable_coverage :branch
-end