Class: RuboCop::Cop::Rails::RefuteMethods

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

Overview

Use `assert_not` methods instead of `refute` methods.

Examples:

# bad
refute false
refute_empty [1, 2, 3]
refute_equal true, false

# good
assert_not false
assert_not_empty [1, 2, 3]
assert_not_equal true, false

Constant Summary collapse

MSG =
'Prefer `%<assert_method>s` over `%<refute_method>s`.'.freeze
CORRECTIONS =
{
  refute: 'assert_not',
  refute_empty: 'assert_not_empty',
  refute_equal: 'assert_not_equal',
  refute_in_delta: 'assert_not_in_delta',
  refute_in_epsilon: 'assert_not_in_epsilon',
  refute_includes: 'assert_not_includes',
  refute_instance_of: 'assert_not_instance_of',
  refute_kind_of: 'assert_not_kind_of',
  refute_nil: 'assert_not_nil',
  refute_operator: 'assert_not_operator',
  refute_predicate: 'assert_not_predicate',
  refute_respond_to: 'assert_not_respond_to',
  refute_same: 'assert_not_same',
  refute_match: 'assert_no_match'
}.freeze
OFFENSIVE_METHODS =
CORRECTIONS.keys.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



51
52
53
54
55
56
57
58
# File 'lib/rubocop/cop/rails/refute_methods.rb', line 51

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(
      node.loc.selector,
      CORRECTIONS[node.method_name]
    )
  end
end

#on_send(node) ⇒ Object



44
45
46
47
48
49
# File 'lib/rubocop/cop/rails/refute_methods.rb', line 44

def on_send(node)
  return unless offensive?(node)

  message = offense_message(node.method_name)
  add_offense(node, location: :selector, message: message)
end