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

Inherits:
Base
  • Object
show all
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 collapse

MSG = 
'Define on_numblock to handle blocks with numbered arguments.'

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

#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

#on_def(node) ⇒ Object 



44
45
46
47
48
49
 
# 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