Class: RuboCop::Cop::Style::Blocks

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

Overview

Check for uses of braces or do/end around single line or multi-line blocks.

Constant Summary collapse

MULTI_LINE_MSG =
'Avoid using {...} for multi-line blocks.'
SINGLE_LINE_MSG =
'Prefer {...} over do...end for single-line blocks.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, 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 included from AutocorrectUnlessChangingAST

#autocorrect

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

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


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

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

  block_length = Util.block_length(node)
  block_begin = node.loc.begin.source

  if block_length > 0 && block_begin == '{'
    add_offense(node, :begin, MULTI_LINE_MSG)
  elsif block_length == 0 && block_begin != '{'
    add_offense(node, :begin, SINGLE_LINE_MSG)
  end
end

#on_send(node) ⇒ Object


14
15
16
17
18
19
20
21
22
23
24
25
# File 'lib/rubocop/cop/style/blocks.rb', line 14

def on_send(node)
  _receiver, method_name, *args = *node
  return unless args.any?

  block = get_block(args.last)
  return unless block && !parentheses?(node) && !operator?(method_name)

  # If there are no parentheses around the arguments, then braces and
  # do-end have different meaning due to how they bind, so we allow
  # either.
  ignore_node(block)
end