periods 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a368b82d45f08540c0ab40732abb61d69b0a6cd
-  data.tar.gz: 1a626aed26b792da37379d8458daaf9e780ac277
+  metadata.gz: 446ed0da6cb8d02aec93a6573ff028b3e6bd1f19
+  data.tar.gz: dc4766070198c6d772a425c930c8007cd8ca7442
 SHA512:
-  metadata.gz: 8e37c81f7bc38bc25bcb287118c8fe7566b791a309c7687309fb3ecb1654f8dab62ca9bb042fb097613dc4558fc96b62c2eecb743aa5ce51a7c6c322290385ec
-  data.tar.gz: f3f5685b1666a8b6025dd8f376aa88292212b9af9dbda29329f0310be176faa1a357a0f9b1c642e3590c01d5537b58fd4ec69eb2c788b7c9835b3132af48bbd0
+  metadata.gz: acb40fd424a1e9fde278330c80bea9643f254e6ebe22679fec392a5a6babf38253649840b7bf6c407629a48caa9863357fefd520971bc60d3c1ee3b89c790958
+  data.tar.gz: 0cdf35d04f87cf7c5b8efb59d2f21f7597585b440058400a28823fafb2df1c66c79884b8edf475ba6f8953c1f48e253d8c1290a1695f6c49aa67d12e0e8698ae

data/README.md

@@ -109,6 +109,22 @@ Test whether a date or a period is included in the given period:
     period.include?(Period.new('24.06.2015', '19.08.2015')) # => false
     period.include?(Period.new('25.06.2015', '20.08.2015')) # => false
 
+### WeeklyPeriod
+
+If you need a constant weekly range use `WeeklyPeriod`:
+
+    weekly = WeeklyPeriod.for('25.06.2015') # => 25.06.2015 - 01.07.2015
+    weekly.next     # => 02.07.2015 - 08.07.2015
+    weekly.previous # => 18.06.2015 - 24.06.2015
+
+### Week
+
+Same as `WeeklyPeriod`:
+
+    week = Week.for('25.06.2015') # => 25.06.2015 - 01.07.2015
+    week.next     # => 02.07.2015 - 08.07.2015
+    week.previous # => 18.06.2015 - 24.06.2015
+
 ### MonthlyPeriod
 
 If you need a constant monthly range use `MonthlyPeriod`:
@@ -202,14 +218,6 @@ Write your own classes:
     month = MyMonth.for('01.08.2015')
     ...
 
-## TODO
-
-* Implement Week
-* Use Time not Date
-* Optimize README
-* Comment Code
-* Provide helper methods Month('25.06.2015'), Quarter(), ...
-
 ## Contributing
 
 1. Fork it

data/lib/periods/classes.rb

@@ -8,5 +8,6 @@ require 'periods/halfyear'
 require 'periods/halfyearly_period'
 require 'periods/year'
 require 'periods/yearly_period'
-
+require 'periods/week'
+require 'periods/weekly_period'
 

data/lib/periods/constants.rb

@@ -15,3 +15,5 @@ HalfyearlyPeriod = Periods::HalfyearlyPeriod
 Year = Periods::Year
 YearlyPeriod = Periods::YearlyPeriod
 
+Week = Periods::Week
+WeeklyPeriod = Periods::WeeklyPeriod

data/lib/periods/modules/week.rb

@@ -0,0 +1,22 @@
+require 'periods/date_calculator'
+require 'periods/modules/weekly_period'
+
+module Periods
+  module Modules
+    module Week
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::WeeklyPeriod
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+
+        private
+
+      end
+    end
+  end
+end

data/lib/periods/modules/weekly_period.rb

@@ -0,0 +1,44 @@
+require 'periods/modules/period'
+require 'periods/modules/single_date_initialize'
+
+module Periods
+  module Modules
+    module WeeklyPeriod
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::Period
+          include SingleDateInitialize
+          include InstanceMethods
+          alias_method :succ, :next
+        end
+      end
+
+      module InstanceMethods
+        ##
+        # 25.06.2015 => 02.07.2015
+        #
+        def next
+          self.class.for(start_date + 7)
+        end
+
+        ##
+        # 02.07.2015 => 25.06.2015
+        #
+        def previous
+          self.class.for(start_date - 7)
+        end
+
+        def days
+          7
+        end
+
+        private
+          def init_with_date(date)
+            init_with_dates(date, date + 6)
+          end
+
+      end
+    end
+  end
+end

data/lib/periods/version.rb

@@ -1,3 +1,3 @@
 module Periods
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/periods/week.rb

@@ -0,0 +1,9 @@
+require 'periods/modules/week'
+
+module Periods
+  class Week
+    include Periods::Modules::Week
+  end
+end
+
+

data/lib/periods/weekly_period.rb

@@ -0,0 +1,9 @@
+require 'periods/modules/weekly_period'
+
+module Periods
+  class WeeklyPeriod
+    include Periods::Modules::WeeklyPeriod
+  end
+end
+
+

data/spec/lib/monthly_period_spec.rb

@@ -63,4 +63,21 @@ describe MonthlyPeriod do
     end
   end
 
+  describe "#include?" do
+    context "week is included" do
+      it "returns true" do
+        expect(described_class.for('01.06.2015').include?(Week.for('01.06.2015'))).to be_truthy
+        expect(described_class.for('01.06.2015').include?(Week.for('02.06.2015'))).to be_truthy
+        expect(described_class.for('01.06.2015').include?(Week.for('07.06.2015'))).to be_truthy
+      end
+    end
+
+    context "week is not included" do
+      it "returns false" do
+        expect(described_class.for('01.06.2015').include?(Week.for('31.05.2015'))).to be_falsey
+        expect(described_class.for('01.06.2015').include?(Week.for('25.06.2015'))).to be_falsey
+      end
+    end
+  end
+
 end

data/spec/lib/weekly_period_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'periods/constants'
+require 'initialized_by_single_date'
+
+describe WeeklyPeriod do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Initialized by single date" do
+    let(:period) { described_class.for(Date.new(2015,6,25)) }
+  end
+
+  describe "#next" do
+    it "returns next period" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('02.07.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('08.07.2015')
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous period" do
+      expect(described_class.for('25.06.2015').previous).to eq described_class.for('18.06.2015')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('24.06.2015')
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(described_class.for("01.01.2015").days).to eq 7
+      expect(described_class.for("25.06.2015").days).to eq 7
+      expect(described_class.for("01.01.2016").days).to eq 7
+      expect(described_class.for("01.03.2016").days).to eq 7
+    end
+  end
+
+  describe "#include?" do
+    let(:period) { described_class.for('25.06.2015') }
+
+    context "date included" do
+      it "returns true" do
+        puts period
+        expect(period.include?('25.06.2015')).to be_truthy
+        expect(period.include?('01.07.2015')).to be_truthy
+      end
+    end
+
+    context "date not included" do
+      it "returns false" do
+        expect(period.include?('24.06.2015')).to be_falsey
+        expect(period.include?('02.07.2015')).to be_falsey
+      end
+    end
+
+    context "period included" do
+      it "returns true" do
+        expect(period.include?(Period.new('25.06.2015', '25.06.2015'))).to be_truthy
+        expect(period.include?(Period.new('25.06.2015', '01.07.2015'))).to be_truthy
+        expect(period.include?(Period.new('26.06.2015', '01.07.2015'))).to be_truthy
+        expect(period.include?(Period.new('25.06.2015', '30.06.2015'))).to be_truthy
+      end
+    end
+
+    context "period not included" do
+      it "returns false" do
+        expect(period.include?(Period.new('24.06.2015', '02.07.2015'))).to be_falsey
+        expect(period.include?(Period.new('25.06.2015', '02.07.2015'))).to be_falsey
+        expect(period.include?(Period.new('24.06.2015', '02.07.2015'))).to be_falsey
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periods
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Thomas Baustert
@@ -84,6 +84,8 @@ files:
 - lib/periods/modules/quarter.rb
 - lib/periods/modules/quarterly_period.rb
 - lib/periods/modules/single_date_initialize.rb
+- lib/periods/modules/week.rb
+- lib/periods/modules/weekly_period.rb
 - lib/periods/modules/year.rb
 - lib/periods/modules/yearly_period.rb
 - lib/periods/month.rb
@@ -93,6 +95,8 @@ files:
 - lib/periods/quarter.rb
 - lib/periods/quarterly_period.rb
 - lib/periods/version.rb
+- lib/periods/week.rb
+- lib/periods/weekly_period.rb
 - lib/periods/year.rb
 - lib/periods/yearly_period.rb
 - periods.gemspec
@@ -108,6 +112,7 @@ files:
 - spec/lib/periods/date_calculator_spec.rb
 - spec/lib/quarter_spec.rb
 - spec/lib/quarterly_period_spec.rb
+- spec/lib/weekly_period_spec.rb
 - spec/lib/year_spec.rb
 - spec/lib/yearly_period_spec.rb
 - spec/spec_helper.rb
@@ -148,6 +153,7 @@ test_files:
 - spec/lib/periods/date_calculator_spec.rb
 - spec/lib/quarter_spec.rb
 - spec/lib/quarterly_period_spec.rb
+- spec/lib/weekly_period_spec.rb
 - spec/lib/year_spec.rb
 - spec/lib/yearly_period_spec.rb
 - spec/spec_helper.rb