Class: RuboCop::Cop::InternalAffairs::NodeTypePredicate

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

Overview

Checks that node types are checked using the predicate helpers.

Examples:


# bad
node.type == :send

# good
node.send_type?

Constant Summary collapse

MSG = 
'Use `#%<type>s_type?` to check node type.'
RESTRICT_ON_SEND = 
%i[==].freeze

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

#node_type_check(node) ⇒ Object 



23
24
25
 
# File 'lib/rubocop/cop/internal_affairs/node_type_predicate.rb', line 23

def_node_matcher :node_type_check, <<~PATTERN
  (send (send $_ :type) :== (sym $_))
PATTERN

#on_send(node) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rubocop/cop/internal_affairs/node_type_predicate.rb', line 27

def on_send(node)
  node_type_check(node) do |receiver, node_type|
    return unless Parser::Meta::NODE_TYPES.include?(node_type)

    message = format(MSG, type: node_type)
    add_offense(node, message: message) do |corrector|
      range = node.source_range.with(begin_pos: receiver.source_range.end_pos + 1)
      corrector.replace(range, "#{node_type}_type?")
    end
  end
end