Class: RuboCop::Cop::InternalAffairs::NodeTypeGroup

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

Overview

Checks that node types are checked against their group when all types of a group are checked.

Examples:

# bad
node.type?(:irange, :erange)

# good
node.range_type?

# bad
node.type?(:irange, :erange, :send, :csend)

# good
node.type?(:range, :call)

Constant Summary collapse

MSG =
'Use `:%<group>s` instead of individually listing group types.'
RESTRICT_ON_SEND =
%i[type? each_ancestor each_child_node each_descendant each_node].freeze

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

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_gem_version, #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

#on_send(node) ⇒ Object Also known as: on_csend

[View source]

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/rubocop/cop/internal_affairs/node_type_group.rb', line 30

def on_send(node)
  return unless node.receiver

  symbol_args = node.arguments.select(&:sym_type?)
  return if symbol_args.none?

  NodePatternGroups::NODE_GROUPS.each do |group_name, group_types|
    next unless group_satisfied?(group_types, symbol_args)

    offense_range = arguments_range(node)
    add_offense(offense_range, message: format(MSG, group: group_name)) do |corrector|
      autocorrect(corrector, node, symbol_args, group_name, group_types)
    end
  end
end