Class: RuboCop::Cop::Rails::ExpandedDateRange

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, TargetRailsVersion
Defined in:
lib/rubocop/cop/rails/expanded_date_range.rb

Overview

Checks for expanded date range. It only compatible `..` range is targeted. Incompatible `…` range is ignored.

Examples:

# bad
date.beginning_of_day..date.end_of_day
date.beginning_of_week..date.end_of_week
date.beginning_of_month..date.end_of_month
date.beginning_of_quarter..date.end_of_quarter
date.beginning_of_year..date.end_of_year

# good
date.all_day
date.all_week
date.all_month
date.all_quarter
date.all_year

Constant Summary collapse

MSG = 
'Use `%<preferred_method>s` instead.'
PREFERRED_METHODS = 
{
  beginning_of_day: 'all_day',
  beginning_of_week: 'all_week',
  beginning_of_month: 'all_month',
  beginning_of_quarter: 'all_quarter',
  beginning_of_year: 'all_year'
}.freeze
MAPPED_DATE_RANGE_METHODS = 
{
  beginning_of_day: :end_of_day,
  beginning_of_week: :end_of_week,
  beginning_of_month: :end_of_month,
  beginning_of_quarter: :end_of_quarter,
  beginning_of_year: :end_of_year
}.freeze

Instance Method Summary collapse

Methods included from TargetRailsVersion

minimum_target_rails_version, support_target_rails_version?

Instance Method Details

#on_irange(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rubocop/cop/rails/expanded_date_range.rb', line 56

def on_irange(node)
  return unless expanded_date_range(node)

  begin_node = node.begin
  end_node = node.end
  return unless same_receiver?(begin_node, end_node)

  beginning_method = begin_node.method_name
  end_method = end_node.method_name
  return unless use_mapped_methods?(beginning_method, end_method)

  preferred_method = "#{begin_node.receiver.source}.#{PREFERRED_METHODS[beginning_method]}"

  add_offense(node, message: format(MSG, preferred_method: preferred_method)) do |corrector|
    corrector.replace(node, preferred_method)
  end
end