123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::EndAlignment

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

Overview

Checks whether the end keywords are aligned properly.

Three modes are supported through the EnforcedStyleAlignWith configuration parameter:

If it’s set to keyword (which is the default), the end shall be aligned with the start of the keyword (if, class, etc.).

If it’s set to variable the end shall be aligned with the left-hand-side of the variable assignment, if there is one.

If it’s set to start_of_line, the end shall be aligned with the start of the line where the matching keyword appears.

This Layout/EndAlignment cop aligns with keywords (e.g. if, while, case) by default. On the other hand, Layout/BeginEndAlignment cop aligns with EnforcedStyleAlignWith: start_of_line by default due to ||= begin tends to align with the start of the line. Layout/DefEndAlignment cop also aligns with EnforcedStyleAlignWith: start_of_line by default. These style can be configured by each cop.

Examples:

EnforcedStyleAlignWith: keyword (default)

# bad

variable = if true
    end

# good

variable = if true
           end

variable =
  if true
  end

EnforcedStyleAlignWith: variable

# bad

variable = if true
    end

# good

variable = if true
end

variable =
  if true
  end

EnforcedStyleAlignWith: start_of_line

# bad

variable = if true
    end

puts(if true
     end)

# good

variable = if true
end

puts(if true
end)

variable =
  if true
  end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

::RuboCop::Cop::EndKeywordAlignment - Included

MSG

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

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

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

#accept_end_kw_alignment?, #add_offense_for_misalignment, #check_end_kw_alignment, #check_end_kw_in_node, #line_break_before_keyword?, #matching_ranges, #start_line_range, #style_parameter_name, #variable_alignment?

::RuboCop::Cop::RangeHelp - Included

#add_range, #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, #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::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::RuboCop::Cop::CheckAssignment - Included

#on_and_asgn

Alias for CheckAssignment#on_lvasgn.
#on_casgn

Alias for CheckAssignment#on_lvasgn.
#on_cvasgn

Alias for CheckAssignment#on_lvasgn.
#on_gvasgn

Alias for CheckAssignment#on_lvasgn.
#on_ivasgn

Alias for CheckAssignment#on_lvasgn.
#on_lvasgn,
#on_masgn

Alias for CheckAssignment#on_lvasgn.
#on_op_asgn

Alias for CheckAssignment#on_lvasgn.
#on_or_asgn

Alias for CheckAssignment#on_lvasgn.
#on_send, #extract_rhs

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

#alignment_node(node) (private)

[ GitHub ] 

  


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



def alignment_node(node)
  case style
  when :keyword
    node
  when :variable
    align_to = alignment_node_for_variable_style(node)

    while (parent = align_to.parent) && parent.send_type? && same_line?(align_to, parent)
      align_to = parent
    end

    align_to
  else
    start_line_range(node)
  end
end


  








  

    #alignment_node_for_variable_style(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 184



def alignment_node_for_variable_style(node)
  if (node.case_type? || node.case_match_type?) && node.argument? &&
     same_line?(node, node.parent)
    return node.parent
  end

  assignment = assignment_or_operator_method(node)

  if assignment && !line_break_before_keyword?(assignment.source_range, node)
    assignment
  else
    # Fall back to 'keyword' style if this node is not on the RHS of an
    # assignment, or if it is but there's a line break between LHS and
    # RHS.
    node
  end
end


  








  

    #asgn_variable_align_with(outer_node, inner_node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 148



def asgn_variable_align_with(outer_node, inner_node)
  expr = outer_node.source_range

  if line_break_before_keyword?(expr, inner_node)
    inner_node.loc.keyword
  else
    range_between(expr.begin_pos, inner_node.loc.keyword.end_pos)
  end
end


  








  

    #assignment_or_operator_method(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 202



def assignment_or_operator_method(node)
  node.ancestors.find do |ancestor|
    ancestor.assignment_or_similar? || (ancestor.send_type? && ancestor.operator_method?)
  end
end


  








  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 122



def autocorrect(corrector, node)
  AlignmentCorrector.align_end(corrector, processed_source, node, alignment_node(node))
end


  








  

    #check_asgn_alignment(outer_node, inner_node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 137



def check_asgn_alignment(outer_node, inner_node)
  align_with = {
    keyword: inner_node.loc.keyword,
    start_of_line: start_line_range(inner_node),
    variable: asgn_variable_align_with(outer_node, inner_node)
  }

  check_end_kw_alignment(inner_node, align_with)
  ignore_node(inner_node)
end


  








  

    #check_assignment(node, rhs)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 126



def check_assignment(node, rhs)
  # If there are method calls chained to the right hand side of the
  # assignment, we let rhs be the receiver of those method calls before
  # we check if it's an if/unless/while/until.
  return unless (rhs = first_part_of_call_chain(rhs))
  return unless rhs.conditional?
  return if rhs.if_type? && rhs.ternary?

  check_asgn_alignment(node, rhs)
end


  








  

    #check_other_alignment(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 158



def check_other_alignment(node)
  align_with = {
    keyword: node.loc.keyword,
    variable: node.loc.keyword,
    start_of_line: start_line_range(node)
  }
  check_end_kw_alignment(node, align_with)
end


  








  

    #on_case(node)  
    Also known as: #on_case_match
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 111



def on_case(node)
  if node.argument?
    check_asgn_alignment(node.parent, node)
  else
    check_other_alignment(node)
  end
end


  








  

    #on_case_match(node)  
  



  

    


Alias for #on_case.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 118



alias on_case_match on_case


  








  

    #on_class(node)  
  

  [ GitHub ]


  

  


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



def on_class(node)
  check_other_alignment(node)
end


  








  

    #on_if(node)  
  

  [ GitHub ]


  

  


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



def on_if(node)
  check_other_alignment(node) unless node.ternary?
end


  








  

    #on_module(node)  
  

  [ GitHub ]


  

  


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



def on_module(node)
  check_other_alignment(node)
end


  








  

    #on_sclass(node)  
  

  [ GitHub ]


  

  


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



def on_sclass(node)
  if node.parent&.assignment?
    check_asgn_alignment(node.parent, node)
  else
    check_other_alignment(node)
  end
end


  








  

    #on_until(node)  
  

  [ GitHub ]


  

  


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



def on_until(node)
  check_other_alignment(node)
end


  








  

    #on_while(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/end_alignment.rb', line 103



def on_while(node)
  check_other_alignment(node)
end