active_date_range 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93ef4c06d102fab1f4d60e5a6e8ef093f80f73e5d18ae80feb7b3ff952e53d3
-  data.tar.gz: f3e0b0fcfc7e7ae3a4085ceb6eb719b13c8b03452c7219d9570f6634768327a6
+  metadata.gz: 39ccc9d0058b87f4924d253b5e0018b0d95b7eb1f97177e4a2b09f85a6d438e5
+  data.tar.gz: e80e3a5cfd455008ee8354f4342922b2b601fafabab4e7af8ad223f2a1cccf4f
 SHA512:
-  metadata.gz: 0e6ec69527db1a35890f69111e4b1a00f2d1158b2f7bfaeb5d45b51cc7f0a943876c9a4c2cb0cc6da944e251e836c02c8b3a5ccaee43b9cfb351f2cc9340159a
-  data.tar.gz: f5405fc96a213e444dd62a3cd4caf97601a0852937204c5261cf7cb9d979bdfca20b8920f4988af8e6ecd30cb7797e28355ff0f71781dd1cb96677d3ad56b464
+  metadata.gz: 7f16e285ad8b6075546916ef1a31342b82ae9f6e84e87ebaf6081326676be69f59c0ef72e5b85460bdc87586b403341df922e816cb54561b8834b6fb5d07828b
+  data.tar.gz: dbf53b90fd564dd372e8af5b3cc974521df3434d0f1a6e79ffed73a81c372b122a25e4af2d130e6b8b10c10a9a5805c920ec2a8209a6cda71ff50315c5390975

data/.github/workflows/ruby.yml

@@ -0,0 +1,57 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    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
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Cache gems
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-rubocop-
+    - name: Install gems
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -8,7 +8,6 @@ AllCops:
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true
-  SuggestExtensions: false
   Exclude:
     - '**/tmp/**/*'
     - '**/templates/**/*'

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-== 0.1.0
+## 0.2.0
+
+* Add support for weeks:
+
+  - Shorthands for `this_week`, `next_week` and `prev_week`
+  - `full_week?` and `one_week?`
+  - `next` and `previous` now handle weeks correctly
+  - Tests for biweekly calculations
+
+  *Edwin Vlieg*
+
+## 0.1.0
 
 *   Initial import of the DateRange implementation from the internal implementation in the Moneybird code.
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in active_date_range.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_date_range (0.1.0)
+    active_date_range (0.2.0)
       activesupport (~> 6.1)
       i18n
 

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -19,11 +21,11 @@ clearing :on
 
 guard :minitest do
   # with Minitest::Unit
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^test/(.*)/?test_(.*)\.rb$})
+  watch(%r{^test/(.*)/?(.*)_test\.rb$})
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^test/test_helper\.rb$})      { "test" }
 
   # with Minitest::Spec
   # watch(%r{^spec/(.*)_spec\.rb$})

data/README.md

@@ -29,18 +29,21 @@ ActiveDateRange::DateRange.new(Date.new(2021, 1, 1), Date.new(2021, 12, 31))
 ActiveDateRange::DateRange.new(Date.new(2021, 1, 1)..Date.new(2021, 12, 31))
 ```
 
-You can also use shorthands to initialize a range relative to today. Shorthands are available for `this`, `prev` and `next` for the ranges `month`, `quarter` and `year`:
+You can also use shorthands to initialize a range relative to today. Shorthands are available for `this`, `prev` and `next` for the ranges `month`, `quarter`, `year` and `week`:
 
 ```ruby
 ActiveDateRange::DateRange.this_month
 ActiveDateRange::DateRange.this_year
 ActiveDateRange::DateRange.this_quarter
+ActiveDateRange::DateRange.this_week
 ActiveDateRange::DateRange.prev_month
 ActiveDateRange::DateRange.prev_year
 ActiveDateRange::DateRange.prev_quarter
+ActiveDateRange::DateRange.prev_week
 ActiveDateRange::DateRange.next_month
 ActiveDateRange::DateRange.next_year
 ActiveDateRange::DateRange.next_quarter
+ActiveDateRange::DateRange.next_week
 ```
 
 The third option is to use parse:
@@ -71,6 +74,7 @@ date_range.months                           # => 12
 date_range.quarters                         # => 4
 date_range.years                            # => 1
 date_range.one_month?                       # => false
+date_range.one_week?                        # => false
 date_range.one_year?                        # => true
 date_range.full_year?                       # => true
 date_range.same_year?                       # => true

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/active_date_range.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/active_date_range/version'
+# frozen_string_literal: true
+
+require_relative "lib/active_date_range/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "active_date_range"
@@ -9,15 +11,15 @@ Gem::Specification.new do |spec|
   spec.summary       = "DateRange for ActiveSupport"
   spec.description   = "ActiveDateRange provides a range of dates with a powerful API to manipulate and use date ranges in your software."
   spec.homepage      = "https://github.com/moneybird/active-date-range"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/moneybird/active-date-range"
-  spec.metadata["changelog_uri"] = "https://github.com/moneybird/active-date-range/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/moneybird/active-date-range/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "active_support"

data/lib/active_date_range/date_range.rb

@@ -12,7 +12,10 @@ module ActiveDateRange
       next_quarter: -> { DateRange.new(3.months.from_now.to_date.all_quarter) },
       this_year: -> { DateRange.new(Time.zone.today.all_year) },
       prev_year: -> { DateRange.new(12.months.ago.to_date.all_year) },
-      next_year: -> { DateRange.new(12.months.from_now.to_date.all_year) }
+      next_year: -> { DateRange.new(12.months.from_now.to_date.all_year) },
+      this_week: -> { DateRange.new(Time.zone.today.all_week) },
+      prev_week: -> { DateRange.new(1.week.ago.to_date.all_week) },
+      next_week: -> { DateRange.new(1.week.from_now.to_date.all_week) }
     }.freeze
 
     RANGE_PART_REGEXP = %r{\A(?<year>((1\d|2\d)\d\d))-?(?<month>0[1-9]|1[012])-?(?<day>[0-2]\d|3[01])?\z}
@@ -107,6 +110,13 @@ module ActiveDateRange
       months / 12
     end
 
+    # Returns the number of weeks on the range or nil when range is no full week
+    def weeks
+      return nil unless full_week?
+
+      days / 7
+    end
+
     # Returns true when begin of the range is at the beginning of the month
     def begin_at_beginning_of_month?
       self.begin.day == 1
@@ -122,6 +132,11 @@ module ActiveDateRange
       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
+    end
+
     # Returns true when the range is exactly one month long
     def one_month?
       (28..31).cover?(days) &&
@@ -143,6 +158,12 @@ module ActiveDateRange
         self.end == self.begin.at_end_of_year
     end
 
+    def one_week?
+      days == 7 &&
+        begin_at_beginning_of_week? &&
+        self.end == self.begin.at_end_of_week
+    end
+
     # 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
@@ -164,6 +185,13 @@ module ActiveDateRange
 
     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
+    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
@@ -196,6 +224,8 @@ module ActiveDateRange
         :quarter
       elsif one_month?
         :month
+      elsif one_week?
+        :week
       end
     end
 
@@ -244,13 +274,17 @@ 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)
-      if granularity
-        DateRange.new(self.begin - periods.send(granularity), self.begin - 1.day)
+      begin_date = if granularity
+        self.begin - periods.send(granularity)
       elsif full_month?
-        DateRange.new(in_groups_of(:month).first.previous(periods * months).begin, self.begin - 1.day)
+        in_groups_of(:month).first.previous(periods * months).begin
       else
-        DateRange.new((self.begin - (periods * days).days).at_beginning_of_month, self.begin - 1.day)
+        (self.begin - (periods * days).days)
       end
+
+      begin_date = begin_date.at_beginning_of_month if full_month?
+
+      DateRange.new(begin_date, self.begin - 1.day)
     end
 
     # Returns the period next to the current period. `periods` can be raised to return more
@@ -259,11 +293,10 @@ 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)
-      if granularity
-        DateRange.new(self.end + 1.day, (self.end + periods.send(granularity)).at_end_of_month)
-      else
-        DateRange.new(self.end + 1.day, (self.end + days.days).at_end_of_month)
-      end
+      end_date = self.end + (granularity ? periods.send(granularity) : days.days)
+      end_date = end_date.at_end_of_month if full_month?
+
+      DateRange.new(self.end + 1.day, end_date)
     end
 
     # Returns an array with date ranges containing full months/quarters/years in the current range.

data/lib/active_date_range/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require "i18n"
   require "i18n/backend/fallbacks"

data/lib/active_date_range/locale/en.yml

@@ -25,12 +25,15 @@ en:
     relative_range:
       next_month: "next month"
       next_quarter: "next quarter"
+      next_week: "next week"
       next_year: "next year"
       prev_month: "the previous month"
       prev_quarter: "the previous quarter"
+      prev_week: "the previous week"
       prev_year: "the previous year"
       this_month: "this month"
       this_quarter: "this quarter"
+      this_week: "this week"
       this_year: "this year"
       today: "today"
     long_quarter: "quarter %{quarter}"

data/lib/active_date_range/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_date_range
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Edwin Vlieg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,6 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -128,7 +129,7 @@ licenses: []
 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/CHANGELOG.md
+  changelog_uri: https://github.com/moneybird/active-date-range/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="