Class: RuboCop::Cop::InternalAffairs::OperatorKeyword

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/internal_affairs/operator_keyword.rb

Overview

Enforces the use of ‘node.operator_keyword?` instead of `node.and_type? || node.or_type?`.

Examples:

# bad
node.and_type? || node.or_type?
node.or_type? || node.and_type?

# good
node.operator_keyword?

Constant Summary collapse

MSG = 
'Use `%<prefer>s`.'
PREFERRED_METHOD = 
'operator_keyword?'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#and_or_type(node) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/internal_affairs/operator_keyword.rb', line 23

def_node_matcher :and_or_type, <<~PATTERN
  {
    (or $(send _node :and_type?) $(send _node :or_type?))
    (or $(send _node :or_type?) $(send _node :and_type?))
    (or
      (or _ $(send _node :and_type?)) $(send _node :or_type?))
    (or
      (or _ $(send _node :or_type?)) $(send _node :and_type?))
  }
PATTERN

#on_or(node) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/internal_affairs/operator_keyword.rb', line 34

def on_or(node)
  return unless (lhs, rhs = and_or_type(node))

  begin_range = lhs.receiver&.source_range || lhs.loc.selector
  offense = begin_range.join(rhs.source_range.end)
  prefer = lhs.receiver ? "#{lhs.receiver.source}.#{PREFERRED_METHOD}" : PREFERRED_METHOD

  add_offense(offense, message: format(MSG, prefer: prefer)) do |corrector|
    corrector.replace(offense, prefer)
  end
end