periods 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bca4bb489addf1c13b97b9393036dea7c7a8750
-  data.tar.gz: 6f9b873e913d076b08d1ea25aa6d8ccc1a275c55
+  metadata.gz: f213b325b1d0a1f0121ae75fff7f51d98a94ba29
+  data.tar.gz: d88cb1821b6b0552b6c4ce7d3046e13a4ff7dc59
 SHA512:
-  metadata.gz: 0fd1215e00f8890bab21bda707d6904a43d05aaa8717c3885e9114a9b41cc13fc16e3d30324ea8ade7669c4af1ea192266d5efe17bee639a66ea21bffd022ac0
-  data.tar.gz: 47461d42951e77ff77f8c57dd185b66b96e0e67f8a69ff7364996490ae1d90cb70d7b95ed323c13cb8cf972c693eb01ac4fbe498f715f925028e5ef198a244f5
+  metadata.gz: e72c9f950fd4d18d80fb4c0f96dbe3e127eb4ea5250aa6ce5c8d7a71f7a08d936f1d93e318f6510ebbc9a7ec237418a45a5265c6f0a453c4bf9a4d9e121d96f7
+  data.tar.gz: 550a89717f3a6a21f5827efe343826d676db91f6f235f557e276d5f4b81cc99cf93c83798d8051a4f221df3f99489e7d6812b3a4ea3fa7388718b1ead68e55d9

data/README.md

@@ -41,16 +41,34 @@ The start and end date can be a string too:
 
     period = Period.new('25.06.2015', '19.08.2015')
 
+For convenience a period can be passed too:
+
+    period = Period.new('25.06.2015', '19.08.2015')
+    ...
+    period2 = Period.new(period)
+
 All period models respond to the following interface:
 
+    * start_year
+    * end_year
+    * days
     * next
     * previous
-    * days
     * include?
-    * comparing (==, >=, >, <=, <)
-    * ...
+    * Comparable (==, >=, >, <=, <)
+    * to_s
+
+Special period models may define additional methods like `months` (see below).
+
+#### start_year
 
-Special period models may define additional methods (see below).
+    period = Period.new('25.06.2015', '19.08.2016')
+    period.start_year # => 2015
+ 
+#### end_year 
+
+    period = Period.new('25.06.2015', '19.08.2016')
+    period.end_year # => 2016
 
 #### days
 
@@ -97,23 +115,24 @@ If you need a calendar month starting at first day of month and ending at last d
     june.next     # => 01.07.2015 - 31.07.2015
     june.previous # => 01.05.2015 - 31.05.2015
     june.month    # => 6
+    june.number   # => 6 (alias for month)
     june.year     # => 2015
 
 ### QuarterlyPeriod
 
+A QuarterlyPeriod starts at given date and ends at last day three months later:
+
     period = QuarterlyPeriod.for('25.06.2015') # => 25.06.2015 - 24.09.2015
 
 ### Quarter
 
-A quarter starts at first day of a month and ends at last day three months later:
+A Quarter starts at first day of a month and ends at last day three months later:
 
     quarter = Quarter.for('01.02.2015') # => 01.02.2015 - 30.04.2015
     quarter.next     # => 01.05.2015 - 31.07.2015
     quarter.previous # => 01.11.2014 - 31.01.2015
     
     quarter = Quarter.for('01.12.2015') # => 01.12.2015 - 29.02.2016
-    quarter.start_year # => 2015
-    quarter.end_year   # => 2016
     quarter.months     # => [Month.for('01.12.2015'), Month.for('01.01.2016'), Month.for('01.02.2016')]
 
 ### HalfyearlyPeriod

data/lib/periods/modules/period.rb

@@ -24,11 +24,20 @@ module Periods
         #
         # @example
         #
+        #    period = Period.new(Date.new(2015,4,10), Date.new(2015,5,20))
         #    period = Period.new('10.04.2015', '20.05.2015')
-        #
-        def initialize(start_date, end_date)
-          @start_date = Date.parse(start_date.to_s)
-          @end_date = Date.parse(end_date.to_s)
+        #    period = Period.new(Period.new('10.04.2015', '20.05.2015'))
+        #
+        def initialize(start_date, end_date = nil)
+          if start_date.is_a?(Period)
+            @start_date = start_date.start_date
+            @end_date = start_date.end_date
+          elsif end_date.nil?
+            raise ArgumentError, "Period is missing end_date, e.g. Period.new(start_date, end_date)."
+          else
+            @start_date = Date.parse(start_date.to_s)
+            @end_date = Date.parse(end_date.to_s)
+          end
         end
 
         ##

data/lib/periods/version.rb

@@ -1,3 +1,3 @@
 module Periods
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/lib/period_spec.rb

@@ -7,6 +7,33 @@ describe Period do
     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))
+
+      expect(period.start_date).to eq Date('25.06.2015')
+      expect(period.end_date).to eq Date('20.05.2016')
+    end
+
+    it "accepts String" do
+      period = described_class.new('25.06.2015', '20.05.2016')
+
+      expect(period.start_date).to eq Date('25.06.2015')
+      expect(period.end_date).to eq Date('20.05.2016')
+    end
+
+    it "raises error if end date is missing" do
+      expect { described_class.new('25.06.2015', nil) }.to raise_error(ArgumentError)
+    end
+
+    it "accepts Period" do
+      period = described_class.new(Period.new('25.06.2015', '20.05.2016'))
+
+      expect(period.start_date).to eq Date('25.06.2015')
+      expect(period.end_date).to eq Date('20.05.2016')
+    end
+  end
+
   describe "==" do
     context "same period given" do
       it "returns true" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periods
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Thomas Baustert