Class: RuboCop::Cop::Style::MethodCalledOnDoEndBlock

Inherits:
Base
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/method_called_on_do_end_block.rb

Overview

Checks for methods called on a do…​end block. The point of this check is that it’s easy to miss the call tacked on to the block when reading code.

Examples:

# bad
a do
  b
end.c

# good
a { b }.c

# good
foo = a do
  b
end
foo.c

Constant Summary collapse

MSG = 
'Avoid chaining a method call on a do...end block.'

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, autocorrect_incompatible_with, badge, #begin_investigation, 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, #inspect, 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?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from 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_block(node) ⇒ Object Also known as: on_numblock 



29
30
31
32
33
34
35
36
 
# File 'lib/rubocop/cop/style/method_called_on_do_end_block.rb', line 29

def on_block(node)
  # If the method that is chained on the do...end block is itself a
  # method with a block, we allow it. It's pretty safe to assume that
  # these calls are not missed by anyone reading code. We also want to
  # avoid double reporting of offenses checked by the
  # MultilineBlockChain cop.
  ignore_node(node.send_node)
end

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/method_called_on_do_end_block.rb', line 40

def on_send(node)
  return if ignored_node?(node)

  receiver = node.receiver

  return unless (receiver&.block_type? || receiver&.numblock_type?) &&
                receiver.loc.end.is?('end')

  range = range_between(receiver.loc.end.begin_pos, node.source_range.end_pos)

  add_offense(range)
end