fat_core 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66c342d6384a15e67820f179df257c234d77810d
-  data.tar.gz: 23a1da18e31c2f77adbd4455206dfe1b54326bb9
+  metadata.gz: 159f439b8087d5ac894339f4d0abeb7776746576
+  data.tar.gz: 9412fdcf88d040555fde70a069d095f175e2b11b
 SHA512:
-  metadata.gz: d91ffaf07b1f4353dead0e81b03da11cd311a1a95fc3a0ed92f488336c85b4cbbfd92ee40d4db05ab165f93a7e0b6c6655373bd5963ecc00fbce90a6bac34fb5
-  data.tar.gz: 2f8d2eff64ae74ad5d51f2d2cdc3493a514f21464b4efd5d33881566f8003df7fb48e121b78055f7c995e2696fe565a193fa6cf4dcd40336a53e718b20eaace8
+  metadata.gz: f5a2bd9cb94bdc02660b5ab2ff63d15f10edb70b72c2a8fcf247ee35bd6b4ce51afc1be964da1a7ca2362f97334f60ff72eb8d44bdcadd8e8ef333988a5f3536
+  data.tar.gz: dd375a32bf06b4d9951074e860176198df4c79903984c5fb90f8bc663c5d6cb02b3f979f35795670f1b2f0d94e984f1cdf25e414415c1525dc56d06068db32d2

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/GPATH
+/GRTAGS
+/GTAGS

data/lib/fat_core/period.rb

@@ -123,44 +123,38 @@ class Period
     select(&:nyse_workday?)
   end
 
-  # Return a period based on two date specs (see Date.parse_spec), a '''from'
-  # and a 'to' spec.  If the to-spec is not given or is nil, the from-spec is
-  # used for both the from- and to-spec.  If no from-spec is given, return
-  # today as the period.
-  def self.parse_spec(from = 'today', to = nil)
+  # Return a period based on two date specs passed as strings (see
+  # Date.parse_spec), a '''from' and a 'to' spec.  If the to-spec is not given
+  # or is nil, the from-spec is used for both the from- and to-spec.
+  #
+  # Period.parse('2014-11') => Period.new('2014-11-01', 2014-11-30')
+  # Period.parse('2014-11', '2015-3Q')
+  #  => Period.new('2014-11-01', 2015-09-30')
+  def self.parse(from, to = nil)
+    raise ArgumentError, 'Period.parse missing argument' unless from
     to ||= from
-    from ||= to
     Period.new(Date.parse_spec(from, :from), Date.parse_spec(to, :to))
   end
 
-  def self.parse(spec = nil, default_spec: 'this_year', truncate: false)
-    spec = default_spec if spec.blank?
-    from, to = parse_from_to_spec(spec)
-    to ||= from
-    from ||= to
-    d1 = Date.parse_spec(from, :from) if from
-    d2 = Date.parse_spec(to, :to) if to
-    d1 ||= Date::BOT
-    d2 ||= Date::EOT
-    d2 = Date.current if truncate
-    Period.new(d1, d2)
-  end
-
-  # Extract start and end dates
-  def self.parse_from_to_spec(spec)
-    spec = spec.clean
-    if spec =~ /\Afrom (.*) to (.*)\z/
-      from_spec = $~[1]
-      to_spec = $~[2]
-    elsif spec =~ /\Afrom (.*)\z/
-      from_spec = $~[1]
-      to_spec = nil
-    elsif spec =~ /\Ato (.*)\z/
-      to_spec = $~[1]
+  # Return a period from a phrase in which the from date is introduced with
+  # 'from' and, optionally, the to-date is introduced with 'to'.
+  #
+  # Period.parse_phrase('from 2014-11 to 2015-3Q')
+  #  => Period('2014-11-01', '2015-09-30')
+  def self.parse_phrase(phrase)
+    phrase = phrase.clean
+    if phrase =~ /\Afrom (.*) to (.*)\z/
+      from_phrase = $~[1]
+      to_phrase = $~[2]
+    elsif phrase =~ /\Afrom (.*)\z/
+      from_phrase = $~[1]
+      to_phrase = nil
+    elsif phrase =~ /\Ato (.*)\z/
+      from_phrase = $~[1]
     else
-      to_spec = spec
+      from_phrase = phrase
     end
-    [from_spec, to_spec]
+    parse(from_phrase, to_phrase)
   end
 
   # Possibly useful class method to take an array of periods and join all the

data/lib/fat_core/version.rb

@@ -1,6 +1,6 @@
 module FatCore
-  MAJOR = 0
-  MINOR = 6
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')

data/spec/lib/period_spec.rb

@@ -42,77 +42,76 @@ describe Period do
   end
 
   describe 'class methods' do
-    it 'should be able to parse a period spec' do
-      pd = Period.parse
+    it 'should be able to parse a period phrase' do
+      pd = Period.parse_phrase('from this_year')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from 2012-07 to 2012')
+      pd = Period.parse_phrase('from 2012-07 to 2012')
       expect(pd.first).to eq(Date.parse('2012-07-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from 2Q')
+      pd = Period.parse_phrase('from 2Q')
       expect(pd.first).to eq(Date.parse('2012-04-01'))
       expect(pd.last).to eq(Date.parse('2012-06-30'))
 
-      pd = Period.parse('to 3Q')
+      pd = Period.parse_phrase('to 3Q')
       expect(pd.first).to eq(Date.parse('2012-07-01'))
       expect(pd.last).to eq(Date.parse('2012-09-30'))
 
-      pd = Period.parse('to 2012-2Q')
+      pd = Period.parse_phrase('to 2012-2Q')
       expect(pd.first).to eq(Date.parse('2012-04-01'))
       expect(pd.last).to eq(Date.parse('2012-06-30'))
 
-      pd = Period.parse('from 2012-1Q')
+      pd = Period.parse_phrase('from 2012-1Q')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-03-31'))
 
-      pd = Period.parse('from 2H')
+      pd = Period.parse_phrase('from 2H')
       expect(pd.first).to eq(Date.parse('2012-07-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('to 1H')
+      pd = Period.parse_phrase('to 1H')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-06-30'))
 
-      pd = Period.parse('to 2012-2H')
+      pd = Period.parse_phrase('to 2012-2H')
       expect(pd.first).to eq(Date.parse('2012-07-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from 2012-1H')
+      pd = Period.parse_phrase('from 2012-1H')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-06-30'))
 
-      pd = Period.parse('to 2012')
+      pd = Period.parse_phrase('to 2012')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from 2012')
+      pd = Period.parse_phrase('from 2012')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('2012')
+      pd = Period.parse_phrase('2012')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('this_year')
+      pd = Period.parse_phrase('this_year')
       expect(pd.first).to eq(Date.parse('2012-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from last_year to this_year')
+      pd = Period.parse_phrase('from last_year to this_year')
       expect(pd.first).to eq(Date.parse('2011-01-01'))
       expect(pd.last).to eq(Date.parse('2012-12-31'))
 
-      pd = Period.parse('from last_year to this_year', truncate: true)
+      pd = Period.parse_phrase('from last_year to this_year')
       expect(pd.first).to eq(Date.parse('2011-01-01'))
-      expect(pd.last).to eq(Date.parse('2012-07-18'))
+      expect(pd.last).to eq(Date.parse('2012-12-31'))
     end
 
     it 'should know how to parse a pair of date specs' do
-      expect(Period.parse_spec.first).to eq Date.current
-      expect(Period.parse_spec('2014-3Q').first).to eq Date.parse('2014-07-01')
-      expect(Period.parse_spec('2014-3Q').last).to eq Date.parse('2014-09-30')
-      expect(Period.parse_spec(nil, '2014-3Q').last).to eq Date.parse('2014-09-30')
+      expect(Period.parse('2014-3Q').first).to eq Date.parse('2014-07-01')
+      expect(Period.parse('2014-3Q').last).to eq Date.parse('2014-09-30')
+      expect(Period.parse('2014-3Q').last).to eq Date.parse('2014-09-30')
     end
 
     it 'should know what the valid chunk syms are' do
@@ -289,13 +288,13 @@ describe Period do
     end
 
     it "should be able to enumerate its days" do
-      Period.parse_spec('2014-12').each do |dy|
+      Period.parse('2014-12').each do |dy|
         expect(dy.class).to eq Date
       end
     end
 
     it "should be able to return the trading days within period" do
-      tds = Period.parse_spec('2014-12').trading_days
+      tds = Period.parse('2014-12').trading_days
       expect(tds.count).to eq(22)
     end
 
@@ -500,62 +499,62 @@ describe Period do
     end
 
     it "should know if it's a subset of another period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       expect(month.subset_of?(year)).to be true
       expect(year.subset_of?(year)).to be true
     end
 
     it "should know if it's a proper subset of another period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       expect(month.proper_subset_of?(year)).to be true
       expect(year.proper_subset_of?(year)).to be false
     end
 
     it "should know if it's a superset of another period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       expect(year.superset_of?(month)).to be true
       expect(year.superset_of?(year)).to be true
     end
 
     it "should know if it's a proper superset of another period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       expect(year.proper_superset_of?(month)).to be true
       expect(year.proper_superset_of?(year)).to be false
     end
 
     it "should know if it overlaps another period" do
-      period1 = Period.parse_spec('2013')
-      period2 = Period.parse_spec('2012-10', '2013-03')
-      period3 = Period.parse_spec('2014')
+      period1 = Period.parse('2013')
+      period2 = Period.parse('2012-10', '2013-03')
+      period3 = Period.parse('2014')
       expect(period1.overlaps?(period2)).to be true
       expect(period2.overlaps?(period1)).to be true
       expect(period1.overlaps?(period3)).to be false
     end
 
     it "should know whether an array of periods have overlaps within it" do
-      months = (1..12).to_a.map{ |k| Period.parse_spec("2013-#{k}") }
-      year = Period.parse_spec("2013")
+      months = (1..12).to_a.map{ |k| Period.parse("2013-#{k}") }
+      year = Period.parse("2013")
       expect(year.has_overlaps_within?(months)).to be false
-      months << Period.parse_spec("2013-09-15", "2013-10-02")
+      months << Period.parse("2013-09-15", "2013-10-02")
       expect(year.has_overlaps_within?(months)).to be true
     end
 
     it "should know whether an array of periods span it" do
-      months = (1..12).to_a.map{ |k| Period.parse_spec("2013-#{k}") }
-      year = Period.parse_spec("2013")
+      months = (1..12).to_a.map{ |k| Period.parse("2013-#{k}") }
+      year = Period.parse("2013")
       expect(year.spanned_by?(months)).to be true
 
-      months = (2..12).to_a.map{ |k| Period.parse_spec("2013-#{k}") }
+      months = (2..12).to_a.map{ |k| Period.parse("2013-#{k}") }
       expect(year.spanned_by?(months)).to be false
     end
 
     it "should know its intersection with other period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       expect(year & month).to eq(month)
       expect(month & year).to eq(month)
       # It should return a Period, not a Range
@@ -563,7 +562,7 @@ describe Period do
     end
 
     it "should alias narrow_to to intersection" do
-      period1 = Period.parse_spec('2014')
+      period1 = Period.parse('2014')
       period2 = Period.new('2014-06-01', '2015-02-28')
       period3 = period1.narrow_to(period2)
       expect(period3.first).to eq(period2.first)
@@ -571,14 +570,14 @@ describe Period do
     end
 
     it "should return nil if no intersection" do
-      year = Period.parse_spec('2014')
-      month = Period.parse_spec('2013-05')
+      year = Period.parse('2014')
+      month = Period.parse('2013-05')
       expect(year & month).to be_nil
     end
 
     it "should know its union with other period" do
-      last_month = Period.parse_spec('last_month')
-      month = Period.parse_spec('this_month')
+      last_month = Period.parse('last_month')
+      month = Period.parse('this_month')
       expect((last_month + month).first).to eq(last_month.first)
       expect((last_month + month).last).to eq(month.last)
       # It should return a Period, not a Range
@@ -586,8 +585,8 @@ describe Period do
     end
 
     it "should know its differences with other period" do
-      year = Period.parse_spec('this_year')
-      month = Period.parse_spec('this_month')
+      year = Period.parse('this_year')
+      month = Period.parse('this_month')
       # Note: the difference operator returns an Array of Periods resulting
       # from removing other from self.
       expect((year - month).first)
@@ -599,21 +598,21 @@ describe Period do
         expect(p.class).to eq(Period)
       end
 
-      last_year = Period.parse_spec('last_year')
-      month = Period.parse_spec('this_month')
+      last_year = Period.parse('last_year')
+      month = Period.parse('this_month')
       expect(last_year - month).to eq([last_year])
     end
 
     it "should be able to find gaps from an array of periods" do
-      pp = Period.parse_spec('2014-2Q')
+      pp = Period.parse('2014-2Q')
       periods = [
-                 Period.parse_spec('2013-11', '2013-12-20'),
-                 Period.parse_spec('2014-01', '2014-04-20'),
+                 Period.parse('2013-11', '2013-12-20'),
+                 Period.parse('2014-01', '2014-04-20'),
                  # Gap 2014-04-21 to 2014-04-30
-                 Period.parse_spec('2014-05', '2014-05-11'),
+                 Period.parse('2014-05', '2014-05-11'),
                  # Gap 2014-05-12 to 2014-05-24
-                 Period.parse_spec('2014-05-25', '2014-07-11'),
-                 Period.parse_spec('2014-09')
+                 Period.parse('2014-05-25', '2014-07-11'),
+                 Period.parse('2014-09')
                 ]
       gaps = pp.gaps(periods)
       expect(gaps.size).to eq(2)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_core
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel E. Doherty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov