Class: RuboCop::Cop::InternalAffairs::NodeDestructuring

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/internal_affairs/node_destructuring.rb

Overview

Checks that node destructuring is using the node extensions.

Examples:

Using splat expansion


# bad
_receiver, method_name, _arguments = send_node.children

# bad
_receiver, method_name, _arguments = *send_node

# good
method_name = send_node.method_name

Constant Summary collapse

MSG =
'Use the methods provided with the node extensions instead ' \
'of manually destructuring nodes.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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_destructuring?(node) ⇒ Object


28
29
30
# File 'lib/rubocop/cop/internal_affairs/node_destructuring.rb', line 28

def_node_matcher :node_destructuring?, <<~PATTERN
  {(masgn (mlhs ...) {(send #node_variable? :children) (array (splat #node_variable?))})}
PATTERN

#node_variable?(node) ⇒ Object


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

def_node_matcher :node_variable?, <<~PATTERN
  {(lvar [#node_suffix? _]) (send nil? [#node_suffix? _])}
PATTERN

#on_masgn(node) ⇒ Object


32
33
34
# File 'lib/rubocop/cop/internal_affairs/node_destructuring.rb', line 32

def on_masgn(node)
  node_destructuring?(node) { add_offense(node) }
end