jiff-date_range 0.0.1alpha → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983cb28bf546134178793220406d8fb38b946e56216afe3f624e6ba43c14108f
-  data.tar.gz: 96eb20e723693e4a2edbbe7787a8c79f51b5d9e379e159b2bf41713069573ce1
+  metadata.gz: 514fe19ac43c31ae4be5a74b4ef8e73c11bededda9a5b3a692cc1c9c20ad57ed
+  data.tar.gz: de0829c49113b8635d3e6b836b253843133326a10d448399080657b378edbeb0
 SHA512:
-  metadata.gz: 55841617464abdae0f2a812f62978f35770ba0391698d3d99d36737a5aab7875b5a070fee2356e79aeb7ef13c0057a240fb05a32f65b76da11bc9259d278ae40
-  data.tar.gz: d10456e8f540f4fea44a8c53c40b90842d2cbaa96f6b34add990f797af811157e1f2ad81afa36c8ef705fa3d6d97e60942f7358e33c95f609a63a0f6c51bf3d0
+  metadata.gz: e9df1623edf5db29f8ccfcc54c95f81deadbdb1d98a52b361658275cda9042fccd625551f4b9539ed63154ea3bbb31d3feb6787e155afaedd2d892be4f092980
+  data.tar.gz: 112b44f75f3f495d8f6eed1248040831c85914c65de2d7c9eea7f946cee3af04ca0c5defcf5a6c187299a8a160e8c96f670028395f1541f7c243cdd776f11f31

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+jiff-date_range*.gem

data/.story_branch.yml

@@ -0,0 +1,5 @@
+---
+project_id:
+- rpbaltazar/jiff-date_range
+tracker: github
+finish_tag: 'Resolves'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jiff-date_range (0.0.1alpha)
+    jiff-date_range (0.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
 # DateRange
 
+[![Build Status](https://travis-ci.com/rpbaltazar/jiff-date_range.svg?branch=master)](https://travis-ci.com/rpbaltazar/jiff-date_range)
+
 This gem came up from the need of using date ranges in our reporting tool
 and the lack of a gem that actually provided date ranges manipulations, such as
 building arrays of dates.
@@ -95,6 +97,57 @@ date_range = Jiff::DateRange.new(d1, d2)
 date_range.by_month # => [31/01/2019, 28/02/2019, 31/03/2019]
 ```
 
+### include?
+
+As the name suggests, this method takes in a date or a Jiff::DateRange and
+checks wether the date range instance used includes the argument.
+
+```ruby
+d1 = Date.parse('31/01/2019')
+d2 = Date.parse('29/04/2019')
+date_range = Jiff::DateRange.new(d1, d2)
+d3 = Date.parse('01/02/2019')
+date_range.include?(d3) # => true
+
+d4 = Date.parse('28/05/2019')
+date_range.include?(d4) # => false
+
+other_date_range = Jiff::DateRange.new(d3, d4)
+date_range.include?(other_date_range) # => true
+```
+
+
+### overlap?
+
+Once again the method name suggests that this will test if two date ranges
+overlap
+
+```ruby
+d1 = Date.parse('31/01/2019')
+d2 = Date.parse('29/04/2019')
+date_range = Jiff::DateRange.new(d1, d2)
+
+d3 = Date.parse('01/02/2019')
+d4 = Date.parse('28/05/2019')
+other_date_range = Jiff::DateRange.new(d3, d4)
+date_range.overlap?(other_date_range) # => true
+```
+
+### overlap
+
+This method returns the overlapping date range if any, else it'll return nil
+
+```ruby
+d1 = Date.parse('31/01/2019')
+d2 = Date.parse('29/04/2019')
+date_range = Jiff::DateRange.new(d1, d2)
+
+d3 = Date.parse('01/02/2019')
+d4 = Date.parse('28/05/2019')
+other_date_range = Jiff::DateRange.new(d3, d4)
+date_range.overlap(other_date_range) # => start_date=2019-02-01, end_date=2019-04-29
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/lib/jiff/date_range.rb

@@ -4,6 +4,7 @@ require_relative 'date_range/version'
 require_relative 'month_mapper'
 
 module Jiff
+  # Implementation of date range relying in ruby dates (no rails helpers/add-ons)
   class DateRange
     attr_reader :start_date
     attr_reader :end_date
@@ -14,11 +15,11 @@ module Jiff
     end
 
     def by_month
-      return month_ends_in_range if date_is_end_of_month(@start_date)
+      return month_ends_in_range if date_is_end_of_month(start_date)
 
       dates = []
-      current_date = @start_date
-      while current_date <= @end_date
+      current_date = start_date
+      while current_date <= end_date
         dates << current_date
         current_date = next_date(current_date, dates)
       end
@@ -29,6 +30,29 @@ module Jiff
       date_range.to_a
     end
 
+    def include?(date)
+      if date.is_a?(Jiff::DateRange)
+        include?(date.start_date) || include?(date.end_date)
+      else
+        date >= start_date && date <= end_date
+      end
+    end
+
+    def overlap?(other_range)
+      # TODO: Probably should raise 'unsupported type'
+      return unless other_range.is_a? Jiff::DateRange
+
+      other_range.include?(start_date) || other_range.include?(end_date) || include?(other_range)
+    end
+
+    # NOTE: Thank you @chrismytton for the implementation suggestion
+    def overlap(other_range)
+      return unless overlap?(other_range)
+
+      dates = [start_date, end_date, other_range.start_date, other_range.end_date].sort[1, 2]
+      Jiff::DateRange.new(*dates)
+    end
+
     private
 
     def days_grouped_by_month
@@ -37,7 +61,7 @@ module Jiff
 
     def month_ends_in_range
       dates = days_grouped_by_month.values.map(&:last)
-      dates.pop unless date_is_end_of_month(@end_date)
+      dates.pop unless date_is_end_of_month(end_date)
       dates
     end
 
@@ -52,11 +76,11 @@ module Jiff
     end
 
     def date_range
-      (@start_date..@end_date)
+      (start_date..end_date)
     end
 
     def date_is_end_of_month(date)
-      date.day == MonthMapper.days_in_month(date.month)
+      date.day == MonthMapper.days_in_month(date)
     end
   end
 end

data/lib/jiff/date_range/version.rb

@@ -1,5 +1,5 @@
 module Jiff
   class DateRange
-    VERSION = '0.0.1alpha'
+    VERSION = '0.0.1'.freeze
   end
 end

data/lib/jiff/month_mapper.rb

@@ -1,25 +1,13 @@
 module Jiff
+  # Simple mapper between month and number of days
   module MonthMapper
-    DAYS_MONTH = {
-      1 => 31,
-      2 => nil,
-      3 => 31,
-      4 => 30,
-      5 => 31,
-      6 => 30,
-      7 => 31,
-      8 => 31,
-      9 => 30,
-      10 => 31,
-      11 => 30,
-      12 => 31
-    }.freeze
+    DAYS_MONTH = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31].freeze
 
-    def self.days_in_month(month, leap = false)
-      return DAYS_MONTH[month] unless month == 2
-      return 29 if leap
+    def self.days_in_month(date)
+      month = date.month
+      return 29 if month == 2 && Date.gregorian_leap?(date.year)
 
-      28
+      DAYS_MONTH[month - 1]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jiff-date_range
 version: !ruby/object:Gem::Version
-  version: 0.0.1alpha
+  version: 0.0.1
 platform: ruby
 authors:
 - Rui Baltazar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-06 00:00:00.000000000 Z
+date: 2019-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".story_branch.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -82,7 +83,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO
 - bin/console
 - bin/setup
 - jiff-date_range.gemspec
@@ -105,9 +105,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/TODO

@@ -1 +0,0 @@
-https://github.com/everypolitician/date_range/blob/master/test/date_range_test.rb