periods 0.0.1

data/lib/periods/modules/year.rb

@@ -0,0 +1,85 @@
+require 'periods/date_calculator'
+require 'periods/modules/yearly_period'
+
+module Periods
+  module Modules
+    module Year
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::YearlyPeriod
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        ##
+        # '25.06.2015' => 01.06.2015 - '30.05.2016'
+        #
+        def for(date)
+          new(date)
+        end
+      end
+
+      module InstanceMethods
+
+        def initialize(date)
+          date = Date.parse(date.to_s)
+          super(beginning_of_month(date), end_of_month(beginning_of_month(date).next_year.prev_day))
+        end
+
+        ##
+        # 01.06.2015 => 01.06.2016
+        #
+        def next
+          self.class.for(start_date.next_year)
+        end
+
+        ##
+        # 01.06.2015 => 01.06.2014
+        #
+        def previous
+          self.class.for(start_date.prev_year)
+        end
+
+        def days
+          (self.next.start_date - start_date).to_i
+        end
+
+        def include?(period)
+          if period.is_a?(String) || period.is_a?(Date)
+            super
+          elsif period.is_a?(Period)
+            start_date <= period.start_date && period.end_date <= end_date
+          else
+            false
+          end
+        end
+
+        def year
+          start_date.year
+        end
+
+        def months
+          months = [Periods::Month.for(start_date)]
+          1.upto(11) do |idx|
+            months << Periods::Month.for(start_date.next_month(idx))
+          end
+          months
+        end
+
+        private
+
+          def beginning_of_month(date)
+            Periods::DateCalculator.new(date).beginning_of_month
+          end
+
+          def end_of_month(date)
+            Periods::DateCalculator.new(date).end_of_month
+          end
+
+      end
+    end
+  end
+end

data/lib/periods/modules/yearly_period.rb

@@ -0,0 +1,57 @@
+require 'periods/modules/period'
+
+module Periods
+  module Modules
+    module YearlyPeriod
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::Period
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        ##
+        # '25.06.2015' => 25.06.2015 - '24.06.2016'
+        #
+        def for(date)
+          date = Date.parse(date.to_s)
+          new(date, date.next_year.prev_day)
+        end
+      end
+
+      module InstanceMethods
+        ##
+        # 25.06.2015 => 25.06.2016
+        #
+        def next
+          self.class.for(start_date.next_year)
+        end
+
+        ##
+        # 25.06.2015 => 25.06.2014
+        #
+        def previous
+          self.class.for(start_date.prev_year)
+        end
+
+        def days
+          (self.next.start_date - start_date).to_i
+        end
+
+        def include?(period)
+          if period.is_a?(String) || period.is_a?(Date)
+            super
+          elsif period.is_a?(Period)
+            start_date <= period.start_date && period.end_date <= end_date
+          else
+            false
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/periods/modules.rb

@@ -0,0 +1,12 @@
+require 'periods/modules/period'
+require 'periods/modules/month'
+require 'periods/modules/monthly_period'
+require 'periods/modules/quarter'
+require 'periods/modules/quarterly_period'
+require 'periods/modules/halfyear'
+require 'periods/modules/halfyearly_period'
+require 'periods/modules/year'
+require 'periods/modules/yearly_period'
+
+
+

data/lib/periods/month.rb

@@ -0,0 +1,12 @@
+require 'periods/modules/month'
+
+##
+# A month always starts at first day of month and ends at last day of month.
+#
+module Periods
+  class Month
+    include Periods::Modules::Month
+  end
+end
+
+

data/lib/periods/monthly_period.rb

@@ -0,0 +1,12 @@
+require 'periods/modules/monthly_period'
+
+##
+# A monthly period starts one a day X in month and ends on one day before X in the next month,
+# e.g. from 25.06.2015 to 24.07.2015
+#
+module Periods
+  class MonthlyPeriod
+    include Periods::Modules::MonthlyPeriod
+  end
+end
+

data/lib/periods/period.rb

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

data/lib/periods/quarter.rb

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

data/lib/periods/quarterly_period.rb

@@ -0,0 +1,8 @@
+require 'periods/modules/quarterly_period'
+
+module Periods
+  class QuarterlyPeriod
+    include Periods::Modules::QuarterlyPeriod
+  end
+end
+

data/lib/periods/version.rb

@@ -0,0 +1,3 @@
+module Periods
+  VERSION = "0.0.1"
+end

data/lib/periods/year.rb

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

data/lib/periods/yearly_period.rb

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

data/lib/periods.rb

@@ -0,0 +1,4 @@
+require 'periods/constants'
+
+module Periods
+end

data/periods.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'periods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "periods"
+  spec.version       = Periods::VERSION
+  spec.authors       = ["Thomas Baustert"]
+  spec.email         = ["business@thomasbaustert.de"]
+  spec.summary       = %q{Simple period types like Week, Month, Quarter, Halfyear, Year.}
+  spec.description   = %q{Simple period types like Week, Month, Quarter, Halfyear, Year.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/spec/lib/halfyear_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe Halfyear do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns month of given date included" do
+      month = described_class.for('25.06.2015')
+
+      expect(month.start_date).to eq date('01.06.2015')
+      expect(month.end_date).to eq date('30.11.2015')
+    end
+  end
+
+  describe "#next" do
+    it "returns next month" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('01.12.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.01.2016')
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous month" do
+      expect(described_class.for('25.06.2015').previous).to eq described_class.for('01.12.2014')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.01.2015')
+    end
+  end
+
+  describe "#months" do
+    it "returns months of year" do
+      expect(described_class.for('01.06.2015').months).
+          to eq [ Month.for('01.06.2015'), Month.for('01.07.2015'), Month.for('01.08.2015'),
+                  Month.for('01.09.2015'), Month.for('01.10.2015'), Month.for('01.11.2015')
+                ]
+    end
+  end
+end

data/spec/lib/halfyearly_period_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe HalfyearlyPeriod do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns halfyear of given date included" do
+      period = described_class.for('25.06.2015')
+
+      expect(period.start_date).to eq date('25.06.2015')
+      expect(period.end_date).to eq date('24.12.2015')
+    end
+  end
+
+  describe "#next" do
+    it "returns next quarter" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('25.12.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.01.2016')
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous quarter" do
+      expect(described_class.for('25.06.2015').previous).to eq described_class.for('25.12.2014')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.01.2015')
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(described_class.for("01.01.2015").days).to eq 181
+      expect(described_class.for("25.06.2015").days).to eq 183
+      expect(described_class.for("01.01.2016").days).to eq 182
+      expect(described_class.for("01.03.2016").days).to eq 184
+    end
+  end
+
+  describe "#include?" do
+    let(:period) { described_class.for('25.06.2015') }
+
+    context "date included" do
+      it "returns true" do
+        expect(period.include?('25.06.2015')).to be_truthy
+        expect(period.include?('24.12.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?('25.12.2015')).to be_falsey
+      end
+    end
+
+    context "period included" do
+      it "returns true" do
+        expect(period.include?(Period.new('25.06.2015', '24.12.2015'))).to be_truthy
+        expect(period.include?(Period.new('26.06.2015', '24.12.2015'))).to be_truthy
+        expect(period.include?(Period.new('25.06.2015', '23.12.2015'))).to be_truthy
+      end
+    end
+
+    context "period not included" do
+      it "returns false" do
+        expect(period.include?(Period.new('24.06.2015', '24.12.2015'))).to be_falsey
+        expect(period.include?(Period.new('25.06.2015', '25.12.2015'))).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/january_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require "january"
+
+# TODO/05.03.15/04:15/tb Experimental
+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')
+      expect(described_class.of(2015)).to eq Month.for('01.01.2015')
+    end
+  end
+
+  describe "#next" do
+    it "returns next month" do
+      expect(described_class.of(2014).next).to eq described_class.of(2015)
+      expect(described_class.of(2015).next).to eq described_class.of(2016)
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous month" do
+      expect(described_class.of(2014).previous).to eq described_class.of(2013)
+      expect(described_class.of(2015).previous).to eq described_class.of(2014)
+    end
+  end
+
+  describe "#month" do
+    it "returns month number" do
+      expect(described_class.of(2015).month).to eq  1
+    end
+  end
+
+  describe "#year" do
+    it "returns year number" do
+      expect(described_class.of(2015).year).to eq 2015
+      expect(described_class.of(2014).year).to eq 2014
+    end
+  end
+end

data/spec/lib/month_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe Month do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns month of given date included" do
+      month = described_class.for('25.06.2015')
+
+      expect(month.start_date).to eq date('01.06.2015')
+      expect(month.end_date).to eq date('30.06.2015')
+    end
+  end
+
+  describe "#next" do
+    it "returns next month" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('01.07.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.08.2015')
+      expect(described_class.for('01.12.2015').next).to eq described_class.for('01.01.2016')
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous month" do
+      expect(described_class.for('01.06.2015').previous).to eq described_class.for('01.05.2015')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.06.2015')
+      expect(described_class.for('01.01.2016').previous).to eq described_class.for('01.12.2015')
+    end
+  end
+
+  describe "#month" do
+    it "returns month number" do
+      expect(described_class.for('01.01.2015').month).to eq  1
+      expect(described_class.for('01.06.2015').month).to eq  6
+      expect(described_class.for('01.12.2015').month).to eq 12
+    end
+  end
+
+  describe "#number" do
+    it "returns month number" do
+      expect(described_class.for('01.01.2015').number).to eq  1
+      expect(described_class.for('01.06.2015').number).to eq  6
+      expect(described_class.for('01.12.2015').number).to eq 12
+    end
+  end
+
+  describe "#year" do
+    it "returns year number" do
+      expect(described_class.for('01.01.2015').year).to eq 2015
+      expect(described_class.for('01.12.2015').year).to eq 2015
+      expect(described_class.for('01.01.2014').year).to eq 2014
+    end
+  end
+end

data/spec/lib/monthly_period_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe MonthlyPeriod do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns month of given date included" do
+      month = described_class.for('25.06.2015')
+
+      expect(month.start_date).to eq date('25.06.2015')
+      expect(month.end_date).to eq date('24.07.2015')
+    end
+  end
+
+  describe "#next" do
+    it "returns next month" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('25.07.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.08.2015')
+      expect(described_class.for('03.12.2015').next).to eq described_class.for('03.01.2016')
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous month" do
+      expect(described_class.for('25.06.2015').previous).to eq described_class.for('25.05.2015')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.06.2015')
+      expect(described_class.for('03.01.2016').previous).to eq described_class.for('03.12.2015')
+    end
+  end
+
+end

data/spec/lib/period_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe Period do
+
+  def new_period(start_date, end_date)
+    described_class.new(start_date, end_date)
+  end
+
+  describe "==" do
+    context "same period given" do
+      it "returns true" do
+        expect(new_period("01.02.2015", "28.02.2015") == new_period("01.02.2015", "28.02.2015")).to be_truthy
+      end
+    end
+
+    context "not same period given" do
+      it "returns false" do
+        expect(new_period("01.02.2015", "28.02.2015") == new_period("02.02.2015", "28.02.2015")).to be_falsey
+        expect(new_period("01.02.2015", "28.02.2015") == new_period("01.02.2015", "27.02.2015")).to be_falsey
+        expect(new_period("01.02.2015", "28.02.2015") == new_period("01.03.2015", "31.03.2015")).to be_falsey
+      end
+    end
+  end
+
+  describe "comparing" do
+    it "compare correctly" do
+      expect(new_period("01.02.2015", "28.02.2015") >= new_period("01.02.2015", "28.02.2015")).to be_truthy
+      expect(new_period("01.02.2015", "28.02.2015") >  new_period("01.01.2015", "31.01.2015")).to be_truthy
+      expect(new_period("01.02.2015", "28.02.2015") <= new_period("01.02.2015", "28.02.2015")).to be_truthy
+      expect(new_period("01.02.2015", "28.02.2015") <  new_period("01.03.2015", "31.03.2015")).to be_truthy
+    end
+  end
+
+  describe "#next" do
+    it "returns next period" do
+      expect(new_period("25.06.2015", "19.08.2015").next).to eq new_period("20.08.2015", "14.10.2015")
+      expect(new_period("03.12.2015", "07.12.2015").next).to eq new_period("08.12.2015", "12.12.2015")
+    end
+  end
+
+  describe "#previous" do
+    it "returns previous period" do
+      expect(new_period("25.06.2015", "19.08.2015").previous).to eq new_period("30.04.2015", "24.06.2015")
+      expect(new_period("03.12.2015", "07.12.2015").previous).to eq new_period("28.11.2015", "02.12.2015")
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(new_period("25.06.2015", "19.08.2015").days).to eq 56
+      expect(new_period("20.08.2015", "14.10.2015").days).to eq 56
+      expect(new_period("01.02.2015", "28.02.2015").days).to eq 28
+      expect(new_period("06.02.2015", "30.04.2015").days).to eq 84
+    end
+  end
+
+  describe "#include?" do
+    context "date included" do
+      it "returns true" do
+        expect(new_period("01.02.2015", "28.02.2015").include?("01.02.2015")).to be_truthy
+        expect(new_period("01.02.2015", "28.02.2015").include?("28.02.2015")).to be_truthy
+      end
+    end
+
+    context "date not included" do
+      it "returns false" do
+        expect(new_period("01.02.2015", "28.02.2015").include?("31.01.2015")).to be_falsey
+        expect(new_period("01.02.2015", "28.02.2015").include?("01.03.2015")).to be_falsey
+      end
+    end
+  end
+end
+
+

data/spec/lib/periods/date_calculator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'periods/date_calculator'
+
+module Periods
+  describe DateCalculator do
+
+    describe "#beginning_of_month" do
+      it "returns given date with first day of month" do
+        expect(described_class.new('01.06.2015').beginning_of_month).to eq date('01.06.2015')
+        expect(described_class.new('02.06.2015').beginning_of_month).to eq date('01.06.2015')
+        expect(described_class.new('30.06.2015').beginning_of_month).to eq date('01.06.2015')
+      end
+    end
+
+    describe "#end_of_month" do
+      it "returns given date with last day of month" do
+        expect(described_class.new('01.06.2015').end_of_month).to eq date('30.06.2015')
+        expect(described_class.new('02.06.2015').end_of_month).to eq date('30.06.2015')
+        expect(described_class.new('30.06.2015').end_of_month).to eq date('30.06.2015')
+      end
+    end
+  end
+end
+