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.

Examples:


a do
  b
end.c

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

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 offenses checked by the
  # MultilineBlockChain cop.
  ignore_node(method)
end

#on_send(node) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
 
# 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
  return unless 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)
  add_offense(nil, range)
end