fat_period 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 609274b0338a91caf02d5fbf0ed37b4d2621dea51e93a393f9bde86e5287b0ad
-  data.tar.gz: cddf0aa8c7087d0705917319090dab8fea710579b697cc79d231f0257a80271d
+  metadata.gz: cb2c6b600f446fa2bff8080b8056a32ceb3fda88be68c03db076591753c4992e
+  data.tar.gz: f4d65daa079f338c2a1a7ab5a0d326ae9af884d819a72077f1f24e8128ed70de
 SHA512:
-  metadata.gz: 3da42e489a2dc3a1d8b42191e589e675a71466048a70b1b2d04f430b2f3f34685f0c137194952a7c4ec33c117cf227b1143670409353351af9b8531492efc93b
-  data.tar.gz: e91123fa17ff8a9f47553652a302316418aaf2f5fe5eee587b45ecb9b27799ad20b39b9e1af350e4453ee69f19f4a8cd6a595ed82df2247c5bc8084c664768de
+  metadata.gz: 3059659aed2c2000401a6fceca177b9b7ea633adaaa1012bcb20db1069845bdc7dff35b97a53289a498399d1bc2217ceffd06c4dae94377ce7a47710c71ab2af
+  data.tar.gz: ab0e1a8aebca6fc8acf0e952e9a48956767b03e7cd9071d6487b52e0a544519e6801b927ae3b2f5021e1fc3ac8aeb95114488192fcd343b265b235efc38a6784

data/fat_period.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   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 'pry-byebug'
 
   spec.add_runtime_dependency 'fat_core', '>= 4.8.3'
 end

data/lib/fat_period/period.rb

@@ -70,35 +70,59 @@ class Period
     Period.new(first, second) if first && second
   end
 
-  # 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.
+  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
+
+  # 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.
   #
   # @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('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
+  #   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_phrase = phrase
-      to_phrase = nil
+      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]
+    else
+      whole_period.chunks(size: mm[:chunk_part], partial_first: partial_first,
+                         partial_last: partial_last, round_up_last: round_up_last)
     end
-    parse(from_phrase, to_phrase)
   end
 
   # @group Conversion
@@ -606,6 +630,7 @@ 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
@@ -614,14 +639,16 @@ 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

data/lib/fat_period/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_period
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel E. Doherty
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="