periods 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e1b123692dc2c370b9fafe99dfd7c41e053c9c3
+  data.tar.gz: 23bde0ce3ee468d44228b68967806cdf2aca1b8a
+SHA512:
+  metadata.gz: 01589f77ac31bfca9346442bcbeb81fb5c33af6e1fb9821e4de186ee56df645bd1c785ab820423e71bc42efadffc212578b14d8c737943c2e80301f668d3178b
+  data.tar.gz: 681447a4ab6ae3253593a05698b44a07804f3e000eebdda77adaeeec49909814d880500f113e2e319d22b6fedc1bf1327510a18789fe743fb01f6bf5e1de2b0c

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea
+/coverage*
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9"
+  - "2.1"
+  - "2.2"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in periods.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Thomas Baustert
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+[![Build Status](https://travis-ci.org/thomasbaustert/periods.svg?branch=master)](https://travis-ci.org/thomasbaustert/periods)
+
+# Periods
+
+**This is work in progress, no gem released!**
+
+This gem provides period types like 
+
+  * Period, 
+  * WeeklyPeriod, Week, 
+  * MonthlyPeriod, Month, 
+  * QuarterlyPeriod, Quarter,
+  * HalfyearlyPeriod, Halfyear,
+  * YearlyPeriod, Year.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'periods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install periods
+
+## Usage
+
+Require `periods` in your app:
+
+    require 'periods'
+
+### Period
+
+A period is defined by a start and end date:
+
+    period = Period.for(Date.new(2015,6,25), Date.new(2015,8,19))
+    period.days      # => 56
+    period.next      # => 20.08.2015 - 14.10.2015
+    period.next.days # => 56
+
+The start and end date can be a string too:
+
+    period = Period.for('25.06.2015', '19.08.2015')
+
+All period models respond to the following interface:
+
+    * next
+    * previous
+    * days
+    * include?
+    * comparing (==, >=, >, <=, <)
+    * ...
+
+Special period models may define additional methods (see below).
+
+### MonthlyPeriod
+
+If you need a constant monthly range use `MonthlyPeriod`:
+
+    monthly = MonthPeriod.for('01.01.2015') # => 01.01.2015 - 31.01.2015
+    monthly.next # => 01.02.2015 - 28.02.2015
+
+    monthly = MonthPeriod.for('25.06.2015') # => 25.06.2015 - 24.07.2015
+    monthly.next        # => 25.07.2015 - 24.08.2015
+    monthly.start_date  # Date(25.06.2015)
+    monthly.end_date    # Date(24.07.2015)
+    
+### Month
+
+If you need a calendar month starting at first day of month and ending at last day of month use `Month`:
+
+    january = Month.for('01.01.2015') # => 01.01.2015 - 31.01.2015
+    january.next # => 01.02.2015 - 28.02.2015
+
+    june = MonthPeriod.for('25.06.2015') # => 01.06.2015 - 30.06.2015
+    june.next   # => 01.07.2015 - 31.07.2015
+    june.month  # => 6
+    june.year   # => 2015
+
+### QuarterlyPeriod
+
+### Quarter
+
+### HalfyearlyPeriod
+
+### Halfyear
+
+### Yearly
+
+### Year
+
+### If constants already exist
+
+In case constants like `Month` already exist in your code stop requiring `periods` in your `Gemfile`:
+
+    gem 'periods', require: false
+
+Require the namespaced classes only:
+
+    require 'periods/classes'
+
+Use them like so:
+
+    month = Periods::Month.for('01.08.2015')
+
+Alternatively require the modules only:
+
+    require 'periods/modules'
+
+Write your own classes:
+
+    class MyMonth
+      include Periods::Modules::Month
+    end
+    month = MyMonth.for('01.08.2015')
+    ...
+
+## TODO
+
+* Implement Week
+* Use Time not Date
+* Comment Code
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# running spec as rake default tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'bundler/gem_tasks'

data/lib/january.rb

@@ -0,0 +1,22 @@
+class January < Month
+
+  def self.of(year)
+    January.for("1.1.#{year}")
+  end
+
+  def next
+    January.for("1.1.#{year.to_i + 1}")
+  end
+
+  def previous
+    January.for("1.1.#{year.to_i - 1}")
+  end
+
+  def month
+    1
+  end
+
+  def year
+    start_date.year
+  end
+end

data/lib/periods/classes.rb

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

data/lib/periods/constants.rb

@@ -0,0 +1,16 @@
+require 'periods/classes'
+
+Period = Periods::Period
+
+Month = Periods::Month
+MonthlyPeriod = Periods::MonthlyPeriod
+
+Quarter = Periods::Quarter
+QuarterlyPeriod = Periods::QuarterlyPeriod
+
+Halfyear = Periods::Halfyear
+HalfyearlyPeriod = Periods::HalfyearlyPeriod
+
+Year = Periods::Year
+YearlyPeriod = Periods::YearlyPeriod
+

data/lib/periods/date_calculator.rb

@@ -0,0 +1,25 @@
+module Periods
+  class DateCalculator
+
+    def initialize(date)
+      @date = to_date(date)
+    end
+
+    def beginning_of_month
+      _, m, y = split
+      to_date("#{1}.#{m}.#{y}")
+    end
+
+    def end_of_month
+      self.class.new(@date.next_month).beginning_of_month.prev_day
+    end
+
+    def split
+      @date.strftime('%d.%m.%Y').split('.')
+    end
+
+    def to_date(str)
+      ::Date.parse(str.to_s)
+    end
+  end
+end

data/lib/periods/halfyear.rb

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

data/lib/periods/halfyearly_period.rb

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

data/lib/periods/modules/halfyear.rb

@@ -0,0 +1,52 @@
+require 'periods/halfyearly_period'
+
+module Periods
+  module Modules
+    module Halfyear
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::HalfyearlyPeriod
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        ##
+        # '25.06.2015' => 01.06.2015 - '30.11.2015'
+        #
+        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_month(6).prev_day))
+        end
+
+        def months
+          months = [Periods::Month.for(start_date)]
+          1.upto(5) 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/halfyearly_period.rb

@@ -0,0 +1,52 @@
+require 'periods/modules/period'
+
+module Periods
+  module Modules
+    module HalfyearlyPeriod
+
+      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.12.2015'
+        #
+        def for(date)
+          date = Date.parse(date.to_s)
+          new(date, date.next_month(6).prev_day)
+        end
+      end
+
+      module InstanceMethods
+        def next
+          self.class.for(start_date.next_month(6))
+        end
+
+        def previous
+          self.class.for(start_date.prev_month(6))
+        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/month.rb

@@ -0,0 +1,61 @@
+require 'periods/date_calculator'
+require 'periods/modules/monthly_period'
+
+module Periods
+  module Modules
+    module Month
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::MonthlyPeriod
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def for(date)
+          new(date)
+        end
+      end
+
+      module InstanceMethods
+
+        def initialize(date)
+          date = Date.parse(date.to_s)
+          @start_date = beginning_of_month(date)
+          @end_date   = end_of_month(date)
+        end
+
+        def month
+          start_date.month
+        end
+
+        alias_method :number, :month
+
+        def year
+          start_date.year
+        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
+            "#{start_date.strftime("%m.%Y")}"
+          end
+        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/monthly_period.rb

@@ -0,0 +1,43 @@
+require 'periods/modules/period'
+
+module Periods
+  module Modules
+    module MonthlyPeriod
+
+      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.07.2015'
+        #
+        def for(date)
+          date = Date.parse(date.to_s)
+          new(date, date.next_month.prev_day)
+        end
+      end
+
+      module InstanceMethods
+        ##
+        # 25.06.2015 => 25.07.2015
+        #
+        def next
+          self.class.for(start_date.next_month)
+        end
+
+        ##
+        # 25.06.2015 => 25.05.2015
+        #
+        def previous
+          self.class.for(start_date.prev_month)
+        end
+
+      end
+    end
+  end
+end

data/lib/periods/modules/period.rb

@@ -0,0 +1,58 @@
+module Periods
+  module Modules
+    module Period
+
+      def self.included(base)
+        base.class_eval do
+          include Comparable
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        attr_reader :start_date, :end_date
+
+        def initialize(start_date, end_date)
+          @start_date = Date.parse(start_date.to_s)
+          @end_date = Date.parse(end_date.to_s)
+        end
+
+        def ==(period)
+          start_date == period.start_date && end_date == period.end_date
+        end
+
+        def <=>(period)
+          if start_date > period.start_date
+            1
+          elsif start_date < period.start_date
+            -1
+          else
+            0
+          end
+        end
+
+        def next
+          self.class.new(start_date + days, end_date + days)
+        end
+
+        def previous
+          self.class.new(start_date - days, end_date - days)
+        end
+
+        def days
+          end_date.yday - start_date.yday + 1
+        end
+
+        def include?(date)
+          date = Date.parse(date.to_s)
+          start_date <= date && date <= end_date
+        end
+
+        def to_s
+          "#{start_date.strftime("%d.%m.%Y")} - #{end_date.strftime("%d.%m.%Y")}"
+        end
+
+      end
+    end
+  end
+end

data/lib/periods/modules/quarter.rb

@@ -0,0 +1,59 @@
+require 'periods/date_calculator'
+require 'periods/modules/quarterly_period'
+require 'periods/month'
+
+module Periods
+  module Modules
+    module Quarter
+
+      def self.included(base)
+        base.class_eval do
+          include Periods::Modules::Period
+          include Periods::Modules::QuarterlyPeriod
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def for(date)
+          new(date)
+        end
+      end
+
+      module InstanceMethods
+
+        def initialize(date)
+          date = Date.parse(date.to_s)
+          @start_date = beginning_of_month(date)
+          @end_date   = end_of_month(@start_date.next_month(2))
+        end
+
+        def months
+          [ Periods::Month.for(start_date),
+            Periods::Month.for(start_date.next_month),
+            Periods::Month.for(start_date.next_month(2)) ]
+        end
+
+        def start_year
+          start_date.year
+        end
+
+        def end_year
+          end_date.year
+        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/quarterly_period.rb

@@ -0,0 +1,55 @@
+require 'periods/date_calculator'
+require 'periods/modules/period'
+
+module Periods
+  module Modules
+    module QuarterlyPeriod
+
+      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.07.2015'
+        #
+        def for(date)
+          date = Date.parse(date.to_s)
+          new(date, date.next_month(3).prev_day)
+        end
+      end
+
+      module InstanceMethods
+        ##
+        # 25.06.2015 => 25.07.2015
+        #
+        def next
+          self.class.for(start_date.next_month(3))
+        end
+
+        ##
+        # 25.06.2015 => 25.05.2015
+        #
+        def previous
+          self.class.for(start_date.prev_month(3))
+        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
+