class RuboCop::Cop::Rails::PluralizationGrammar

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

@example

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

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

Constants

MSG
PLURAL_DURATION_METHODS
RESTRICT_ON_SEND
SINGULAR_DURATION_METHODS

Public Instance Methods

on_send(node) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 35
def on_send(node)
  return unless duration_method?(node.method_name) && literal_number?(node.receiver) && offense?(node)

  number, = *node.receiver

  add_offense(node, message: message(number, node.method_name)) do |corrector|
    method_name = node.loc.selector.source

    corrector.replace(node.loc.selector, correct_method(method_name))
  end
end

Private Instance Methods

correct_method(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 53
def correct_method(method_name)
  if plural_method?(method_name)
    singularize(method_name)
  else
    pluralize(method_name)
  end
end
duration_method?(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 96
def duration_method?(method_name)
  SINGULAR_DURATION_METHODS.key?(method_name) ||
    PLURAL_DURATION_METHODS.key?(method_name)
end
literal_number?(node) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 84
def literal_number?(node)
  node && (node.int_type? || node.float_type?)
end
message(number, method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 49
def message(number, method_name)
  format(MSG, number: number, correct: correct_method(method_name))
end
offense?(node) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 61
def offense?(node)
  number, = *node.receiver

  (singular_receiver?(number) && plural_method?(node.method_name)) ||
    (plural_receiver?(number) && singular_method?(node.method_name))
end
plural_method?(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 68
def plural_method?(method_name)
  method_name.to_s.end_with?('s')
end
plural_receiver?(number) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 80
def plural_receiver?(number)
  !singular_receiver?(number)
end
pluralize(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 88
def pluralize(method_name)
  SINGULAR_DURATION_METHODS.fetch(method_name.to_sym).to_s
end
singular_method?(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 72
def singular_method?(method_name)
  !plural_method?(method_name)
end
singular_receiver?(number) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 76
def singular_receiver?(number)
  number.abs == 1
end
singularize(method_name) click to toggle source
# File lib/rubocop/cop/rails/pluralization_grammar.rb, line 92
def singularize(method_name)
  PLURAL_DURATION_METHODS.fetch(method_name.to_sym).to_s
end