Class: RuboCop::Cop::Layout::SpaceAroundBlockParameters

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, RangeHelp
Defined in:
lib/rubocop/cop/layout/space_around_block_parameters.rb

Overview

Checks the spacing inside and after block parameters pipes.

Examples:

EnforcedStyleInsidePipes: no_space (default)

# bad
{}.each { | x,  y |puts x }
->( x,  y ) { puts x }

# good
{}.each { |x, y| puts x }
->(x, y) { puts x }

EnforcedStyleInsidePipes: space

# bad
{}.each { |x,  y| puts x }
->(x,  y) { puts x }

# good
{}.each { | x, y | puts x }
->( x, y ) { puts x }

Constant Summary

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

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

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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

#autocorrect(target) ⇒ Object

Parameters:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/rubocop/cop/layout/space_around_block_parameters.rb', line 40

def autocorrect(target)
  lambda do |corrector|
    if target.is_a?(RuboCop::AST::Node)
      if target.parent.children.first == target
        corrector.insert_before(target.source_range, ' ')
      else
        corrector.insert_after(target.source_range, ' ')
      end
    elsif target.source =~ /^\s+$/
      corrector.remove(target)
    else
      corrector.insert_after(target, ' ')
    end
  end
end

#on_block(node) ⇒ Object



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

def on_block(node)
  arguments = node.arguments

  return unless node.arguments? && pipes?(arguments)

  check_inside_pipes(arguments)
  check_after_closing_pipe(arguments) if node.body
  check_each_arg(arguments)
end