Class: RuboCop::Cop::Style::BlockDelimiters

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

Overview

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

Constant Summary

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 included from AutocorrectUnlessChangingAST

#autocorrect

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

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?, 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 



25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/style/block_delimiters.rb', line 25

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

  return if proper_block_style?(node)

  add_offense(node, :begin)
end

#on_send(node) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rubocop/cop/style/block_delimiters.rb', line 12

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