periods 0.0.1

data/spec/lib/quarter_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe Quarter do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns quarter of given date included" do
+      period = described_class.for('25.06.2015')
+
+      expect(period.start_date).to eq date('01.06.2015')
+      expect(period.end_date).to eq date('31.08.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.09.2015')
+      expect(described_class.for('01.06.2015').next).to eq described_class.for('01.09.2015')
+      expect(described_class.for('03.12.2015').next).to eq described_class.for('03.03.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.03.2015')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.04.2015')
+      expect(described_class.for('03.01.2016').previous).to eq described_class.for('03.10.2015')
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(described_class.for("25.06.2015").days).to eq 92
+      expect(described_class.for("01.01.2015").days).to eq 90
+      expect(described_class.for("01.01.2016").days).to eq 91
+    end
+  end
+
+  describe "#include?" do
+    let(:period) { described_class.for('01.06.2015') }
+
+    context "date included" do
+      it "returns true" do
+        expect(period.include?('25.06.2015')).to be_truthy
+        expect(period.include?('26.06.2015')).to be_truthy
+        expect(period.include?('01.07.2015')).to be_truthy
+        expect(period.include?('30.08.2015')).to be_truthy
+        expect(period.include?('31.08.2015')).to be_truthy
+      end
+    end
+
+    context "date not included" do
+      it "returns false" do
+        expect(period.include?('31.05.2015')).to be_falsey
+        expect(period.include?('01.09.2015')).to be_falsey
+      end
+    end
+
+    context "month included" do
+      it "returns true" do
+        expect(period.include?(Month.for('01.06.2015'))).to be_truthy
+        expect(period.include?(Month.for('01.07.2015'))).to be_truthy
+        expect(period.include?(Month.for('01.08.2015'))).to be_truthy
+      end
+    end
+
+    context "month not included" do
+      it "returns false" do
+        expect(period.include?(Month.for('01.05.2015'))).to be_falsey
+        expect(period.include?(Month.for('01.09.2015'))).to be_falsey
+      end
+    end
+
+    context "period included" do
+      it "returns true" do
+        expect(period.include?(Period.new('01.06.2015', '31.08.2015'))).to be_truthy
+        expect(period.include?(Period.new('02.06.2015', '31.08.2015'))).to be_truthy
+        expect(period.include?(Period.new('01.06.2015', '30.08.2015'))).to be_truthy
+        expect(period.include?(Period.new('02.06.2015', '30.08.2015'))).to be_truthy
+      end
+    end
+
+    context "period not included" do
+      it "returns false" do
+        expect(period.include?(Period.new('31.05.2015', '31.08.2015'))).to be_falsey
+        expect(period.include?(Period.new('01.06.2015', '01.09.2015'))).to be_falsey
+      end
+    end
+  end
+
+  describe "#months" do
+    it "returns months of quarter" 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')]
+      expect(described_class.for('01.12.2015').months).
+          to eq [Month.for('01.12.2015'), Month.for('01.01.2016'), Month.for('01.02.2016')]
+    end
+  end
+
+  describe "#start_year" do
+    it "returns start year of quarter" do
+      expect(described_class.for('01.06.2015').start_year).to eq 2015
+      expect(described_class.for('01.06.2016').start_year).to eq 2016
+    end
+  end
+
+  describe "#end_year" do
+    it "returns end year of quarter" do
+      expect(described_class.for('01.06.2015').end_year).to eq 2015
+      expect(described_class.for('01.12.2015').end_year).to eq 2016
+    end
+  end
+end

data/spec/lib/quarterly_period_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe QuarterlyPeriod do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns quarter 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.09.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.09.2015')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.10.2015')
+      expect(described_class.for('03.12.2015').next).to eq described_class.for('03.03.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.03.2015')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.04.2015')
+      expect(described_class.for('03.01.2016').previous).to eq described_class.for('03.10.2015')
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(described_class.for("25.06.2015").days).to eq 92
+      expect(described_class.for("01.01.2015").days).to eq 90
+      expect(described_class.for("01.01.2016").days).to eq 91
+    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?('26.06.2015')).to be_truthy
+        expect(period.include?('01.07.2015')).to be_truthy
+        expect(period.include?('01.08.2015')).to be_truthy
+        expect(period.include?('24.09.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.09.2015')).to be_falsey
+      end
+    end
+
+    context "period included" do
+      it "returns true" do
+        expect(period.include?(Period.new('25.06.2015', '24.09.2015'))).to be_truthy
+        expect(period.include?(Period.new('26.06.2015', '23.09.2015'))).to be_truthy
+        expect(period.include?(Period.new('02.08.2015', '20.08.2015'))).to be_truthy
+        expect(period.include?(Period.new('23.09.2015', '24.09.2015'))).to be_truthy
+      end
+    end
+
+    context "period not included" do
+      it "returns false" do
+        expect(period.include?(Period.new('24.06.2015', '24.09.2015'))).to be_falsey
+        expect(period.include?(Period.new('25.06.2015', '25.09.2015'))).to be_falsey
+        expect(period.include?(Period.new('24.06.2015', '25.09.2015'))).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/year_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe Year 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('31.05.2016')
+    end
+  end
+
+  describe "#next" do
+    it "returns next month" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('01.06.2016')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.07.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.06.2014')
+      expect(described_class.for('01.06.2015').previous).to eq described_class.for('01.06.2014')
+    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
+
+  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'),
+                  Month.for('01.12.2015'), Month.for('01.01.2016'), Month.for('01.02.2016'),
+                  Month.for('01.03.2016'), Month.for('01.04.2016'), Month.for('01.05.2016')
+                ]
+    end
+  end
+end

data/spec/lib/yearly_period_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'periods/constants'
+
+describe YearlyPeriod do
+
+  let(:subject) { described_class.for("1.1.2015") }
+
+  it_behaves_like "Lint Check"
+
+  describe ".for" do
+    it "returns year 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.06.2016')
+    end
+  end
+
+  describe "#next" do
+    it "returns next quarter" do
+      expect(described_class.for('25.06.2015').next).to eq described_class.for('25.06.2016')
+      expect(described_class.for('01.07.2015').next).to eq described_class.for('01.07.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.06.2014')
+      expect(described_class.for('01.07.2015').previous).to eq described_class.for('01.07.2014')
+    end
+  end
+
+  describe "#days" do
+    it "returns days of period" do
+      expect(described_class.for("01.01.2015").days).to eq 365
+      expect(described_class.for("25.06.2015").days).to eq 366
+      expect(described_class.for("01.01.2016").days).to eq 366
+      expect(described_class.for("01.03.2016").days).to eq 365
+    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.06.2016')).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.06.2016')).to be_falsey
+      end
+    end
+
+    context "period included" do
+      it "returns true" do
+        expect(period.include?(Period.new('25.06.2015', '24.06.2016'))).to be_truthy
+        expect(period.include?(Period.new('26.06.2015', '24.06.2016'))).to be_truthy
+        expect(period.include?(Period.new('25.06.2015', '23.06.2015'))).to be_truthy
+      end
+    end
+
+    context "period not included" do
+      it "returns false" do
+        expect(period.include?(Period.new('24.06.2015', '24.06.2016'))).to be_falsey
+        expect(period.include?(Period.new('25.06.2015', '25.06.2016'))).to be_falsey
+      end
+    end
+  end
+end

data/spec/lint_check.rb

@@ -0,0 +1,24 @@
+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
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+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
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+def date(date)
+  Date.parse(date.to_s)
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: periods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Baustert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple period types like Week, Month, Quarter, Halfyear, Year.
+email:
+- business@thomasbaustert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/january.rb
+- lib/periods.rb
+- lib/periods/classes.rb
+- lib/periods/constants.rb
+- lib/periods/date_calculator.rb
+- lib/periods/halfyear.rb
+- lib/periods/halfyearly_period.rb
+- lib/periods/modules.rb
+- lib/periods/modules/halfyear.rb
+- lib/periods/modules/halfyearly_period.rb
+- lib/periods/modules/month.rb
+- lib/periods/modules/monthly_period.rb
+- lib/periods/modules/period.rb
+- lib/periods/modules/quarter.rb
+- lib/periods/modules/quarterly_period.rb
+- lib/periods/modules/year.rb
+- lib/periods/modules/yearly_period.rb
+- lib/periods/month.rb
+- lib/periods/monthly_period.rb
+- lib/periods/period.rb
+- lib/periods/quarter.rb
+- lib/periods/quarterly_period.rb
+- lib/periods/version.rb
+- lib/periods/year.rb
+- lib/periods/yearly_period.rb
+- periods.gemspec
+- spec/lib/halfyear_spec.rb
+- spec/lib/halfyearly_period_spec.rb
+- spec/lib/january_spec.rb
+- spec/lib/month_spec.rb
+- spec/lib/monthly_period_spec.rb
+- spec/lib/period_spec.rb
+- spec/lib/periods/date_calculator_spec.rb
+- spec/lib/quarter_spec.rb
+- 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: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Simple period types like Week, Month, Quarter, Halfyear, Year.
+test_files:
+- spec/lib/halfyear_spec.rb
+- spec/lib/halfyearly_period_spec.rb
+- spec/lib/january_spec.rb
+- spec/lib/month_spec.rb
+- spec/lib/monthly_period_spec.rb
+- spec/lib/period_spec.rb
+- spec/lib/periods/date_calculator_spec.rb
+- spec/lib/quarter_spec.rb
+- 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