Class: RuboCop::Cop::Rails::PluralizationGrammar

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/pluralization_grammar.rb

Overview

This cop checks for correct grammar when using ActiveSupport's core extensions to the numeric classes.

Examples:

# bad
3.day.ago
1.months.ago

# good
3.days.ago
1.month.ago

Constant Summary collapse

SINGULAR_DURATION_METHODS =
{ second: :seconds,
minute: :minutes,
hour: :hours,
day: :days,
week: :weeks,
fortnight: :fortnights,
month: :months,
year: :years }
PLURAL_DURATION_METHODS =
SINGULAR_DURATION_METHODS.invert
MSG =
'Prefer `%s.%s`.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#on_send(node) ⇒ Object


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/rubocop/cop/rails/pluralization_grammar.rb', line 31

def on_send(node)
  receiver, method_name, *_args = *node
  return if receiver.nil?
  return unless duration_method?(method_name)
  return unless literal_number?(receiver)
  number, = *receiver
  if singular_receiver?(number) && plural_method?(method_name)
    add_offense(node,
                :expression,
                format(MSG, number, singularize(method_name)))
  elsif plural_receiver?(number) && singular_method?(method_name)
    add_offense(node,
                :expression,
                format(MSG, number, pluralize(method_name)))
  end
end