fat_period 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b3b656730fd4a24f6ec1ae3c14a2828aee91a6ddf18ce8a4481e31e2d55ad3
-  data.tar.gz: eb16ac79598e7c0054bac2ba57a9a5d8abce25cb8e810cbea9ac59ea4c8ead33
+  metadata.gz: fe15db09e24f9ddf7264fdf8862ea51bacb0fb88da8b21727c44ce0c0a4f930c
+  data.tar.gz: 0ea19cc89dfa940268938ccf2d8f3abd949e2c1a405d158410c0f928c8c6d64a
 SHA512:
-  metadata.gz: 82b0fb1e076cf644da168edbfadfe44a060dc8ebdc43cdf450280a32466fc31a33aee79591a209d480cf192373cfcd8fe808f46e70e0c8186ff9fb10bdf84c66
-  data.tar.gz: d1a151a0b003ba1bcaa54562928ab42075044ae04bbabca202001c56b1fd697779666c870541f023dddf64e248dd1a1ee2e5eeea5484e2c6f0ee392af469e874
+  metadata.gz: e4270dcbd82522aeb3781205e4598b52f15cc2c3b352709b500ffb6db6cd80a5691416d3a3abed2cf132fc0de8d5b05a14e934d14100c984293893cc4b3de378
+  data.tar.gz: 82458a341811b97e30393360fc81b02acad7d4b8446ce616b7c84d237e11ec037fa85790d241c02c9874924733ac0895fd648f7b0ec3d83f8de04ccd9eaf1372

data/.envrc

@@ -0,0 +1 @@
+PATH_add .bundle/bin

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/.simplecov

@@ -0,0 +1,18 @@
+# -*- 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

data/fat_period.gemspec

@@ -7,7 +7,7 @@ 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.homepage      = 'https://github.com/ddoherty03/fat_period'
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   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_runtime_dependency 'fat_core', '>= 5.1.0'
 end

data/lib/fat_period/date.rb

@@ -20,6 +20,53 @@ 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

@@ -27,13 +27,11 @@ class Period
   # @raise [ArgumentError] if first date is later than last date
   # @return [Period]
   def initialize(first, last)
-    @first = Date.ensure_date(first).freeze
-    @last = Date.ensure_date(last).freeze
+    @first = Date.ensure(first).freeze
+    @last = Date.ensure(last).freeze
     freeze
 
-    return unless @first > @last
-
-    raise ArgumentError, "Period's first date is later than its last date"
+    raise ArgumentError, "Period's first date is later than its last date" if @first > @last
   end
 
   # These need to come after initialize is defined
@@ -72,7 +70,7 @@ class Period
 
   PHRASE_RE = %r{\A
       # One or both of from and to parts
-      ((from\s+(?<from_part>[-_a-z0-9]+)\s*)?
+      (((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
@@ -168,6 +166,31 @@ class Period
     end
   end
 
+  # Convert a string or Period into a Period object, if the string is parsable
+  # as a period.
+  #
+  # @example
+  #   Period.ensure('2023-1q') #=> Period 2023-01-01..2023-03-31
+  #   pd = Period.new('2016-01-01', '2016-12-31')
+  #   Period.ensure(pd) #=> pd  # No effect
+  #
+  # @return [Period] either parsed String or same Period
+  def self.ensure(pd)
+    case pd
+    when Period
+      pd
+    when String
+      if pd.match?(/\s*from/i)
+        # Ignore any chunk modifier, 'per'
+        Period.parse_phrase(pd).first
+      else
+        Period.parse(pd)
+      end
+    else
+      raise UserError, "can't ensure `#{pd}` of #{pd.class} is a Period"
+    end
+  end
+
   # A concise way to print out Periods for inspection as
   # 'Period(YYYY-MM-DD..YYYY-MM-DD)'.
   #
@@ -373,7 +396,7 @@ class Period
     chunk = chunk.to_sym
     raise ArgumentError, "unknown chunk name: #{chunk}" unless CHUNKS.include?(chunk)
 
-    date = Date.ensure_date(date)
+    date = Date.ensure(date)
     method = "#{chunk}_containing".to_sym
     send(method, date)
   end

data/lib/fat_period/version.rb

@@ -1,3 +1,3 @@
 module FatPeriod
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_period
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel E. Doherty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,29 +94,46 @@ dependencies:
     - - ">="
       - !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.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.8.3
-description: 
+        version: 5.1.0
+description:
 email:
-- ded-law@ddoherty.net
+- ded@ddoherty.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
+- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -132,7 +149,7 @@ files:
 homepage: https://github.com/ddoherty03/fat_period
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.5.18
+signing_key:
 specification_version: 4
 summary: Implements a Period class as a Range of Dates.
 test_files: []