fat_period 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a36af9ab31a0faffb0b9128748deb78fa97b8cb56581bcf3b47b8a2a8776d29
-  data.tar.gz: '089e00bbce43fe66642ef419c9824fab84ab3a6b36aecc586aeb383662c10aa2'
+  metadata.gz: 609274b0338a91caf02d5fbf0ed37b4d2621dea51e93a393f9bde86e5287b0ad
+  data.tar.gz: cddf0aa8c7087d0705917319090dab8fea710579b697cc79d231f0257a80271d
 SHA512:
-  metadata.gz: 83ebcd8b723bd5f95845acf7ecd831293f88ccd15b31caec79d23e1e4bf308d49b02c43556ff85eaebbe9b31d28c683c5cb5dec1418ebfa2f2758790206d731c
-  data.tar.gz: 7e19c54d5e179b20ff715e28b2ae191ada78ee75553832b07b48b3bba82ea617494208de44ae18900f45258ffb0de7be60fd5beadf200a7182921f690aebd9a7
+  metadata.gz: 3da42e489a2dc3a1d8b42191e589e675a71466048a70b1b2d04f430b2f3f34685f0c137194952a7c4ec33c117cf227b1143670409353351af9b8531492efc93b
+  data.tar.gz: e91123fa17ff8a9f47553652a302316418aaf2f5fe5eee587b45ecb9b27799ad20b39b9e1af350e4453ee69f19f4a8cd6a595ed82df2247c5bc8084c664768de

data/.travis.yml

@@ -3,4 +3,4 @@ rvm:
   - 2.5
   - 2.6
   - 2.7
-  - ruby-head
+  - 3.0

data/lib/fat_period/period.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 require 'fat_core/date'
 require 'fat_core/range'
 require 'fat_core/string'
@@ -89,14 +87,13 @@ class Period
   # @return [Period] translated from phrase
   def self.parse_phrase(phrase)
     phrase = phrase.clean
-    if phrase =~ /\Afrom (.*) to (.*)\z/
+    case phrase
+    when /\Afrom (.*) to (.*)\z/
       from_phrase = $1
       to_phrase = $2
-    elsif phrase =~ /\Afrom (.*)\z/
+    when /\Afrom (.*)\z/, /\Ato (.*)\z/
       from_phrase = $1
       to_phrase = nil
-    elsif phrase =~ /\Ato (.*)\z/
-      from_phrase = $1
     else
       from_phrase = phrase
       to_phrase = nil
@@ -342,9 +339,7 @@ class Period
     raise ArgumentError, 'chunk is nil' unless chunk
 
     chunk = chunk.to_sym
-    unless CHUNKS.include?(chunk)
-      raise ArgumentError, "unknown chunk name: #{chunk}"
-    end
+    raise ArgumentError, "unknown chunk name: #{chunk}" unless CHUNKS.include?(chunk)
 
     date = Date.ensure_date(date)
     method = "#{chunk}_containing".to_sym
@@ -471,20 +466,20 @@ class Period
     end
   end
 
-  # Return the chunk symbol represented by the number of days given, but allow a
-  # deviation from the minimum and maximum number of days for periods larger
-  # than bimonths. The default tolerance is +/-10%, but that can be adjusted. The
-  # reason for allowing a bit of tolerance for the larger periods is that
-  # financial statements meant to cover a given calendar period are often short
-  # or long by a few days due to such things as weekends, holidays, or
-  # accounting convenience. For example, a bank might issuer "monthly"
-  # statements approximately every 30 days, but issue them earlier or later to
-  # avoid having the closing date fall on a weekend or holiday. We still want to
-  # be able to recognize them as "monthly", even though the period covered might
-  # be a few days shorter or longer than any possible calendar month.  You can
-  # eliminate this "fudge factor" by setting the `tolerance_pct` to zero.  If
-  # the number of days corresponds to none of the defined calendar periods,
-  # return the symbol `:irregular`.
+  # Return the chunk symbol represented by the number of days given, but allow
+  # a deviation from the minimum and maximum number of days for periods larger
+  # than bimonths. The default tolerance is +/-10%, but that can be
+  # adjusted. The reason for allowing a bit of tolerance for the larger
+  # periods is that financial statements meant to cover a given calendar
+  # period are often short or long by a few days due to such things as
+  # weekends, holidays, or accounting convenience. For example, a bank might
+  # issuer "monthly" statements approximately every 30 days, but issue them
+  # earlier or later to avoid having the closing date fall on a weekend or
+  # holiday. We still want to be able to recognize them as "monthly", even
+  # though the period covered might be a few days shorter or longer than any
+  # possible calendar month.  You can eliminate this "fudge factor" by setting
+  # the `tolerance_pct` to zero.  If the number of days corresponds to none of
+  # the defined calendar periods, return the symbol `:irregular`.
   #
   # @example
   #   Period.days_to_chunk(360)    #=> :year
@@ -493,12 +488,12 @@ class Period
   #   Period.days_to_chunk(88, 0)  #=> :irregular
   #
   # @param days [Integer] the number of days in the period under test
-  # @param tolerance_pct [Numberic] the percent deviation allowed, e.g. 10 => 10%
+  # @param tolerance_pct [Numeric] the percent deviation allowed, e.g. 10 => 10%
   # @return [Symbol] symbol for the period corresponding to days number of days
   def self.days_to_chunk(days, tolerance_pct = 10)
     result = :irregular
     CHUNK_RANGE.each_pair do |chunk, rng|
-      if [:semimonth, :biweek, :week, :day].include?(chunk)
+      if %i[semimonth biweek week day].include?(chunk)
         # Be strict for shorter periods.
         if rng.cover?(days)
           result = chunk
@@ -589,9 +584,7 @@ class Period
   def chunks(size: :month, partial_first: false, partial_last: false,
              round_up_last: false)
     chunk_size = size.to_sym
-    unless CHUNKS.include?(chunk_size)
-      raise ArgumentError, "unknown chunk size '#{chunk_size}'"
-    end
+    raise ArgumentError, "unknown chunk size '#{chunk_size}'" unless CHUNKS.include?(chunk_size)
 
     containing_period = Period.chunk_containing(first, chunk_size)
     return [dup] if self == containing_period
@@ -618,13 +611,9 @@ class Period
     if chunk_start.beginning_of_chunk?(chunk_size) || partial_first
       # Keep the first chunk if it's whole or partials allowed
       result << Period.new(chunk_start, chunk_end)
-      chunk_start = chunk_end + 1.day
-      chunk_end = chunk_start.end_of_chunk(chunk_size)
-    else
-      # Discard the partial first or move to next whole chunk
-      chunk_start = chunk_end + 1.day
-      chunk_end = chunk_start.end_of_chunk(chunk_size)
     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)
@@ -640,15 +629,15 @@ class Period
       else
         result
       end
-    elsif partial_last
+    end
+    if partial_last && !partial_first && result.empty?
       # Catch the case where the period is too small to make a whole chunk and
       # partial_first is false, so it did not get included as the initial
       # partial chunk, yet a partial_last is allowed, so include the whole
       # period as a partial chunk.
       result << Period.new(first, last)
-    else
-      result
     end
+    result
   end
 
   # @group Set operations
@@ -692,7 +681,7 @@ class Period
     to_range.superset_of?(other.to_range)
   end
 
-  # Does this period wholly contain but not coincident with `other`?
+  # Does this period wholly contain but is not coincident with `other`?
   #
   # @example
   #   Period.parse('2015').proper_superset_of?(Period.parse('2015-2Q'))    #=> true

data/lib/fat_period/version.rb

@@ -1,3 +1,3 @@
 module FatPeriod
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_period
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Daniel E. Doherty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.8.3
-description: 
+description:
 email:
 - ded-law@ddoherty.net
 executables: []
@@ -132,7 +132,7 @@ files:
 homepage: https://github.com/ddoherty03/fat_period
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Implements a Period class as a Range of Dates.
 test_files: []