123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::MultilineBlockLayout

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/multiline_block_layout.rb

Overview

Checks whether the multiline do end blocks have a newline after the start of the block. Additionally, it checks whether the block arguments, if any, are on the same line as the start of the block. Putting block arguments on separate lines, because the whole line would otherwise be too long, is accepted.

Examples:

# bad
blah do |i| foo(i)
  bar(i)
end

# bad
blah do
  |i| foo(i)
  bar(i)
end

# good
blah do |i|
  foo(i)
  bar(i)
end

# bad
blah { |i| foo(i)
  bar(i)
}

# good
blah { |i|
  foo(i)
  bar(i)
}

# good
blah { |
  long_list,
  of_parameters,
  that_would_not,
  fit_on_one_line
|
  foo(i)
  bar(i)
}

Constant Summary

::RuboCop::Cop::Base - Inherited

DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

  • .autocorrect_incompatible_with

    Style/Lambda moves the block arguments of lambda into →(…​), and Style/ItBlockParameter and Style/HashEachMethods remove some or all of them, in the same pass, while this cop moves them next to the block start.

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

Reserved for Commissioner.

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?,
#preview?

Whether the user opted in to unstable behavior, with --preview or AllCops: Preview.
#processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?,
#skipped_unsafe_correction_with_disable_uncorrectable?

Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while --disable-uncorrectable asks for a todo comment on everything this run cannot correct.
#contextual_autocorrect_held_back?

When LSP is enabled or the --editor-mode option is on, it is considered as editing source code, and autocorrection with AutoCorrect: contextual will not be performed.

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos

rubocop:disable-next Metrics/ParameterLists.
#move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed

 — grouped under the Commissioner heading above.
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked).
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #covering_disabled_range, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?,
#enabled_lines?

A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code.
#file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#suppression_reason

The -- reason on the directive that suppresses offenses on this range, or nil when the directive carries none.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with

Style/Lambda moves the block arguments of lambda into →(…​), and Style/ItBlockParameter and Style/HashEachMethods remove some or all of them, in the same pass, while this cop moves them next to the block start.

[ GitHub ] 

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 62



def self.autocorrect_incompatible_with
  [Style::HashEachMethods, Style::ItBlockParameter, Style::Lambda]
end


  







Instance Method Details



  

    #add_offense_for_expression(node, expr, msg)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 108



def add_offense_for_expression(node, expr, msg)
  expression = expr.source_range
  range = range_between(expression.begin_pos, expression.end_pos)

  add_offense(range, message: msg) { |corrector| autocorrect(corrector, node) }
end


  








  

    #args_on_beginning_line?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 83



def args_on_beginning_line?(node)
  !node.arguments? || node.loc.begin.line == node.arguments.loc.last_line
end


  








  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 115



def autocorrect(corrector, node)
  unless args_on_beginning_line?(node)
    autocorrect_arguments(corrector, node)
    expr_before_body = node.arguments.source_range.end
  end

  return unless node.body

  expr_before_body ||= node.loc.begin

  return unless same_line?(expr_before_body, node.body)

  autocorrect_body(corrector, node, node.body)
end


  








  

    #autocorrect_arguments(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 130



def autocorrect_arguments(corrector, node)
  end_pos = range_with_surrounding_space(
    node.arguments.source_range,
    side: :right,
    newlines: false
  ).end_pos
  range = range_between(node.loc.begin.end.begin_pos, end_pos)
  corrector.replace(range, " |#{block_arg_string(node, node.arguments)}|")
end


  








  

    #autocorrect_body(corrector, node, block_body)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 140



def autocorrect_body(corrector, node, block_body)
  first_node = if block_body.begin_type? && !block_body.source.start_with?('(')
                 block_body.children.first
               else
                 block_body
               end

  block_start_col = node.source_range.column

  corrector.insert_before(first_node, "\n  #{' ' * block_start_col}")
end


  








  

    #block_arg_string(node, args)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 152



def block_arg_string(node, args)
  arg_string = args.children.map do |arg|
    if arg.mlhs_type?
      "(#{block_arg_string(node, arg)})"
    else
      arg.source
    end
  end.join(', ')
  arg_string += ',' if include_trailing_comma?(node.arguments)
  arg_string
end


  








  

    #characters_needed_for_space_and_pipes(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 100



def characters_needed_for_space_and_pipes(node)
  if node.source.lines.first.end_with?("|\n")
    PIPE_SIZE
  else
    (PIPE_SIZE * 2) + 1
  end
end


  








  

    #include_trailing_comma?(args)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 164



def include_trailing_comma?(args)
  arg_count = args.each_descendant.count(&:argument_type?)
  arg_count == 1 && args.source.include?(',')
end


  








  

    #line_break_necessary_in_args?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 87



def line_break_necessary_in_args?(node)
  return false unless max_line_length

  needed_length_for_args(node) > max_line_length
end


  








  

    #needed_length_for_args(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 93



def needed_length_for_args(node)
  node.source_range.column +
    characters_needed_for_space_and_pipes(node) +
    node.source.lines.first.chomp.length +
    block_arg_string(node, node.arguments).length
end


  








  

    #on_block(node)  
    Also known as: #on_numblock, #on_itblock
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 66



def on_block(node)
  return if node.single_line?

  unless args_on_beginning_line?(node) || line_break_necessary_in_args?(node)
    add_offense_for_expression(node, node.arguments, ARG_MSG)
  end

  return unless node.body && same_line?(node.loc.begin, node.body)

  add_offense_for_expression(node, node.body, MSG)
end


  








  

    #on_itblock(node)  
  



  

    


Alias for #on_block.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 79



alias on_itblock on_block


  








  

    #on_numblock(node)  
  



  

    


Alias for #on_block.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/multiline_block_layout.rb', line 78



alias on_numblock on_block