Make Rails/ExpandedDateRange aware beginning_of_week with an argument

[koic]

This PR makes Rails/ExpandedDateRange aware beginning_of_week with an argument.

# bad
date.beginning_of_week(:sunday)..date.end_of_week(:sunday)

# good
date.all_week(:sunday)

---

Before submitting the PR make sure the following are checked:

• The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
• Wrote good commit messages.
• Commit message starts with [Fix #issue-number] (if the related issue exists).
• Feature branch is up-to-date with master (if not - rebase it).
• Squashed related commits together.
• Added tests.
• Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
• Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
• If this is a new cop, consider making a corresponding update to the Rails Style Guide.

[pirj]

An error occurred while Rails/DateTimeRange cop was inspecting /Users/pirj/source/real-world-rspec/gitlabhq/app/models/broadcast_message.rb:122:5.
undefined method `source' for nil:NilClass

            range_begin.receiver.source != range_end.receiver.source ||
                                ^^^^^^^
/Users/pirj/source/rubocop-rails/lib/rubocop/cop/rails/date_time_range.rb:69:in `allow?'
/Users/pirj/source/rubocop-rails/lib/rubocop/cop/rails/date_time_range.rb:50:in `on_irange'

I guess it is this line.

I see a number of similar errors when running it against real-world-rspec repos.

[koic]

I've updated this PR. Thank you @pirj!

[pirj]

Nice!

Running on the same corpus:

57497 files inspected, 6 offenses detected, 6 offenses autocorrectable

/Users/pirj/source/real-world-rspec/discourse/app/jobs/concerns/skippable.rb:22:22: C: [Correctable] Rails/DateTimeRange: Use Time.zone.now.all_day instead.
        created_at: (Time.zone.now.beginning_of_day..Time.zone.now.end_of_day)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/Users/pirj/source/real-world-rspec/discourse/lib/guardian.rb:463:54: C: [Correctable] Rails/DateTimeRange: Use Time.zone.now.all_day instead.
    UserExport.where(user_id: @user.id, created_at: (Time.zone.now.beginning_of_day..Time.zone.now.end_of_day)).count == 0
                                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/Users/pirj/source/real-world-rspec/gitlabhq/app/models/member.rb:157:23: C: [Correctable] Rails/DateTimeRange: Use now.all_day instead.
    where(created_at: now.beginning_of_day..now.end_of_day)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/Users/pirj/source/real-world-rspec/gitlabhq/app/services/namespaces/in_product_marketing_emails_service.rb:144:7: C: [Correctable] Rails/DateTimeRange: Use date.all_day instead.
      date.beginning_of_day..date.end_of_day
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/Users/pirj/source/real-world-rspec/gitlabhq/lib/gitlab/contributions_calendar.rb:62:28: C: [Correctable] Rails/DateTimeRange: Use date_in_time_zone.all_day instead.
        .where(created_at: date_in_time_zone.beginning_of_day..date_in_time_zone.end_of_day)
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/Users/pirj/source/real-world-rspec/gitlabhq/spec/models/onboarding_progress_spec.rb:72:81: C: [Correctable] Rails/DateTimeRange: Use 1.day.ago.all_day instead.
      subject { described_class.completed_actions_with_latest_in_range(actions, 1.day.ago.beginning_of_day..1.day.ago.end_of_day) }
                                                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[pirj]

Maybe call it same_receiver??

[koic]

This is an intended naming because it confirms the argument of beginning_of_week.

[pirj]

Does it need a +? It won't be frozen, since it contains interpolation, will it?

[koic]

Because it's a feature from Ruby 3.0.

% cat example.rb
# frozen_string_literal: true

value = 'value'

p "#{value}".frozen?

Ruby 2.7

% ruby -ve xample.rb
ruby 2.7.6p219 (2022-04-12 revision c9c2245c0a) [x86_64-darwin19]
true

Ruby 3.0

% ruby -v example.rb
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-darwin19]
false

[pirj]

TIL, thank you!

[pirj]

Checked manually for some potential offences:

Invoice.where(invoice_date: Date.today.beginning_of_year..Date.today)

This may be unsafe to correct, as we don't really know if there are dates in the future. All good.

[pirj]

⚠️ Funny enough, the search found a cop that already exists and looks identical https://github.com/rubocop/rubocop-rails/blob/master/lib/rubocop/cop/rails/expanded_date_range.rb

[koic]

Oops! I completely overlooked it... On the other hand, this implementation is better to detecting the beginning_of_week with argument. I will update this PR as an extension to Rails/ExpandedDateRange cop instead of adding this cop.

[pirj]

Looks good, thank you!
I'm running low on disk space, can't check on real-world-rails now.
And I guess the code is the same as for the previous run, so it makes no sense to run it on real-world-rspec again.