periods 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be562d9701b30b7afcfc6dac163ad6e9a7cad181
-  data.tar.gz: a57326343a2442706f503dfe46776e5c084fc876
+  metadata.gz: 157af8429236011f6b5d28c43df6a6c6fd96156e
+  data.tar.gz: 80a7b74aa78c8e08b39a41e7e1c505a748162d40
 SHA512:
-  metadata.gz: 7d03693f89c82cca815bb05ec1c4a3a03d0250c196a757c6b658dad0c41c47b9aa7d21ab4abb192c562d10f5908da4e1a2b210dfca53832e5a8afb005c6f8b90
-  data.tar.gz: 8464da097b035ad3ea932e43450efab9edeefbdf4eac9938652910e8e202e54e7a8a712ad263f38ce80615d0086a67572cf93524ce2f1eb741ad92282dcbad72
+  metadata.gz: 8d702a50cef9515c488948d02537cf912e7694704a832b72b62e62836b86f7092bf560f4f97011444ae7582e3f127a9a82f92b3b4fe45f3b32f234a0f259fe20
+  data.tar.gz: 1fa325d6fb372e852759ff8cc341a0d7aaeb6ec1fcb67f9f998adc22aada49e42b4fa7cb93eb2cee355abaf7e9c82240bf381e6b077cee91e58344695f2460ca

data/README.md

@@ -111,7 +111,7 @@ If you need a constant monthly range use `MonthlyPeriod`:
 
 If you need a calendar month starting at first day of month and ending at last day of month use `Month`:
 
-    june = MonthPeriod.for('25.06.2015') # => 01.06.2015 - 30.06.2015
+    june = Month.for('25.06.2015') # => 01.06.2015 - 30.06.2015
     june.next     # => 01.07.2015 - 31.07.2015
     june.previous # => 01.05.2015 - 31.05.2015
     june.month    # => 6

data/lib/periods/modules/halfyearly_period.rb

@@ -10,6 +10,7 @@ module Periods
           include Periods::Modules::Period
           include SingleDateInitialize
           include InstanceMethods
+          alias_method :succ, :next
         end
       end
 

data/lib/periods/modules/month.rb

@@ -9,6 +9,7 @@ module Periods
         base.class_eval do
           include Periods::Modules::MonthlyPeriod
           include InstanceMethods
+          alias_method :succ, :next
         end
       end
 
@@ -25,10 +26,10 @@ module Periods
         end
 
         def to_s(*args)
-          if args.first.to_s == 'date'
-            "#{start_date.strftime("%m.%Y")} (#{start_date.strftime("%d.%m.%Y")} - #{end_date.strftime("%d.%m.%Y")})"
-          else
+          if args.first.to_s == 'month'
             "#{start_date.strftime("%m.%Y")}"
+          else
+            super
           end
         end
 

data/lib/periods/modules/period.rb

@@ -205,6 +205,98 @@ module Periods
           "#{start_date.strftime("%d.%m.%Y")} - #{end_date.strftime("%d.%m.%Y")}"
         end
 
+        ##
+        # Returns the months included in this period including the month of the start and end date
+        # of this period.
+        #
+        # @return [Month] an array of months included in this period.
+        #
+        # @since 0.0.7
+        #
+        # @example
+        #
+        #    Period.new('01.01.2015', '31.12.2015').months # => Jan, Feb, ..., Dec
+        #    Period.new('17.04.2015', '26.08.2015').months # => Apr, Mai, Jun, Jul, Aug
+        #
+        def months
+          (Periods::Month.for(start_date)..Periods::Month.for(end_date)).to_a
+        end
+
+        ##
+        # Returns the quarters included in this period including the quarter of the start date
+        # of this period. The quarter of the end date of this period is only included if the
+        # quarter's end date is before/equal the end date of this period.
+        #
+        # @return [Quarter] an array of quarters included in this period.
+        #
+        # @since 0.0.7
+        #
+        # @example
+        #
+        #    Period.new('01.01.2015', '31.12.2015').quarters # => [(J,F,M),(A,M,J),(J,A,S),(O,N,D)]
+        #    Period.new('17.04.2015', '26.08.2015').quarters # => [(A,M,J) but not (J,A,S)]
+        #
+        def quarters
+          quarters = []
+          quarter  = Periods::Quarter.for(start_date)
+          while quarter.end_date <= end_date
+            quarters << quarter
+            quarter = quarter.next
+          end
+          quarters
+        end
+
+        ##
+        # Returns the halfyears included in this period including the halfyear of the start date
+        # of this period. The halfyear of the end date of this period is only included if the
+        # halfyear's end date is before/equal the end date of this period.
+        #
+        # @return [Halfyear] an array of halfyears included in this period.
+        #
+        # @since 0.0.7
+        #
+        # @example
+        #
+        #    Period.new('01.01.2015', '31.12.2015').halfyears # => [(Jan-Jun),(Jul-Dec)]
+        #    Period.new('17.04.2015', '26.08.2015').halfyears # => []
+        #    Period.new('01.01.2015', '31.05.2016').halfyears # => [(Jan-Jun),(Jul-Dec)]
+        #    Period.new('01.01.2015', '30.06.2016').halfyears # => [(Jan-Jun),(Jul-Dec),(Jan-Jun)]
+        #
+        def halfyears
+          halfyears = []
+          halfyear  = Periods::Halfyear.for(start_date)
+          while halfyear.end_date <= end_date
+            halfyears << halfyear
+            halfyear = halfyear.next
+          end
+          halfyears
+        end
+
+        ##
+        # Returns the years included in this period including the year of the start date
+        # of this period. The year of the end date of this period is only included if the
+        # year's end date is before/equal the end date of this period.
+        #
+        # @return [Year] an array of halfyears included in this period.
+        #
+        # @since 0.0.7
+        #
+        # @example
+        #
+        #    Period.new('01.01.2015', '31.12.2015').halfyears # => [(Jan-Dec)]
+        #    Period.new('17.04.2015', '26.08.2015').halfyears # => []
+        #    Period.new('01.01.2015', '31.05.2016').halfyears # => [(Jan-Dec)]
+        #    Period.new('01.01.2015', '31.12.2016').halfyears # => [(Jan-Dec),(Jan-Dec)]
+        #
+        def years
+          years = []
+          year  = Periods::Year.for(start_date)
+          while year.end_date <= end_date
+            years << year
+            year = year.next
+          end
+          years
+        end
       end
     end
   end

data/lib/periods/modules/quarterly_period.rb

@@ -11,6 +11,7 @@ module Periods
           include Periods::Modules::Period
           include SingleDateInitialize
           include InstanceMethods
+          alias_method :succ, :next
         end
       end
 

data/lib/periods/modules/yearly_period.rb

@@ -10,6 +10,7 @@ module Periods
           include Periods::Modules::Period
           include SingleDateInitialize
           include InstanceMethods
+          alias_method :succ, :next
         end
       end
 

data/lib/periods/version.rb

@@ -1,3 +1,3 @@
 module Periods
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/lib/halfyear_spec.rb

@@ -6,7 +6,6 @@ describe Halfyear do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/halfyearly_period_spec.rb

@@ -6,7 +6,6 @@ describe HalfyearlyPeriod do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/january_spec.rb

@@ -6,8 +6,6 @@ describe January do
 
   let(:subject) { January.of(2015) }
 
-  it_behaves_like "Lint Check"
-
   describe ".of" do
     it "returns January of given year" do
       expect(described_class.of(2014)).to eq Month.for('01.01.2014')

data/spec/lib/month_spec.rb

@@ -6,7 +6,6 @@ describe Month do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end
@@ -50,4 +49,30 @@ describe Month do
       expect(described_class.for('01.01.2014').year).to eq 2014
     end
   end
+
+  describe "#to_s" do
+    context "nothing passed" do
+      it "returns period" do
+        expect(described_class.for('01.03.2015').to_s).to eq "01.03.2015 - 31.03.2015"
+        expect(described_class.for('01.06.2015').to_s).to eq "01.06.2015 - 30.06.2015"
+      end
+    end
+
+    context ":month passed" do
+      it "returns month.year" do
+        expect(described_class.for('01.01.2015').to_s(:month)).to eq "01.2015"
+        expect(described_class.for('01.06.2015').to_s(:month)).to eq "06.2015"
+      end
+    end
+  end
+
+  describe "Range" do
+    it "works" do
+      expect((Month.for("01.01.2015")..Month.for("31.01.2015")).to_a).to eq new_months("01.01.2015",  1)
+      expect((Month.for("01.01.2015")..Month.for("28.02.2015")).to_a).to eq new_months("01.01.2015",  2)
+      expect((Month.for("01.01.2015")..Month.for("26.08.2015")).to_a).to eq new_months("01.01.2015",  8)
+      expect((Month.for("01.01.2015")..Month.for("31.12.2015")).to_a).to eq new_months("01.01.2015", 12)
+      expect((Month.for("01.01.2015")..Month.for("31.05.2016")).to_a).to eq new_months("01.01.2015", 17)
+    end
+  end
 end

data/spec/lib/monthly_period_spec.rb

@@ -6,7 +6,6 @@ describe MonthlyPeriod do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/period_spec.rb

@@ -3,10 +3,6 @@ require 'periods/constants'
 
 describe Period do
 
-  def new_period(start_date, end_date)
-    described_class.new(start_date, end_date)
-  end
-
   describe ".new" do
     it "accepts Date" do
       period = described_class.new(Date.new(2015,6,25), Date.new(2016,5,20))
@@ -142,6 +138,51 @@ describe Period do
       end
     end
   end
+
+  describe "#to_s" do
+    it "returns period" do
+      expect(new_period("09.04.2015", "20.05.2015").to_s).to eq "09.04.2015 - 20.05.2015"
+      expect(new_period("26.06.2014", "10.09.2015").to_s).to eq "26.06.2014 - 10.09.2015"
+    end
+  end
+
+  describe "#months" do
+    it "returns months included period" do
+      expect(new_period("01.01.2015", "31.12.2015").months).to eq new_months("01.01.2015", 12)
+      expect(new_period("17.04.2015", "26.08.2015").months).to eq new_months("01.04.2015",  5)
+      expect(new_period("01.01.2015", "31.05.2016").months).to eq new_months("01.01.2015", 17)
+      expect(new_period("08.02.2015", "09.02.2015").months).to eq new_months("01.02.2015",  1)
+    end
+  end
+
+  describe "#quarters" do
+    it "returns quarters included period" do
+      expect(new_period("01.01.2015", "31.12.2015").quarters).to eq new_quarters("01.01.2015", 4)
+      expect(new_period("17.04.2015", "26.08.2015").quarters).to eq new_quarters("01.04.2015", 1)
+      expect(new_period("17.04.2015", "31.05.2015").quarters).to eq []
+      expect(new_period("01.01.2015", "31.05.2016").quarters).to eq new_quarters("01.01.2015", 5)
+    end
+  end
+
+  describe "#halfyears" do
+    it "returns halfyears included period" do
+      expect(new_period("01.01.2015", "31.12.2015").halfyears).to eq new_halfyears("01.01.2015", 2)
+      expect(new_period("17.04.2015", "26.08.2015").halfyears).to eq []
+      expect(new_period("01.01.2015", "31.05.2016").halfyears).to eq new_halfyears("01.01.2015", 2)
+      expect(new_period("01.01.2015", "30.06.2016").halfyears).to eq new_halfyears("01.01.2015", 3)
+      expect(new_period("01.01.2015", "20.07.2016").halfyears).to eq new_halfyears("01.01.2015", 3)
+    end
+  end
+
+  describe "#years" do
+    it "returns years included period" do
+      expect(new_period("01.01.2015", "31.12.2015").years).to eq [Periods::Year.for("01.01.2015")]
+      expect(new_period("17.04.2015", "26.08.2015").years).to eq []
+      expect(new_period("01.01.2015", "31.05.2016").years).to eq [Periods::Year.for("01.01.2015")]
+      expect(new_period("01.01.2015", "30.06.2016").years).to eq [Periods::Year.for("01.01.2015")]
+      expect(new_period("01.01.2015", "31.12.2016").years).to eq [Periods::Year.for("01.01.2015"), Periods::Year.for("01.01.2016")]
+    end
+  end
 end
 
 

data/spec/lib/quarter_spec.rb

@@ -6,7 +6,6 @@ describe Quarter do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/quarterly_period_spec.rb

@@ -6,7 +6,6 @@ describe QuarterlyPeriod do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/year_spec.rb

@@ -6,7 +6,6 @@ describe Year do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/lib/yearly_period_spec.rb

@@ -6,7 +6,6 @@ describe YearlyPeriod do
 
   let(:subject) { described_class.for("1.1.2015") }
 
-  it_behaves_like "Lint Check"
   it_behaves_like "Initialized by single date" do
     let(:period) { described_class.for(Date.new(2015,6,25)) }
   end

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require 'lint_check'
-
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -76,4 +74,39 @@ end
 
 def Date(date)
   Date.parse(date.to_s)
-end
+end
+
+def new_period(start_date, end_date)
+  described_class.new(start_date, end_date)
+end
+
+def new_months(start_date, count)
+  months = [Periods::Month.for(start_date)]
+  month  = months.first.next
+  2.upto(count) do |idx|
+    months << month
+    month = month.next
+  end
+  months
+end
+
+def new_quarters(start_date, count)
+  quarters = [Periods::Quarter.for(start_date)]
+  quarter  = quarters.first.next
+  2.upto(count) do |idx|
+    quarters << quarter
+    quarter = quarter.next
+  end
+  quarters
+end
+
+def new_halfyears(start_date, count)
+  halfyears = [Periods::Halfyear.for(start_date)]
+  halfyear  = halfyears.first.next
+  2.upto(count) do |idx|
+    halfyears << halfyear
+    halfyear = halfyear.next
+  end
+  halfyears
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: periods
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Thomas Baustert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,6 @@ files:
 - spec/lib/quarterly_period_spec.rb
 - spec/lib/year_spec.rb
 - spec/lib/yearly_period_spec.rb
-- spec/lint_check.rb
 - spec/spec_helper.rb
 homepage: https://github.com/thomasbaustert/periods
 licenses:
@@ -132,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple period types like Week, Month, Quarter, Halfyear, Year.
@@ -151,5 +150,4 @@ test_files:
 - spec/lib/quarterly_period_spec.rb
 - spec/lib/year_spec.rb
 - spec/lib/yearly_period_spec.rb
-- spec/lint_check.rb
 - spec/spec_helper.rb

data/spec/lint_check.rb

@@ -1,24 +0,0 @@
-shared_examples "Lint Check" do
-
-  it "respond #next" do
-    expect(subject).to respond_to(:next)
-  end
-
-  it "respond #previous" do
-    expect(subject).to respond_to(:previous)
-  end
-
-  it "respond #days" do
-    expect(subject).to respond_to(:days)
-  end
-
-  it "respond #include?" do
-    expect(subject).to respond_to(:include?)
-  end
-
-  it "is Comparable" do
-    expect(subject).to be_kind_of(Comparable)
-  end
-end
-
-