active_date_range 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a7b655ef32c770ab582f7228e59a90091cdba9553de211e1b18d4efbbb016c
-  data.tar.gz: 2f8b685dcaa03b9df69a3d17876023c6e0de5dd8d3bc2f2c0a8208ecffd6b1df
+  metadata.gz: 87427c85b995cb2a7425de3a4b41b0df366c0d622e54cd9cbddc0f74b3608eff
+  data.tar.gz: 7e962cc3041aefb3f231b55b439f86147a07979c86b906a1951fdb7dbf24a1fd
 SHA512:
-  metadata.gz: 292d7bc594e974903c6f73e4edf7b4e3775901f1c970ec54623950d019a8c327ba04e25b0d743c36605df2f514ee752471bd3787d86ff25ece1cdf9903b5b157
-  data.tar.gz: 156323981ba292945aebe705431e86eb5474dcf2adfc1caea88fa9703a60b6f4b164222312ae14710b825b3ed8e2482fdd8545ae839bb3165dcb666a683b8ae0
+  metadata.gz: 1c8bc3b6b648b5947415152f8c2e6d17d85ad4f9f7ef1cee06ad4b9ab3702259c60c1c6d568721dfb0de1916e06f723ec091e9046d897b3c29afac29a192b401
+  data.tar.gz: 7e9534d0cb558c9b440b1a05aabcd1a584d27dbb066342dc82cbd2e4afb39b68519b8b6c518e96374ed8852ed8cb41ee3ab0859310f7ef0a84d8f1284c63e643

data/.github/workflows/ruby.yml

@@ -18,15 +18,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.2']
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.2
+
+* Add this_month?, this_quarter? and this_year? to check if a period is the current month, quarter or year
+
+  *Edwin Vlieg*
+
+
 ## 0.3.1
 
 * Fix issue with `next` not returning a full year when leap years are in the range

data/Gemfile

@@ -11,3 +11,5 @@ gem "minitest", "~> 5.0"
 gem "guard"
 gem "guard-minitest"
 gem "pry"
+gem "benchmark-ips"
+gem "memory_profiler"

data/Gemfile.lock

@@ -1,42 +1,44 @@
 PATH
   remote: .
   specs:
-    active_date_range (0.3.1)
+    active_date_range (0.3.2)
       activesupport (> 6.1)
       i18n
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.0.alpha2)
-      actionview (= 7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
-    activesupport (7.0.0.alpha2)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.1.1)
+    benchmark-ips (2.12.0)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
-    erubi (1.10.0)
-    ffi (1.15.4)
-    formatador (0.3.0)
-    guard (2.18.0)
+    erubi (1.12.0)
+    ffi (1.16.2)
+    formatador (1.1.0)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -49,88 +51,102 @@ GEM
     guard-minitest (2.4.6)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
-    i18n (1.8.10)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    listen (3.7.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.12.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    lumberjack (1.2.8)
+      nokogiri (>= 1.12.0)
+    lumberjack (1.2.9)
+    memory_profiler (1.0.1)
     method_source (1.0.0)
-    minitest (5.14.4)
+    mini_portile2 (2.8.4)
+    minitest (5.20.0)
     nenv (0.3.0)
-    nokogiri (1.12.5-x86_64-linux)
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.0.alpha2)
-      actionpack (= 7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-      zeitwerk (~> 2.5.0.beta3)
-    rainbow (3.0.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (1.21.0)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    rubocop-packaging (0.5.1)
-      rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.11.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.12.2)
+    rubocop-rails (2.21.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    ruby-progressbar (1.11.0)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    thor (1.2.2)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.0.beta3)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.12)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   active_date_range!
   activemodel
+  benchmark-ips
   guard
   guard-minitest
+  memory_profiler
   minitest (~> 5.0)
   pry
   railties (> 6.1)

data/lib/active_date_range/date_range.rb

@@ -128,82 +128,129 @@ module ActiveDateRange
 
     # Returns true when begin of the range is at the beginning of the month
     def begin_at_beginning_of_month?
-      self.begin.present? && self.begin.day == 1
+      memoize(:@begin_at_beginning_of_month) do
+        self.begin.present? && self.begin.day == 1
+      end
     end
 
     # Returns true when begin of the range is at the beginning of the quarter
     def begin_at_beginning_of_quarter?
-      self.begin.present? && begin_at_beginning_of_month? && [1, 4, 7, 10].include?(self.begin.month)
+      memoize(:@begin_at_beginning_of_quarter) do
+        self.begin.present? && begin_at_beginning_of_month? && [1, 4, 7, 10].include?(self.begin.month)
+      end
     end
 
     # Returns true when begin of the range is at the beginning of the year
     def begin_at_beginning_of_year?
-      self.begin.present? && begin_at_beginning_of_month? && self.begin.month == 1
+      memoize(:@begin_at_beginning_of_year) do
+        self.begin.present? && begin_at_beginning_of_month? && self.begin.month == 1
+      end
     end
 
     # Returns true when begin of the range is at the beginning of the week
     def begin_at_beginning_of_week?
-      self.begin.present? && self.begin == self.begin.at_beginning_of_week
+      memoize(:@begin_at_beginning_of_week) do
+        self.begin.present? && self.begin == self.begin.at_beginning_of_week
+      end
     end
 
     # Returns true when the range is exactly one month long
     def one_month?
-      (28..31).cover?(days) &&
-        begin_at_beginning_of_month? &&
-        self.end == self.begin.at_end_of_month
+      memoize(:@one_month) do
+        (28..31).cover?(days) &&
+          begin_at_beginning_of_month? &&
+          self.end == self.begin.at_end_of_month
+      end
     end
 
     # Returns true when the range is exactly one quarter long
     def one_quarter?
-      (90..92).cover?(days) &&
-        begin_at_beginning_of_quarter? &&
-        self.end == self.begin.at_end_of_quarter
+      memoize(:@one_quarter) do
+        (90..92).cover?(days) &&
+          begin_at_beginning_of_quarter? &&
+          self.end == self.begin.at_end_of_quarter
+      end
     end
 
     # Returns true when the range is exactly one year long
     def one_year?
-      (365..366).cover?(days) &&
-        begin_at_beginning_of_year? &&
-        self.end == self.begin.at_end_of_year
+      memoize(:@one_year) do
+        (365..366).cover?(days) &&
+          begin_at_beginning_of_year? &&
+          self.end == self.begin.at_end_of_year
+      end
     end
 
     def one_week?
-      days == 7 &&
-        begin_at_beginning_of_week? &&
-        self.end == self.begin.at_end_of_week
+      memoize(:@one_week) do
+        days == 7 &&
+          begin_at_beginning_of_week? &&
+          self.end == self.begin.at_end_of_week
+      end
     end
 
     # Returns true when the range is exactly one or more months long
     def full_month?
-      begin_at_beginning_of_month? && self.end.present? && self.end == self.end.at_end_of_month
+      memoize(:@full_month) do
+        begin_at_beginning_of_month? && self.end.present? && self.end == self.end.at_end_of_month
+      end
     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.present? && self.end == self.end.at_end_of_quarter
+      memoize(:@full_quarter) do
+        begin_at_beginning_of_quarter? && self.end.present? && self.end == self.end.at_end_of_quarter
+      end
     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.present? && self.end == self.end.at_end_of_year
+      memoize(:@full_year) do
+        begin_at_beginning_of_year? && self.end.present? && self.end == self.end.at_end_of_year
+      end
     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.present? && self.end == self.end.at_end_of_week
+      memoize(:@full_week) do
+        begin_at_beginning_of_week? && self.end.present? && self.end == self.end.at_end_of_week
+      end
     end
 
     alias :full_weeks? :full_week?
 
     # Returns true when begin and end are in the same year
     def same_year?
-      !boundless? && self.begin.year == self.end.year
+      memoize(:@same_year) do
+        !boundless? && self.begin.year == self.end.year
+      end
+    end
+
+    # Return true when the range is equal to the current month
+    def this_month?
+      memoize(:@this_month) do
+        self == DateRange.this_month
+      end
+    end
+
+    # Return true when the range is equal to the current quarter
+    def this_quarter?
+      memoize(:@this_quarter) do
+        self == DateRange.this_quarter
+      end
+    end
+
+    # Return true when the range is equal to the current year
+    def this_year?
+      memoize(:@this_year) do
+        self == DateRange.this_year
+      end
     end
 
     # Returns true when the date range is before the given date. Accepts both a <tt>Date</tt>
@@ -227,14 +274,16 @@ module ActiveDateRange
     #   DateRange.this_quarter.granularity  # => :quarter
     #   DateRange.this_year.granularity     # => :year
     def granularity
-      if one_year?
-        :year
-      elsif one_quarter?
-        :quarter
-      elsif one_month?
-        :month
-      elsif one_week?
-        :week
+      memoize(:@granularity) do
+        if one_year?
+          :year
+        elsif one_quarter?
+          :quarter
+        elsif one_month?
+          :month
+        elsif one_week?
+          :week
+        end
       end
     end
 
@@ -242,11 +291,13 @@ module ActiveDateRange
     # a range of 2021-01-01..2021-12-31 will return `this_year` when the current date
     # is somewhere in 2021.
     def relative_param
-      @relative_param ||= SHORTHANDS
-        .select { |key, _| key.end_with?(granularity.to_s) }
-        .find { |key, range| self == range.call }
-        &.first
-        &.to_s
+      memoize(:@relative_param) do
+        SHORTHANDS
+          .select { |key, _| key.end_with?(granularity.to_s) }
+          .find { |key, range| self == range.call }
+          &.first
+          &.to_s
+      end
     end
 
     # Returns a param representation of the date range. When `relative` is true,
@@ -364,5 +415,13 @@ module ActiveDateRange
           .slice_before { |_, index| index % amount == 0 }
           .map { |group| group.map(&:first).inject(:+) }
       end
+
+      def memoize(name)
+        if instance_variable_defined?(name)
+          instance_variable_get(name)
+        else
+          instance_variable_set(name, yield)
+        end
+      end
   end
 end

data/lib/active_date_range/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_date_range
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Edwin Vlieg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -145,7 +145,7 @@ metadata:
   homepage_uri: https://github.com/moneybird/active-date-range
   source_code_uri: https://github.com/moneybird/active-date-range
   changelog_uri: https://github.com/moneybird/active-date-range/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.9
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: DateRange for ActiveSupport
 test_files: []