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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
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?`.

Examples:

EnforcedStyle: is_a? (default)

# bad
var.kind_of?(Date)
var.kind_of?(Integer)

# good
var.is_a?(Date)
var.is_a?(Integer)

EnforcedStyle: kind_of?

# bad
var.is_a?(Time)
var.is_a?(String)

# good
var.kind_of?(Time)
var.kind_of?(String)

Constant Summary collapse

MSG =
'Prefer `Object#%<prefer>s` over `Object#%<current>s`.'
RESTRICT_ON_SEND =
%i[is_a? kind_of?].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object


44
45
46
47
48
49
50
# File 'lib/rubocop/cop/style/class_check.rb', line 44

def message(node)
  if node.method?(:is_a?)
    format(MSG, prefer: 'kind_of?', current: 'is_a?')
  else
    format(MSG, prefer: 'is_a?', current: 'kind_of?')
  end
end

#on_send(node) ⇒ Object


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

def on_send(node)
  return if style == node.method_name

  message = message(node)
  add_offense(node.loc.selector, message: message) do |corrector|
    replacement = node.method?(:is_a?) ? 'kind_of?' : 'is_a?'

    corrector.replace(node.loc.selector, replacement)
  end
end