123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::CaseEquality

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/case_equality.rb

Overview

If AllowOnSelfClass option is enabled, the cop will ignore violations when the receiver of the case equality operator is self.class. Note intermediate variables are not accepted.

Examples:

# bad
(1..100) === 7
/something/ === some_string

# good
something.is_a?(Array)
(1..100).include?(7)
/something/.match?(some_string)

AllowOnConstant: false (default)

# bad
Array === something

AllowOnConstant: true

# good
Array === something

AllowOnSelfClass: false (default)

# bad
self.class === something

AllowOnSelfClass: true

# good
self.class === something

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#begin_replacement(lhs, rhs) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 90

def begin_replacement(lhs, rhs)
  return unless lhs.children.first&.range_type?

  "#{lhs.source}.include?(#{rhs.source})"
end

#case_equality?(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 47

def_node_matcher :case_equality?, '(send $#offending_receiver? :=== $_)'

#const_replacement(lhs, rhs) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 96

def const_replacement(lhs, rhs)
  "#{rhs.source}.is_a?(#{lhs.source})"
end

#offending_receiver?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 65

def offending_receiver?(node)
  return false if node&.const_type? && cop_config.fetch('AllowOnConstant', false)
  return false if self_class?(node) && cop_config.fetch('AllowOnSelfClass', false)

  true
end

#on_send(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 52

def on_send(node)
  case_equality?(node) do |lhs, rhs|
    return if lhs.const_type? && !lhs.module_name?

    add_offense(node.loc.selector) do |corrector|
      replacement = replacement(lhs, rhs)
      corrector.replace(node, replacement) if replacement
    end
  end
end

#replacement(lhs, rhs) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 72

def replacement(lhs, rhs)
  case lhs.type
  when :regexp
    # The automatic correction from `a === b` to `a.match?(b)` needs to
    # consider `Regexp.last_match?`, `$~`, `$1`, and etc.
    # This correction is expected to be supported by `Performance/Regexp` cop.
    # See: https://github.com/rubocop/rubocop-performance/issues/152
    #
    # So here is noop.
  when :begin
    begin_replacement(lhs, rhs)
  when :const
    const_replacement(lhs, rhs)
  when :send
    send_replacement(lhs, rhs)
  end
end

#self_class?(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 50

def_node_matcher :self_class?, '(send (self) :class)'

#send_replacement(lhs, rhs) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/case_equality.rb', line 100

def send_replacement(lhs, rhs)
  return unless self_class?(lhs)

  "#{rhs.source}.is_a?(#{lhs.source})"
end