Class: Rubocop::Cop::Style::MethodCalledOnDoEndBlock

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

Overview

This cop 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.

a do b end.c

Constant Summary collapse

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

Constants inherited from Cop

Cop::OPERATOR_METHODS

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offences, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, #initialize, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#on_block(node) ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/rubocop/cop/style/method_called_on_do_end_block.rb', line 18

def on_block(node)
  method, _args, _body = *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 offences checked by the
  # MultilineBlockChain cop.
  ignore_node(method)
end

#on_send(node) ⇒ Object 



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

def on_send(node)
  return if ignored_node?(node)
  receiver, _method_name, *_args = *node
  if receiver && receiver.type == :block && receiver.loc.end.is?('end')
    range = Parser::Source::Range.new(receiver.loc.end.source_buffer,
                                      receiver.loc.end.begin_pos,
                                      node.loc.expression.end_pos)
    convention(nil, range)
  end
end