datebox 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ee3f21eef1adfc455da526dbbfd037f2b17e1d9
+  data.tar.gz: 2760bf9e09bf08a526df3622eeab16f3ada22247
+SHA512:
+  metadata.gz: 3cc78e68d9eacec4962e39137bd17df8d64156e2dc888b1a99e9c8f1da20d5742cef5f5a27de94ca43798da466a623836afc38e1853cff4fed8e053d7a6b5d53
+  data.tar.gz: 15c4049a449cf389c75adf6c41d2ce17583effb1a12720dc5b6fa7caa685ca4469ad8e13302129c70749c04ee10e80d5b8ae44c5256f6a3af917f509cb1529a6

data/.gitignore

@@ -0,0 +1,2 @@
+*.db
+*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+ 
+Copyright (c) 2013 Forward3D
+ 
+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,32 @@
+# Datebox
+
+Provides help with managing dates and periods
+
+## Installation
+
+    gem install datebox
+
+## Usage
+
+Include gem in Gemfile
+
+    gem 'datebox'
+    # or
+    gem 'datebox', :git => 'git@github.com:forward3d/datebox'
+
+Allows using periods
+
+    period = Datebox::Period.new("2013-06-10", "2013-06-27")
+    period.from
+    period.to
+
+Allows splitting periods (returns ending dates of periods)
+
+    Datebox::Period.split_dates(Date.parse("2013-06-14"), Date.parse("2013-06-27"), "week")
+
+It's also possible to calculate periods relative to given dates
+
+    period_month = Datebox::Relative.new.last_month.to('2013-07-09')
+    preiod_week = Datebox::Relative.new.last_week.to('2013-07-09')
+
+It's best to have a look at code & tests

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/datebox.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datebox'
+
+Gem::Specification.new do |gem|
+  gem.name          = "datebox"
+  gem.version       = Datebox::VERSION
+  gem.authors       = ["Robert Borkowski"]
+  gem.email         = ["robert.borkowski@forward3d.com"]
+  gem.description   = %q{Offers help with managing dates and periods}
+  gem.summary       = %q{Got fed up with implementing date related functionality everywhere}
+  gem.homepage      = "https://github.com/forward3d/datebox"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = [] #gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = [] #gem.files.grep(%r{^(test|spec|features)/})
+  # gem.test_files    = `git grep test`.split(/\n/).map {|f| File.basename(f.split(':').first)}
+  gem.require_paths = ["lib"]
+
+  gem.license = 'MIT'
+
+end

data/lib/datebox.rb

@@ -0,0 +1,7 @@
+require 'date'
+require_relative 'datebox/period'
+require_relative 'datebox/relative'
+require_relative 'datebox/version'
+
+module Datebox
+end

data/lib/datebox/period.rb

@@ -0,0 +1,55 @@
+module Datebox
+  class Period
+    attr_reader :from, :to
+    
+    def initialize(from, to)
+      @from = from.is_a?(Date) ? from : Date.parse(from)
+      @to = to.is_a?(Date) ? to : Date.parse(to)
+      raise "FROM date should not be later than TO date" if @to < @from
+    end
+    
+    def dates
+      (@from..@to).to_a
+    end
+    
+    def ==(other)
+      @from == other.from && @to == other.to
+    end
+    
+    def split_dates(period, options = {})
+      self.class.split_dates(from, to, period, options)
+    end
+
+    class << self
+      def split_dates(start_date, end_date, period, options = {})
+        return (start_date..end_date).to_a if period == "day"
+        return split_weekly_dates(start_date, end_date, options) if period == "week"
+        return split_monthly_dates(start_date, end_date) if period == "month"
+      end
+
+      def split_weekly_dates(start_date, end_date, options = {})
+        last_weekday = options[:last_weekday] || "Sunday"
+        end_dates = []
+        end_of_week = (end_date.downto end_date - 6).to_a.find { |d| d.strftime("%A") == last_weekday }
+        while end_of_week - 6 >= start_date
+          end_dates << end_of_week
+          end_of_week -= 7
+        end
+        end_dates.sort
+      end
+
+      def split_monthly_dates(start_date, end_date)
+        end_dates = []
+        beginning_of_month = ::Date.parse("#{end_date.year}-#{end_date.month}-01").next_month
+        end_of_month = (beginning_of_month - 1 == end_date) ? end_date : beginning_of_month.prev_month - 1
+        while beginning_of_month.prev_month >= start_date
+          end_dates << end_of_month
+          beginning_of_month = ::Date.parse("#{end_of_month.year}-#{end_of_month.month}-01")
+          end_of_month =  beginning_of_month - 1
+        end
+        end_dates.sort
+      end
+    end
+
+  end
+end

data/lib/datebox/relative.rb

@@ -0,0 +1,79 @@
+module Datebox
+  class Relative
+
+      @period = nil
+      @period_proc = nil
+
+      def to(relative_to)
+        relative_to = (relative_to.is_a?(Date) ? relative_to : Date.parse(relative_to))
+        @period_proc.call relative_to
+      end
+
+      def same_day
+        @period_proc = Proc.new {|relative_to| Period.new(relative_to, relative_to) }
+        self
+      end
+
+      def last_week(last_weekday = "Sunday")
+        @period_proc = Proc.new do |relative_to|
+          end_date = (relative_to.downto relative_to - 6).to_a.find { |d| d.strftime("%A") == last_weekday }
+          Period.new(end_date - 6, end_date)
+        end
+        self
+      end
+
+      def last_weekdays_between(start_day, end_day)
+        @period_proc = Proc.new do |relative_to|
+          end_date = (relative_to.downto relative_to - 6).to_a.find { |d| d.strftime("%A") == end_day }
+          start_date = (end_date - 7 .. end_date).to_a.find { |d| d.strftime("%A") == start_day }
+          Period.new(start_date, end_date)
+        end
+        self
+      end
+
+      def last_weeks_weekdays_as!(*days) #this one returns array!
+        @period_proc = Proc.new do |relative_to|
+          days.map do |p|
+            (relative_to.downto relative_to - 6).to_a.find { |d| d.strftime("%A") == p }
+          end
+        end
+        self
+      end
+
+      def last_month
+        @period_proc = Proc.new do |relative_to| 
+          previous_month_start = Date.parse("#{relative_to.prev_month.strftime('%Y-%m')}-01")
+          previous_month_end = previous_month_start.next_month - 1
+          Period.new(previous_month_start, previous_month_end)
+        end
+        self
+      end
+
+      def month_to_date
+        @period_proc = Proc.new do |relative_to|
+          month_start = Date.parse("#{relative_to.strftime('%Y-%m')}-01")
+          Period.new(month_start, relative_to)
+        end
+        self
+      end
+
+      def last_year
+        @period_proc = Proc.new do |relative_to|
+          previous_year_start = Date.parse("#{relative_to.prev_year.year}-01-01")
+          previous_year_end = previous_year_start.next_year - 1
+          Period.new(previous_year_start, previous_year_end)
+        end
+        self
+      end
+
+      def year_to_date
+        @period_proc = Proc.new do |relative_to|
+          year_start = Date.parse("#{relative_to.year}-01-01")
+          Period.new(year_start, relative_to)
+        end
+        self
+      end
+
+  end
+  
+end

data/lib/datebox/version.rb

@@ -0,0 +1,3 @@
+module Datebox
+  VERSION = "0.0.2"
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+
+root = File.join(File.dirname(File.expand_path(__FILE__)), '..')
+require "#{root}/lib/datebox"
+

data/test/unit/test_period.rb

@@ -0,0 +1,23 @@
+require '../test_helper'
+
+class TestPeriod < Test::Unit::TestCase
+  
+  def test_splits_periods_correctly
+    #day
+    assert_equal [Date.today - 1], Datebox::Period.split_dates(Date.today - 1, Date.today - 1, "day")
+    assert_equal [Date.today - 3, Date.today - 2, Date.today - 1], Datebox::Period.split_dates(Date.today - 3, Date.today - 1, "day")
+    #week
+    assert_equal [], Datebox::Period.split_dates(Date.parse("2013-06-15"), Date.parse("2013-06-22"), "week") #sat to sat
+    assert_equal [Date.parse("2013-06-23")], Datebox::Period.split_dates(Date.parse("2013-06-14"), Date.parse("2013-06-27"), "week") #fri to thu
+    assert_equal [Date.parse("2013-06-23")], Datebox::Period.split_dates(Date.parse("2013-06-17"), Date.parse("2013-06-23"), "week") #mon to sun
+    assert_equal [Date.parse("2013-06-16"), Date.parse("2013-06-23")], Datebox::Period.split_dates(Date.parse("2013-06-10"), Date.parse("2013-06-27"), "week") #mon to thu
+    #month
+    assert_equal [], Datebox::Period.split_dates(Date.parse("2013-01-02"), Date.parse("2013-01-31"), "month")
+    assert_equal [Date.parse("2013-01-31")], Datebox::Period.split_dates(Date.parse("2013-01-01"), Date.parse("2013-01-31"), "month")
+    assert_equal [Date.parse("2013-01-31")], Datebox::Period.split_dates(Date.parse("2012-12-02"), Date.parse("2013-02-02"), "month")
+    assert_equal [Date.parse("2013-01-31"), Date.parse("2013-02-28")], Datebox::Period.split_dates(Date.parse("2012-12-10"), Date.parse("2013-03-03"), "month")
+    #instance method test
+    assert_equal [Date.parse("2013-06-16"), Date.parse("2013-06-23")], Datebox::Period.new("2013-06-10", "2013-06-27").split_dates("week") #mon to thu
+  end
+
+end

data/test/unit/test_relative.rb

@@ -0,0 +1,23 @@
+require '../test_helper'
+
+class TestRelative < Test::Unit::TestCase
+  
+  def test_calculates_correctly
+    # day
+    assert_equal [Date.parse('2013-07-07')], Datebox::Relative.new.same_day.to('2013-07-07').dates
+    # week
+    assert_equal Datebox::Period.new('2013-07-01', '2013-07-07'), Datebox::Relative.new.last_week.to('2013-07-09') #tue
+    assert_equal Datebox::Period.new('2013-07-01', '2013-07-05'), Datebox::Relative.new.last_weekdays_between("Monday", "Friday").to('2013-07-09') #tue
+    assert_equal Datebox::Period.new('2013-07-08', '2013-07-09'), Datebox::Relative.new.last_weekdays_between("Monday", "Tuesday").to('2013-07-09') #tue
+    # month
+    assert_equal Datebox::Period.new('2013-06-01', '2013-06-30'), Datebox::Relative.new.last_month.to('2013-07-09')
+    assert_equal Datebox::Period.new('2013-07-01', '2013-07-09'), Datebox::Relative.new.month_to_date.to('2013-07-09')
+    # year
+    assert_equal Datebox::Period.new('2012-01-01', '2012-12-31'), Datebox::Relative.new.last_year.to('2013-07-09')
+    assert_equal Datebox::Period.new('2013-01-01', '2013-07-09'), Datebox::Relative.new.year_to_date.to('2013-07-09')
+
+    # the one that's different
+    assert_equal [Date.parse('2013-07-01'), Date.parse('2013-07-03')], Datebox::Relative.new.last_weeks_weekdays_as!("Monday", "Wednesday").to('2013-07-05') #fri
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: datebox
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Robert Borkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-18 00:00:00.000000000 Z
+dependencies: []
+description: Offers help with managing dates and periods
+email:
+- robert.borkowski@forward3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- datebox.gemspec
+- lib/datebox.rb
+- lib/datebox/period.rb
+- lib/datebox/relative.rb
+- lib/datebox/version.rb
+- test/test_helper.rb
+- test/unit/test_period.rb
+- test/unit/test_relative.rb
+homepage: https://github.com/forward3d/datebox
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Got fed up with implementing date related functionality everywhere
+test_files: []