123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::CommentIndentation

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/comment_indentation.rb

Overview

Checks the indentation of comments.

Examples:

# bad
  # comment here
def method_name
end

  # comment here
a = 'hello'

# yet another comment
  if true
    true
  end

# good
# comment here
def method_name
end

# comment here
a = 'hello'

# yet another comment
if true
  true
end

AllowForAlignment: false (default)

# bad
a = 1 # A really long comment
      # spanning two lines.

# good
# A really long comment spanning one line.
a = 1

AllowForAlignment: true

# good
a = 1 # A really long comment
      # spanning two lines.

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_gem_version

Returns a gems locked versions (i.e.
#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, #heredoc_range, #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, #range_overlaps_offense?, #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

#autocorrect(corrector, comment) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 61



def autocorrect(corrector, comment)
  autocorrect_preceding_comments(corrector, comment)

  autocorrect_one(corrector, comment)
end


  








  

    #autocorrect_one(corrector, comment)   (private)
  

  [ GitHub ]


  

  


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



def autocorrect_one(corrector, comment)
  AlignmentCorrector.correct(corrector, processed_source, comment, @column_delta)
end


  








  

    #autocorrect_preceding_comments(corrector, comment)   (private)
  



  

    


Corrects all comment lines that occur immediately before the given
comment and have the same indentation. This is to avoid a long chain
of correcting, saving the file, parsing and inspecting again, and
then correcting one more line, and so on.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 71



def autocorrect_preceding_comments(corrector, comment)
  comments = processed_source.comments
  index = comments.index(comment)

  comments[0..index]
    .reverse_each
    .each_cons(2)
    .take_while { |below, above| should_correct?(above, below) }
    .map { |_, above| autocorrect_one(corrector, above) }
end


  








  

    #check(comment, comment_index)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 92



def check(comment, comment_index)
  return unless own_line_comment?(comment)

  next_line = line_after_comment(comment)
  correct_comment_indentation = correct_indentation(next_line)
  column = comment.loc.column

  @column_delta = correct_comment_indentation - column
  return if @column_delta.zero?

  if two_alternatives?(next_line)
    # Try the other
    correct_comment_indentation += configured_indentation_width
    # We keep @column_delta unchanged so that autocorrect changes to
    # the preferred style of aligning the comment with the keyword.
    return if column == correct_comment_indentation
  end

  return if correctly_aligned_with_preceding_comment?(comment_index, column)

  add_offense(comment, message: message(column, correct_comment_indentation)) do |corrector|
    autocorrect(corrector, comment)
  end
end


  








  

    #correct_indentation(next_line)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 145



def correct_indentation(next_line)
  return 0 unless next_line

  indentation_of_next_line = next_line =~ /\S/
  indentation_of_next_line + if less_indented?(next_line)
                               configured_indentation_width
                             else
                               0
                             end
end


  








  

    #correctly_aligned_with_preceding_comment?(comment_index, column)  ⇒ Boolean  (private)
  



  

    


Returns true if:
a) the cop is configured to allow extra indentation for alignment, and
b) the currently inspected comment is aligned with the nearest preceding end-of-line
   comment.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 121



def correctly_aligned_with_preceding_comment?(comment_index, column)
  return false unless cop_config['AllowForAlignment']

  processed_source.comments[0...comment_index].reverse_each do |other_comment|
    return other_comment.loc.column == column unless own_line_comment?(other_comment)
  end

  false
end


  








  

    #less_indented?(line)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 156



def less_indented?(line)
  rule = config.for_cop('Layout/AccessModifierIndentation')['EnforcedStyle'] == 'outdent'
  access_modifier = 'private|protected|public'
  /\A\s*(end\b|[)}\]])/.match?(line) || (rule && /\A\s*(#{access_modifier})\b/.match?(line))
end


  








  

    #line_after_comment(comment)   (private)
  

  [ GitHub ]


  

  


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



def line_after_comment(comment)
  lines = processed_source.lines
  lines[comment.loc.line..].find { |line| !line.blank? }
end


  








  

    #message(column, correct_comment_indentation)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 131



def message(column, correct_comment_indentation)
  format(MSG, column: column, correct_comment_indentation: correct_comment_indentation)
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 55



def on_new_investigation
  processed_source.comments.each_with_index { |comment, ix| check(comment, ix) }
end


  








  

    #own_line_comment?(comment)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 135



def own_line_comment?(comment)
  own_line = processed_source.lines[comment.loc.line - 1]
  /\A\s*#/.match?(own_line)
end


  








  

    #should_correct?(preceding_comment, reference_comment)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def should_correct?(preceding_comment, reference_comment)
  loc = preceding_comment.loc
  ref_loc = reference_comment.loc
  loc.line == ref_loc.line - 1 && loc.column == ref_loc.column
end


  








  

    #two_alternatives?(line)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/comment_indentation.rb', line 162



def two_alternatives?(line)
  /^\s*(else|elsif|when|in|rescue|ensure)\b/.match?(line)
end