Class: RuboCop::Cop::Style::ClassCheck

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/class_check.rb

Overview

This cop enforces consistent use of ‘Object#is_a?` or `Object#kind_of?`.

Constant Summary collapse

MSG = 
'Prefer `Object#%s` over `Object#%s`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

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?, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'lib/rubocop/cop/style/class_check.rb', line 32

def autocorrect(node)
  _receiver, method_name, *_args = *node

  lambda do |corrector|
    corrector.replace(node.loc.selector,
                      method_name == :is_a? ? 'kind_of?' : 'is_a?')
  end
end

#message(node) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/class_check.rb', line 22

def message(node)
  _receiver, method_name, *_args = *node

  if method_name == :is_a?
    format(MSG, 'kind_of?', 'is_a?')
  else
    format(MSG, 'is_a?', 'kind_of?')
  end
end

#on_send(node) ⇒ Object 



13
14
15
16
17
18
19
20
 
# File 'lib/rubocop/cop/style/class_check.rb', line 13

def on_send(node)
  _receiver, method_name, *_args = *node
  return unless [:is_a?,
                 :kind_of?].include?(method_name)

  return if style == method_name
  add_offense(node, :selector)
end