active_date_range 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39ccc9d0058b87f4924d253b5e0018b0d95b7eb1f97177e4a2b09f85a6d438e5
-  data.tar.gz: e80e3a5cfd455008ee8354f4342922b2b601fafabab4e7af8ad223f2a1cccf4f
+  metadata.gz: d8f934208add7b15537a13d906fa465a3ae83626551f7b1a7c485c0383e32a10
+  data.tar.gz: 7e1c52e9c9b1da73c8c1212892761ad314d6a7490dbd8f1e516fae3f5d6ab368
 SHA512:
-  metadata.gz: 7f16e285ad8b6075546916ef1a31342b82ae9f6e84e87ebaf6081326676be69f59c0ef72e5b85460bdc87586b403341df922e816cb54561b8834b6fb5d07828b
-  data.tar.gz: dbf53b90fd564dd372e8af5b3cc974521df3434d0f1a6e79ffed73a81c372b122a25e4af2d130e6b8b10c10a9a5805c920ec2a8209a6cda71ff50315c5390975
+  metadata.gz: 854500cb33e2a2bf026f29433eadca6619802db32086d33656262487d7da42735c63f7eddf22849587eae15948792362c6be18ab28bead739d508f8210ed60f7
+  data.tar.gz: e806e16dd17491eb7a45518e428b5a64b42e3fefa774b10659528c9aa8afa4b0ab0c2f5b8d5416bfb140d448c8d4f52061d3db6b276611a468d498a897ac8e5f

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 0.3.0
+
+* `include?` now behaves like `cover?` for better performance
+
+  *Edwin Vlieg*
+
+* Add intersection support:
+
+  ```
+  date_range.intersection(other_date_range) # => DateRange
+  ```
+
+  *Edwin Vlieg*
+
+
+* Add support for boundless ranges:
+
+  ```
+  date_range = DateRange.parse('202101..')
+  date_range.boundless? # => true
+  date_range.in_groups_of(:month) # => Enumerator::Lazy
+  Model.where(date: date_range) # => SQL "WHERE date >= 2021-01-01"
+  ```
+
+  *Edwin Vlieg*
+
+* Add ActiveModel type for date range:
+
+  ```
+  attribute :period, :date_range
+  ```
+
+  *Edwin Vlieg*
+
 ## 0.2.0
 
 * Add support for weeks:

data/Gemfile.lock

@@ -1,41 +1,43 @@
 PATH
   remote: .
   specs:
-    active_date_range (0.2.0)
+    active_date_range (0.3.0)
       activesupport (~> 6.1)
       i18n
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.2.1)
-      actionview (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.2.1)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
+    ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
     erubi (1.10.0)
-    ffi (1.14.2)
+    ffi (1.15.1)
     formatador (0.2.5)
-    guard (2.16.2)
+    guard (2.17.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -48,29 +50,29 @@ GEM
     guard-minitest (2.4.6)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    listen (3.4.1)
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.9.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_portile2 (2.5.0)
-    minitest (5.14.2)
+    mini_portile2 (2.5.1)
+    minitest (5.14.4)
     nenv (0.3.0)
-    nokogiri (1.11.1)
+    nokogiri (1.11.5)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.5.2)
@@ -82,45 +84,45 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
-    rubocop (0.91.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
     rubocop-packaging (0.5.1)
       rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.10.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    ruby-progressbar (1.10.1)
+      rubocop (>= 1.7.0, < 2.0)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -128,6 +130,7 @@ PLATFORMS
 
 DEPENDENCIES
   active_date_range!
+  activemodel
   guard
   guard-minitest
   minitest (~> 5.0)

data/README.md

@@ -93,6 +93,16 @@ date_range.previous(2)                          # => DateRange.parse('201901..20
 date_range.next                                 # => DateRange.parse('202201..202212')
 date_range + DateRange.parse('202201..202202')  # => DateRange.parse('202101..202202')
 date_range.in_groups_of(:month)                 # => [DateRange.parse('202101..202101'), ..., DateRange.parse('202112..202112')]
+date_range.intersection(DateRange.parse('202101..202102')) # => DateRange.parse('202101..202102')
+```
+
+Support for boundless ranges is also available:
+
+```ruby
+date_range = DateRange.parse('202101..')
+date_range.boundless? # => true
+date_range.in_groups_of(:month) # => Enumerator::Lazy
+Model.where(date: date_range) # => SQL "WHERE date >= 2021-01-01"
 ```
 
 And lastly you can call `.humanize` to get a localizable human representation of the range for in the user interface:
@@ -104,6 +114,18 @@ date_range.humanize(format: :explicit)   # => 'January 1st, 2021 - December 31st
 
 See [active_date_range/locale/en.yml](https://github.com/moneybird/active-date-range/blob/main/lib/active_date_range/locale/en.yml) for all the I18n keys you need to translate for your application.
 
+### ActiveModel type
+
+Date ranges are also available as an ActiveModel type. So you can use a date range attribute and the value will automatically be converted:
+
+```ruby
+class Report
+  include ActiveModel::Attributes
+
+  attribute :period, :date_range
+end
+```
+
 ### Usage example
 
 Use the shorthands to link to a specific period:

data/active_date_range.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-packaging"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "activemodel"
 end

data/bin/console

@@ -3,6 +3,7 @@
 
 require "bundler/setup"
 require "active_support"
+require "active_model"
 require "active_date_range"
 
 Time.zone = "UTC"

data/lib/active_date_range.rb

@@ -11,6 +11,7 @@ require "active_date_range/core_ext/date"
 require "active_date_range/version"
 require "active_date_range/date_range"
 require "active_date_range/humanizer"
+require "active_date_range/active_model_type"
 
 module ActiveDateRange
   class Error < StandardError; end
@@ -18,4 +19,5 @@ module ActiveDateRange
   class InvalidAddition < Error; end
   class InvalidDateRangeFormat < Error; end
   class UnknownGranularity < Error; end
+  class BoundlessRangeError < Error; end
 end

data/lib/active_date_range/active_model_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveDateRange
+  class DateRangeType < ActiveModel::Type::String
+    def cast(value)
+      ActiveDateRange::DateRange.parse(value)
+    end
+  end
+end
+
+if defined?(ActiveModel)
+  ActiveModel::Type.register(:date_range, ActiveDateRange::DateRangeType)
+end

data/lib/active_date_range/date_range.rb

@@ -35,12 +35,14 @@ module ActiveDateRange
       return SHORTHANDS[input.to_sym].call if SHORTHANDS.key?(input.to_sym)
 
       begin_date, end_date = input.split("..")
-      raise InvalidDateRangeFormat, "#{input} doesn't have a begin..end format" unless begin_date && end_date
+      raise InvalidDateRangeFormat, "#{input} doesn't have a begin..end format" if begin_date.blank? && end_date.blank?
 
       DateRange.new(parse_date(begin_date), parse_date(end_date, last: true))
     end
 
     def self.parse_date(input, last: false)
+      return if input.blank?
+
       match_data = input.match(RANGE_PART_REGEXP)
       raise InvalidDateRangeFormat, "#{input} isn't a valid date format YYYYMMDD or YYYYMM" unless match_data
 
@@ -62,12 +64,13 @@ module ActiveDateRange
     # Make sures the begin date is before the end date.
     def initialize(begin_date, end_date = nil)
       begin_date, end_date = begin_date.begin, begin_date.end if begin_date.kind_of?(Range)
+      begin_date, end_date = begin_date.first, begin_date.last if begin_date.kind_of?(Array)
       begin_date = begin_date.to_date if begin_date.kind_of?(Time)
       end_date = end_date.to_date if end_date.kind_of?(Time)
 
-      raise InvalidDateRange, "Date range invalid, begin should be a date" unless begin_date.kind_of?(Date)
-      raise InvalidDateRange, "Date range invalid, end should be a date" unless end_date.kind_of?(Date)
-      raise InvalidDateRange, "Date range invalid, begin #{begin_date} is after end #{end_date}" if begin_date > end_date
+      raise InvalidDateRange, "Date range invalid, begin should be a date" if begin_date && !begin_date.kind_of?(Date)
+      raise InvalidDateRange, "Date range invalid, end should be a date" if end_date && !end_date.kind_of?(Date)
+      raise InvalidDateRange, "Date range invalid, begin #{begin_date} is after end #{end_date}" if begin_date && end_date && begin_date > end_date
 
       super(begin_date, end_date)
     end
@@ -84,8 +87,14 @@ module ActiveDateRange
       self.begin <=> other.begin
     end
 
+    def boundless?
+      self.begin.nil? || self.end.nil?
+    end
+
     # Returns the number of days in the range
     def days
+      return if boundless?
+
       @days ||= (self.end - self.begin).to_i + 1
     end
 
@@ -119,22 +128,22 @@ module ActiveDateRange
 
     # Returns true when begin of the range is at the beginning of the month
     def begin_at_beginning_of_month?
-      self.begin.day == 1
+      self.begin.present? && self.begin.day == 1
     end
 
     # Returns true when begin of the range is at the beginning of the quarter
     def begin_at_beginning_of_quarter?
-      begin_at_beginning_of_month? && [1, 4, 7, 10].include?(self.begin.month)
+      self.begin.present? && begin_at_beginning_of_month? && [1, 4, 7, 10].include?(self.begin.month)
     end
 
     # Returns true when begin of the range is at the beginning of the year
     def begin_at_beginning_of_year?
-      begin_at_beginning_of_month? && self.begin.month == 1
+      self.begin.present? && begin_at_beginning_of_month? && self.begin.month == 1
     end
 
     # Returns true when begin of the range is at the beginning of the week
     def begin_at_beginning_of_week?
-      self.begin == self.begin.at_beginning_of_week
+      self.begin.present? && self.begin == self.begin.at_beginning_of_week
     end
 
     # Returns true when the range is exactly one month long
@@ -166,49 +175,49 @@ module ActiveDateRange
 
     # Returns true when the range is exactly one or more months long
     def full_month?
-      begin_at_beginning_of_month? && self.end == self.end.at_end_of_month
+      begin_at_beginning_of_month? && self.end.present? && self.end == self.end.at_end_of_month
     end
 
     alias :full_months? :full_month?
 
     # Returns true when the range is exactly one or more quarters long
     def full_quarter?
-      begin_at_beginning_of_quarter? && self.end == self.end.at_end_of_quarter
+      begin_at_beginning_of_quarter? && self.end.present? && self.end == self.end.at_end_of_quarter
     end
 
     alias :full_quarters? :full_quarter?
 
     # Returns true when the range is exactly one or more years long
     def full_year?
-      begin_at_beginning_of_year? && self.end == self.end.at_end_of_year
+      begin_at_beginning_of_year? && self.end.present? && self.end == self.end.at_end_of_year
     end
 
     alias :full_years? :full_year?
 
     # Returns true when the range is exactly one or more weeks long
     def full_week?
-      begin_at_beginning_of_week? && self.end == self.end.at_end_of_week
+      begin_at_beginning_of_week? && self.end.present? && self.end == self.end.at_end_of_week
     end
 
     alias :full_weeks? :full_week?
 
     # Returns true when begin and end are in the same year
     def same_year?
-      self.begin.year == self.end.year
+      !boundless? && self.begin.year == self.end.year
     end
 
     # Returns true when the date range is before the given date. Accepts both a <tt>Date</tt>
     # and <tt>DateRange</tt> as input.
     def before?(date)
       date = date.begin if date.kind_of?(DateRange)
-      self.end.before?(date)
+      self.end.present? && self.end.before?(date)
     end
 
     # Returns true when the date range is after the given date. Accepts both a <tt>Date</tt>
     # and <tt>DateRange</tt> as input.
     def after?(date)
       date = date.end if date.kind_of?(DateRange)
-      self.begin.after?(date)
+      self.begin.present? && self.begin.after?(date)
     end
 
     # Returns the granularity of the range. Returns either <tt>:year</tt>, <tt>:quarter</tt> or
@@ -255,7 +264,7 @@ module ActiveDateRange
         relative_param
       else
         format = full_month? ? "%Y%m" : "%Y%m%d"
-        "#{self.begin.strftime(format)}..#{self.end.strftime(format)}"
+        "#{self.begin&.strftime(format)}..#{self.end&.strftime(format)}"
       end
     end
 
@@ -274,6 +283,8 @@ module ActiveDateRange
     #   DateRange.this_month.previous # => DateRange.prev_month
     #   DateRange.this_month.previous(2) # => DateRange.prev_month.previous + DateRange.prev_month
     def previous(periods = 1)
+      raise BoundlessRangeError, "Can't calculate previous for boundless range" if boundless?
+
       begin_date = if granularity
         self.begin - periods.send(granularity)
       elsif full_month?
@@ -293,6 +304,8 @@ module ActiveDateRange
     #   DateRange.this_month.next # => DateRange.next_month
     #   DateRange.this_month.next(2) # => DateRange.next_month + DateRange.next_month.next
     def next(periods = 1)
+      raise BoundlessRangeError, "Can't calculate next for boundless range" if boundless?
+
       end_date = self.end + (granularity ? periods.send(granularity) : days.days)
       end_date = end_date.at_end_of_month if full_month?
 
@@ -310,17 +323,40 @@ module ActiveDateRange
     #   DateRange.parse("202101..202103").in_groups_of(:month) # => [DateRange.parse("202001..202001"), DateRange.parse("202002..202002"), DateRange.parse("202003..202003")]
     #   DateRange.parse("202101..202106").in_groups_of(:month, amount: 2) # => [DateRange.parse("202001..202002"), DateRange.parse("202003..202004"), DateRange.parse("202005..202006")]
     def in_groups_of(granularity, amount: 1)
-      raise UnknownGranularity, "Unknown granularity #{granularity}. Valid are: month, quarter and year" unless %w[month quarter year].include?(granularity.to_s)
+      raise BoundlessRangeError, "Can't group date range without a begin." if self.begin.nil?
 
-      group_by { |d| [d.year, d.send(granularity)] }
-        .map { |_, group| DateRange.new(group.first..group.last) }
-        .in_groups_of(amount)
-        .map { |group| group.inject(:+) }
+      if boundless?
+        grouped_collection(granularity, amount: amount)
+      else
+        grouped_collection(granularity, amount: amount).to_a
+      end
     end
 
     # Returns a human readable format for the date range. See DateRange::Humanizer for options.
     def humanize(format: :short)
       Humanizer.new(self, format: format).humanize
     end
+
+    # Returns the intersection of the current and the other date range
+    def intersection(other)
+      intersection = self.to_a.intersection(other.to_a).sort
+      DateRange.new(intersection) if intersection.any?
+    end
+
+    def include?(other)
+      cover?(other)
+    end
+
+    private
+      def grouped_collection(granularity, amount: 1)
+        raise UnknownGranularity, "Unknown granularity #{granularity}. Valid are: month, quarter and year" unless %w[month quarter year].include?(granularity.to_s)
+
+        lazy
+          .chunk { |d| [d.year, d.send(granularity)] }
+          .map { |_, group| DateRange.new(group.first..group.last) }
+          .with_index
+          .slice_before { |_, index| index % amount == 0 }
+          .map { |group| group.map(&:first).inject(:+) }
+      end
   end
 end

data/lib/active_date_range/humanizer.rb

@@ -108,12 +108,19 @@ module ActiveDateRange
         month_format = date_range.full_month? ? "month" : "day_month"
         abbr = "abbr_" if date_range.same_year?
 
+        begin_formatted = I18n.localize(date_range.begin, format: :"#{abbr}#{format}_#{month_format}") if date_range.begin
+        end_formatted = I18n.localize(date_range.end, format: :"#{format}_#{month_format}") if date_range.end
+
         range(
-          I18n.localize(date_range.begin, format: :"#{abbr}#{format}_#{month_format}"),
-          I18n.localize(date_range.end, format: :"#{format}_#{month_format}")
+          begin_formatted || infinite,
+          end_formatted || infinite
         )
       end
 
+      def infinite
+        "∞"
+      end
+
       def range(range_begin, range_end)
         I18n.translate(:range, scope: :date, begin: range_begin, end: range_end)
       end

data/lib/active_date_range/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveDateRange
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_date_range
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edwin Vlieg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ActiveDateRange provides a range of dates with a powerful API to manipulate
   and use date ranges in your software.
 email:
@@ -117,6 +131,7 @@ files:
 - bin/console
 - bin/setup
 - lib/active_date_range.rb
+- lib/active_date_range/active_model_type.rb
 - lib/active_date_range/core_ext/date.rb
 - lib/active_date_range/core_ext/integer.rb
 - lib/active_date_range/date_range.rb
@@ -145,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: DateRange for ActiveSupport