date_range_covers 0.0.3 → 0.0.4

data/README.md

@@ -22,13 +22,13 @@ Or install it yourself as:
 
     start_date = Date.parse('2013-01-01')
     end_date = Date.parse('2013-04-11')
-    start_of_week = :sunday
+    start_of_week = :sunday #or :monday
 
     d = DateRangeCovers::DateRange.new(start_date, end_date, start_of_week)
 
-    d.covers
+    d.covers #the date range partitioned into months, weeks and days
     => {
-      :dates=>[
+      :days=>[
         Mon, 01 Apr 2013, Tue, 02 Apr 2013, Wed, 03 Apr 2013, Thu, 04 Apr 2013, 
         Fri, 05 Apr 2013, Sat, 06 Apr 2013, Sun, 07 Apr 2013, Mon, 08 Apr 2013,
         Tue, 09 Apr 2013, Wed, 10 Apr 2013, Thu, 11 Apr 2013
@@ -37,6 +37,25 @@ Or install it yourself as:
       :weeks=>[]
     }
 
+    params = [:days] #all dates within the date range   
+    d.covers params
+
+    params = [:weeks] #the days in the date range partitioned into weeks/days
+    d.covers params
+
+    params = [:months] #days in the date range partitioned into months/days
+    d.covers params
+    
+    params = [:days, :weeks] #same as [:weeks]
+    d.covers params
+
+    params = [:days, :months] #same as [:months]
+    d.covers params
+    
+    params = [:weeks, :months] #same as [:all]
+    d.covers params
+
+
 ## Contributing
 
 1. Fork it

data/lib/date_range_covers.rb

@@ -201,7 +201,7 @@ module DateRangeCovers
         dates = handle_date_range(s_date, e_date, options)
       end
 
-      covs[:dates] = dates.compact.sort
+      covs[:days] = dates.compact.sort
     end
 
    def handle_single_date_range(s_date, e_date, options)
@@ -231,6 +231,28 @@ module DateRangeCovers
       return (s_date..e_date).collect { |date| date unless is_covered?(date) }
     end
 
+    # Returns dates within a date range, partitioned in
+    # months/weeks/days.
+    #
+    # Dates that are not boxed by a week or month, are returned as days. 
+    #
+    # @example
+    #   covered_range = DateRangeCovers::DateRange.covers
+    #   covered_range = DateRangeCovers::DateRange.covers(params)
+    #
+    # @params
+    #   [:all] or no params => default, the date range partitioned into months, weeks and days
+    #   [:days] => all dates within the date range   
+    #   [:weeks] => the days in the date range partitioned into weeks/days
+    #   [:months] => days in the date range partitioned into months/days
+    
+    #   [:days, :weeks] => same as [:weeks]
+    #   [:days, :months] => same as [:months]
+    #   [:weeks, :months] => same as [:all]
+    #
+    # @return Hash
+    #
+    # @api public 
     def covers(cover_options = [:all])
       @covs = {}
 

data/lib/date_range_covers/version.rb

@@ -1,3 +1,3 @@
 module DateRangeCovers
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/date_range_covers_spec.rb

@@ -311,9 +311,9 @@ describe DateRangeCovers do
             covers[:weeks].should include Date.parse(date)
           end
          
-          covers[:dates].length.should == 6
+          covers[:days].length.should == 6
           %w(2013-03-06 2013-03-07 2013-03-08 2013-03-09 2013-03-31 2013-06-01).each do |date|
-            covers[:dates].should include Date.parse(date)
+            covers[:days].should include Date.parse(date)
           end
         end
       end
@@ -328,12 +328,12 @@ describe DateRangeCovers do
 
           covers[:weeks].should be_nil
 
-          covers[:dates].length.should == 48
+          covers[:days].length.should == 48
           (6..31).each do |day|
-            covers[:dates].should include Date.parse("2013-03-#{day}")
+            covers[:days].should include Date.parse("2013-03-#{day}")
           end
           (1..22).each do |day|
-            covers[:dates].should include Date.parse("2013-06-#{day}")
+            covers[:days].should include Date.parse("2013-06-#{day}")
           end
         end
       end
@@ -343,18 +343,18 @@ describe DateRangeCovers do
         it "should return with just the weeks and dates" do
           covers[:months].should be_nil
           covers[:weeks].length.should == 15 
-          covers[:dates].length.should == 4 
+          covers[:days].length.should == 4 
         end
       end
   
       context 'when include is :dates' do
-        let(:covers) { drange.covers([:dates]) }
+        let(:covers) { drange.covers([:days]) }
         it "should return with just the days between" do
           covers[:months].should be_nil
           covers[:weeks].should be_nil
-          covers[:dates].length.should == (start_date..end_date).collect {|date| date}.length
+          covers[:days].length.should == (start_date..end_date).collect {|date| date}.length
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -371,12 +371,12 @@ describe DateRangeCovers do
           covers[:months].should be_empty
           covers[:weeks].length.should == 1
           covers[:weeks].should include Date.parse('2013-03-10')
-          covers[:dates].length.should == 10
+          covers[:days].length.should == 10
           (Date.parse('2013-03-06')..Date.parse('2013-03-09')).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
           (Date.parse('2013-03-17')..Date.parse('2013-03-22')).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -386,9 +386,9 @@ describe DateRangeCovers do
         it "should return with just the days between" do
           covers[:months].should be_empty
           covers[:weeks].should be_nil
-          covers[:dates].length.should == 17 
+          covers[:days].length.should == 17 
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -399,24 +399,24 @@ describe DateRangeCovers do
           covers[:months].should be_nil
           covers[:weeks].length.should == 1
           covers[:weeks].should include Date.parse('2013-03-10')
-          covers[:dates].length.should == 10
+          covers[:days].length.should == 10
           (Date.parse('2013-03-06')..Date.parse('2013-03-09')).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
           (Date.parse('2013-03-17')..Date.parse('2013-03-22')).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
   
       context 'when include is :dates' do
-        let(:covers) { drange.covers([:dates]) }
+        let(:covers) { drange.covers([:days]) }
         it "should return with just the days between" do
           covers[:months].should be_nil
           covers[:weeks].should be_nil
-          covers[:dates].length.should == 17 
+          covers[:days].length.should == 17 
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -432,9 +432,9 @@ describe DateRangeCovers do
         it "should return with just the days between" do
           covers[:months].should be_empty
           covers[:weeks].should be_empty
-          covers[:dates].should_not be_empty
+          covers[:days].should_not be_empty
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -444,9 +444,9 @@ describe DateRangeCovers do
         it "should return with just the days between" do
           covers[:months].should be_empty
           covers[:weeks].should be_nil
-          covers[:dates].should_not be_empty
+          covers[:days].should_not be_empty
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
@@ -456,21 +456,21 @@ describe DateRangeCovers do
         it "should return with just the days between" do
           covers[:months].should be_nil
           covers[:weeks].should be_empty
-          covers[:dates].should_not be_empty
+          covers[:days].should_not be_empty
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end
   
       context 'when include is :dates' do
-        let(:covers) { drange.covers([:dates]) }
+        let(:covers) { drange.covers([:days]) }
         it "should return with just the days between" do
           covers[:months].should be_nil
           covers[:weeks].should be_nil
-          covers[:dates].should_not be_empty
+          covers[:days].should_not be_empty
           (start_date..end_date).each do |date|
-            covers[:dates].should include date
+            covers[:days].should include date
           end
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: date_range_covers
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Antall Fernandes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-20 00:00:00 Z
+date: 2013-03-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler