123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::ClosingParenthesisIndentation

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::Alignment, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/closing_parenthesis_indentation.rb

Overview

Checks the indentation of hanging closing parentheses in method calls, method definitions, and grouped expressions. A hanging closing parenthesis means ) preceded by a line break.

Examples:

# bad
some_method(
  a,
  b
  )

some_method(
  a, b
  )

some_method(a, b, c
  )

some_method(a,
            b,
            c
  )

some_method(a,
  x: 1,
  y: 2
  )

# Scenario 1: When First Parameter Is On Its Own Line

# good: when first param is on a new line, right paren is *always*
#       outdented by IndentationWidth
some_method(
  a,
  b
)

# good
some_method(
  a, b
)

# Scenario 2: When First Parameter Is On The Same Line

# good: when all other params are also on the same line, outdent
#       right paren by IndentationWidth
some_method(a, b, c
           )

# good: when all other params are on multiple lines, but are lined
#       up, align right paren with left paren
some_method(a,
            b,
            c
           )

# good: when other params are not lined up on multiple lines, outdent
#       right paren by IndentationWidth
some_method(a,
  x: 1,
  y: 2
)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Alignment - Included

SPACE

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

::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

::RuboCop::ExcludeLimit - Extended

exclude_limit

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

Instance Attribute Summary

::RuboCop::Cop::Alignment - Included

#column_delta

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #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?

Instance Method Summary

::RuboCop::Cop::Alignment - Included

#check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within?

::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,
#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_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

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

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #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

Instance Method Details

#all_elements_aligned?(elements) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 157



def all_elements_aligned?(elements)
  elements.flat_map do |e|
    if e.hash_type?
      e.each_child_node.map { |child| child.loc.column }
    else
      e.loc.column
    end
  end.uniq.count == 1
end


  








  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 95



def autocorrect(corrector, node)
  AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
end


  








  

    #check(node, elements)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 99



def check(node, elements)
  if elements.empty?
    check_for_no_elements(node)
  else
    check_for_elements(node, elements)
  end
end


  








  

    #check_for_elements(node, elements)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 107



def check_for_elements(node, elements)
  left_paren  = node.loc.begin
  right_paren = node.loc.end

  return unless right_paren && begins_its_line?(right_paren)

  correct_column = expected_column(left_paren, elements)

  @column_delta = correct_column - right_paren.column

  return if @column_delta.zero?

  message = message(correct_column, left_paren, right_paren)
  add_offense(right_paren, message: message) do |corrector|
    autocorrect(corrector, right_paren)
  end
end


  








  

    #check_for_no_elements(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 125



def check_for_no_elements(node)
  left_paren = node.loc.begin
  right_paren = node.loc.end
  return unless right_paren && begins_its_line?(right_paren)

  candidates = correct_column_candidates(node, left_paren)

  return if candidates.include?(right_paren.column)

  # Although there are multiple choices for a correct column,
  # select the first one of candidates to determine a specification.
  correct_column = candidates.first
  @column_delta = correct_column - right_paren.column
  message = message(correct_column, left_paren, right_paren)
  add_offense(right_paren, message: message) do |corrector|
    autocorrect(corrector, right_paren)
  end
end


  








  

    #correct_column_candidates(node, left_paren)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 171



def correct_column_candidates(node, left_paren)
  [
    processed_source.line_indentation(left_paren.line),
    left_paren.column,
    node.loc.column
  ]
end


  








  

    #expected_column(left_paren, elements)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 144



def expected_column(left_paren, elements)
  if line_break_after_left_paren?(left_paren, elements)
    source_indent = processed_source.line_indentation(first_argument_line(elements))
    new_indent    = source_indent - configured_indentation_width

    new_indent.negative? ? 0 : new_indent
  elsif all_elements_aligned?(elements)
    left_paren.column
  else
    processed_source.line_indentation(first_argument_line(elements))
  end
end


  








  

    #first_argument_line(elements)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 167



def first_argument_line(elements)
  elements.first.loc.first_line
end


  








  

    #line_break_after_left_paren?(left_paren, elements)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 187



def line_break_after_left_paren?(left_paren, elements)
  elements.first && elements.first.loc.line > left_paren.line
end


  








  

    #message(correct_column, left_paren, right_paren)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 179



def message(correct_column, left_paren, right_paren)
  if correct_column == left_paren.column
    MSG_ALIGN
  else
    format(MSG_INDENT, expected: correct_column, actual: right_paren.column)
  end
end


  








  

    #on_begin(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 84



def on_begin(node)
  check(node, node.children)
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 82



alias on_csend on_send


  








  

    #on_def(node)  
    Also known as: #on_defs
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 88



def on_def(node)
  check(node.arguments, node.arguments)
end


  








  

    #on_defs(node)  
  



  

    


Alias for #on_def.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/closing_parenthesis_indentation.rb', line 91



alias on_defs on_def


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


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



def on_send(node)
  check(node, node.arguments)
end