123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::NumblockHandler

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

Overview

Checks for missing numblock handlers. The blocks with numbered arguments introduced in Ruby 2.7 are parsed with a node type of `numblock instead of block. Cops that define block handlers need to define numblock handlers or disable this cope for them.

Examples:

# bad
class BlockRelatedCop < Base
  def on_block(node)
  end
end

# good
class BlockRelatedCop < Base
  def on_block(node)
  end

  alias on_numblock on_block
end

class BlockRelatedCop < Base
  def on_block(node)
  end

  alias_method :on_numblock, :on_block
end

class BlockRelatedCop < Base
  def on_block(node)
  end

  def on_numblock(node)
  end
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::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

#block_handler?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/numblock_handler.rb', line 54

def_node_matcher :block_handler?, <<~PATTERN
  (def :on_block (args (arg :node)) ...)
PATTERN

#numblock_handler?(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/numblock_handler.rb', line 59

def_node_matcher :numblock_handler?, <<~PATTERN
  {
    `(def :on_numblock (args (arg :node)) ...)
    `(alias (sym :on_numblock) (sym :on_block))
    `(send nil? :alias_method (sym :on_numblock) (sym :on_block))
  }
PATTERN

#on_def(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/numblock_handler.rb', line 44

def on_def(node)
  return unless block_handler?(node)
  return unless node.parent

  add_offense(node) unless numblock_handler?(node.parent)
end