date_range_covers 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.8.7" > .rvmrc
+environment_id="ruby-1.8.7-p370@date_range_covers"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.20 (latest)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Antall Fernandes
+
+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,29 @@
+# DateRangeCovers
+
+Library to return months/weeks/days covered by a date range
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'date_range_covers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_range_covers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/date_range_covers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_range_covers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_range_covers"
+  spec.version       = DateRangeCovers::VERSION
+  spec.authors       = ["Antall Fernandes"]
+  spec.email         = ["antallfernandes@gmail.com"]
+  spec.description   = %q{The gem helps find the years, months, weeks and days covered by a date range}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails", "~> 2.3"
+end

data/lib/a_date.rb

@@ -0,0 +1,26 @@
+module ADate
+
+  @@DAYS_OF_WEEK = [
+    :sunday, 
+    :monday,
+    :tuesday,
+    :wednesday,
+    :thursday,
+    :friday,
+    :saturday
+  ]
+
+  def self.beginning_of_week(date, beginning_of_week_day = :sunday)
+    beginning_of_week_adj = @@DAYS_OF_WEEK.index beginning_of_week_day
+   
+    current_day_number = 0
+    current_day_number = date.wday if date.wday != 0
+    current_day_number = 7 if date.wday == 0 and beginning_of_week_adj == 1
+    
+    date = date - current_day_number + beginning_of_week_adj
+  end
+
+  def self.end_of_week(date, beginning_of_week_day = :sunday)
+    beginning_of_week(date, beginning_of_week_day) + 6
+  end
+end

data/lib/date_range_covers/version.rb

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

data/lib/date_range_covers.rb

@@ -0,0 +1,274 @@
+require "date_range_covers/version"
+require 'date'
+require 'active_support'
+require 'a_date'
+
+module DateRangeCovers
+  class DateRange
+    attr_reader :start_date, :end_date
+    attr_reader :beginning_of_week_day
+    attr_reader :covs
+
+   def initialize(start_date, end_date, bow_day = :monday)
+      @start_date = start_date
+      @end_date = end_date
+      @beginning_of_week_day = bow_day
+      @covs = {}
+    end
+  
+    # Is the date range created, a single date range
+    #
+    # @example
+    #   boolean = DateRangeCovers::DateRange.is_single_date_range?
+    #
+    # @return boolean
+    #   true: when start date and end date are the same
+    #   false: when start date and end date are different or either date is nil
+    #
+    # @api public 
+    def is_single_date_range?
+      (start_date and end_date and start_date == end_date) ? true : false
+    end
+
+    # Is the date range created an actual date range
+    #
+    # @example
+    #   boolean = DateRangeCovers::DateRange.is_date_range?
+    #
+    # @return boolean
+    #   true: when start date and end date are different
+    #   false: when start date and end date are the same or either date is nil
+    #
+    # @api public 
+    def is_date_range?
+      (start_date and end_date and !is_single_date_range?) ? true : false
+    end
+
+    # months_covered
+    #
+    # @example
+    #   months = DateRangeCovers::DateRange.months_covered(options)
+    #
+    # @options
+    #   :include 
+    #     => :start_month - include the month containing the start date
+    #     => :end_month - include the month containing the end date
+    #     => :both - include months containing start date and end date respectively
+    #
+    # @return [starting date of months]
+    #
+    # @api public 
+    def months_covered(options={})
+      s_date = start_date.dup
+      e_date = end_date.dup
+      
+      months = []
+
+      unless options.empty?
+        case options[:include]
+        when :both
+          months << s_date.beginning_of_month
+          months << e_date.beginning_of_month
+        when :start_month
+          months << s_date.beginning_of_month
+        when :end_month 
+          months << e_date.beginning_of_month
+        end
+      end
+
+      #We need to iterate through every month and 
+      #see if the month is wholly contained in the 
+      #date range
+      bottom_of_month = s_date.beginning_of_month
+      top_of_month = s_date.end_of_month 
+
+      while bottom_of_month < e_date do
+        if (s_date..e_date).include?(bottom_of_month..top_of_month) 
+          months << bottom_of_month
+        end
+        bottom_of_month = bottom_of_month.next_month
+        top_of_month = bottom_of_month.end_of_month 
+      end
+
+      covs[:months] = months.compact.uniq.sort
+    end
+
+    # Checks to see if part of a date range lies in a selected month
+    #
+    # @example
+    #   boolean = DateRangeCovers::DateRange.date_range_flows_into_selected_months(start_date_of_range, end_date_of_range)
+    #
+    # @return boolean
+    #
+    # @api private 
+    def date_range_flows_into_selected_months?(s_date, e_date)
+      if covs[:months]
+        covs[:months].each do |bottom_of_month|
+          top_of_month = bottom_of_month.end_of_month
+            
+          #first condition :the month contains the start date and not the end date
+          #second condition :the month contains the end date and not the start date
+          if ((bottom_of_month..top_of_month).include?(s_date) and !(bottom_of_month..top_of_month).include?(e_date)) \
+            or ((bottom_of_month..top_of_month).include?(e_date) and !(bottom_of_month..top_of_month).include?(s_date))
+              return true #because the range spilled over the month return true
+          end
+        end
+      end
+      false
+    end
+
+    # weeks_covered
+    #
+    # @example
+    #   weeks = DateRangeCovers::DateRange.weeks_covered(options)
+    #
+    # @options
+    #   :include
+    #     => :start_week - include the week containing the start date
+    #     => :end_week - include the week containing the end date
+    #     => :both - include weeks containing the start date and end date respectively
+    #
+    # @return [starting date of weeks]
+    #
+    # @api public 
+    def weeks_covered(options={})
+      s_date = start_date.dup
+      e_date = end_date.dup
+
+      weeks = []
+
+      unless options.empty?
+        case options[:include]
+        when :both
+          s_date = ADate.beginning_of_week(s_date, beginning_of_week_day)
+          e_date = ADate.end_of_week(e_date, beginning_of_week_day)
+
+          start_of_e_week = ADate.beginning_of_week(e_date, beginning_of_week_day)
+
+          weeks << s_date unless is_covered?(s_date)         
+          weeks << start_of_e_week unless is_covered?(start_of_e_week)         
+
+        when :start_week
+          s_date = ADate.beginning_of_week(s_date, beginning_of_week_day)
+          weeks << s_date unless is_covered?(s_date)
+
+        when :end_week 
+          e_date = ADate.end_of_week(e_date, beginning_of_week_day)
+          start_of_e_week = ADate.beginning_of_week(e_date, beginning_of_week_day)
+          
+          weeks << start_of_e_week unless is_covered?(start_of_e_week)         
+        end
+      end
+
+      #We need to iterate through every week and 
+      #see if the week is wholly contained in the 
+      #date range
+      bottom_of_week = ADate.beginning_of_week(s_date, beginning_of_week_day)
+      top_of_week = bottom_of_week + 6
+
+      while bottom_of_week < e_date do
+        if (s_date..e_date).include?(bottom_of_week..top_of_week)\
+            and !date_range_flows_into_selected_months?(bottom_of_week, top_of_week) # if part of a week already belongs to a covered month, we should not add that week to the list
+          weeks << bottom_of_week unless is_covered?(bottom_of_week)
+        end
+        bottom_of_week += 7
+        top_of_week = bottom_of_week + 6
+      end
+
+      covs[:weeks] = weeks.compact.uniq.sort
+    end
+
+    # dates_covered
+    #
+    # @example
+    #   dates = DateRangeCovers::DateRange.dates_covered(options)
+    #
+    # @options
+    #   :include
+    #     => :start_date - include the start date
+    #     => :end_date - include the end date
+    #     => :both - include the start date and end date respectively
+    #
+    # @return [dates]
+    #
+    # @api public 
+    def dates_covered(options={})
+      s_date = start_date.dup
+      e_date = end_date.dup
+     
+      if is_single_date_range?
+        dates = handle_single_date_range(s_date, e_date, options)
+      else
+        dates = handle_date_range(s_date, e_date, options)
+      end
+
+      covs[:dates] = dates.compact.sort
+    end
+
+   def handle_single_date_range(s_date, e_date, options)
+      if options.empty?
+        s_date += 1
+        dates = (s_date...e_date).collect { |date| date unless is_covered?(date) }
+      else
+        dates = (s_date..e_date).collect { |date| date unless is_covered?(date) }
+      end
+
+      return dates
+    end
+
+    def handle_date_range(s_date, e_date, options)
+      case options[:include]
+      when :both
+        # do nothing
+      when :end_date
+        s_date += 1
+      when :start_date
+        e_date -= 1
+      else
+        s_date += 1
+        e_date -= 1
+      end
+
+      return (s_date..e_date).collect { |date| date unless is_covered?(date) }
+    end
+
+    def covers(cover_options = [:all])
+      if cover_options.include?(:all)
+        months_covered
+        weeks_covered
+        dates_covered(:include => :both)
+      else
+        months_covered if cover_options.include?(:months)
+        weeks_covered if cover_options.include?(:weeks)
+        dates_covered(:include => :both)
+      end
+
+      return covs
+    end
+
+    def is_covered?(dates)
+      is_covered = false
+
+      if !is_covered and covs[:months] and !covs[:months].empty?
+        start_month = covs[:months].first
+        end_month = covs[:months].last.end_of_month
+        is_covered = (start_month..end_month).include?(dates) ? true : false
+      end
+
+      if !is_covered and covs[:weeks] and !covs[:weeks].empty?
+        covs[:weeks].each do |week_date|
+          start_week = ADate.beginning_of_week(week_date, beginning_of_week_day)
+          end_week = ADate.end_of_week(week_date, beginning_of_week_day)
+          is_covered = (start_week..end_week).include?(dates) ? true : false
+          break if is_covered
+        end
+      end
+
+      is_covered
+    end
+
+    private :is_covered?, :date_range_flows_into_selected_months?
+    private :handle_single_date_range, :handle_date_range
+ 
+  end
+end

data/spec/a_date_spec.rb

@@ -0,0 +1,86 @@
+require 'lib/a_date'
+require 'date'
+
+describe Date do
+  describe '#beginning_of_week and #end_of_week' do
+
+    context 'when beginning_of_week day is sunday' do
+      context 'when date is a sunday' do
+        let(:date) { Date.parse('2013-03-03') }
+
+        it 'should return 2013-03-03' do
+          ADate.beginning_of_week(date).should == date
+        end
+        
+        it 'should return 2013-03-09' do
+          ADate.end_of_week(date).should == Date.parse('2013-03-09')
+        end
+      end
+ 
+      context 'when date is a monday' do
+        let(:date) { Date.parse('2013-03-04') }
+
+        it 'should return 2013-03-03' do
+          ADate.beginning_of_week(date).should == Date.parse('2013-03-03')
+        end
+        
+        it 'should return 2013-03-09' do
+          ADate.end_of_week(date).should == Date.parse('2013-03-09')
+        end
+      end
+ 
+      context 'when date is a saturday' do
+        let(:date) { Date.parse('2013-03-09') }
+
+        it 'should return 2013-03-03' do
+          ADate.beginning_of_week(date).should == Date.parse('2013-03-03')
+        end
+        
+        it 'should return 2013-03-09' do
+          ADate.end_of_week(date).should == Date.parse('2013-03-09')
+        end
+      end
+    end
+ 
+    context 'when beginning_of_week day is monday' do
+      context 'when date is a sunday' do
+        let(:date) { Date.parse('2013-03-03') }
+
+        it 'should return 2013-02-25' do
+          ADate.beginning_of_week(date, :monday).should == Date.parse('2013-02-25')
+        end
+ 
+        it 'should return 2013-03-03' do
+          ADate.end_of_week(date, :monday).should == Date.parse('2013-03-03')
+        end
+      end
+ 
+      context 'when date is a monday' do
+        let(:date) { Date.parse('2013-03-04') }
+
+        it 'should return 2013-03-04' do
+          ADate.beginning_of_week(date, :monday).should == Date.parse('2013-03-04')
+        end
+        
+        it 'should return 2013-03-10' do
+          ADate.end_of_week(date, :monday).should == Date.parse('2013-03-10')
+        end
+      end
+ 
+      context 'when date is a saturday' do
+        let(:date) { Date.parse('2013-03-09') }
+
+        it 'should return 2013-03-04' do
+          ADate.beginning_of_week(date, :monday).should == Date.parse('2013-03-04')
+        end
+        
+        it 'should return 2013-03-10' do
+          ADate.end_of_week(date, :monday).should == Date.parse('2013-03-10')
+        end
+      end
+    end
+  
+  end
+end
+
+