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

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
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::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object


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

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


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

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

  receiver = node.receiver

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

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

  add_offense(nil, location: range)
end