123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::EmptyComment

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

Overview

Checks empty comment.

Examples:

# bad

#
class Foo
end

# good

#
# Description of {Foo} class.
#
class Foo
end

AllowBorderComment: true (default)

# good

def foo
end

#################

def bar
end

AllowBorderComment: false

# bad

def foo
end

#################

def bar
end

AllowMarginComment: true (default)

# good

#
# Description of {Foo} class.
#
class Foo
end

AllowMarginComment: false

# bad

#
# Description of {Foo} class.
#
class Foo
end

Constant Summary

::RuboCop::Cop::Base - Inherited

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

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

Instance Attribute Details

#allow_border_comment? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 133



def allow_border_comment?
  cop_config['AllowBorderComment']
end


  








  

    #allow_margin_comment?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


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



def allow_margin_comment?
  cop_config['AllowMarginComment']
end


  







Instance Method Details



  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 97



def autocorrect(corrector, node)
  previous_token = previous_token(node)
  range = if previous_token && same_line?(node, previous_token)
            range_with_surrounding_space(node.source_range, newlines: false)
          else
            range_by_whole_lines(node.source_range, include_final_newline: true)
          end

  corrector.remove(range)
end


  








  

    #comment_text(comment)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 129



def comment_text(comment)
  "#{comment.text.strip}\n"
end


  








  

    #concat_consecutive_comments(comments)   (private)
  

  [ GitHub ]


  

  


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



def concat_consecutive_comments(comments)
  consecutive_comments = comments.chunk_while do |i, j|
    i.loc.line.succ == j.loc.line && i.loc.column == j.loc.column
  end

  consecutive_comments.map do |chunk|
    joined_text = chunk.map { |c| comment_text(c) }.join
    [joined_text, chunk]
  end
end


  








  

    #current_token(comment)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 141



def current_token(comment)
  processed_source.tokens.find { |token| token.pos == comment.source_range }
end


  








  

    #empty_comment_only?(comment_text)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 119



def empty_comment_only?(comment_text)
  empty_comment_pattern = if allow_border_comment?
                            /\A(#\n)+\z/
                          else
                            /\A(#+\n)+\z/
                          end

  empty_comment_pattern.match?(comment_text)
end


  








  

    #investigate(comments)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 85



def investigate(comments)
  comments.each do |comment|
    next unless empty_comment_only?(comment[0])

    comment[1].each do |offense_comment|
      add_offense(offense_comment) do |corrector|
        autocorrect(corrector, offense_comment)
      end
    end
  end
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_comment.rb', line 69



def on_new_investigation
  if allow_margin_comment?
    comments = concat_consecutive_comments(processed_source.comments)

    investigate(comments)
  else
    processed_source.comments.each do |comment|
      next unless empty_comment_only?(comment_text(comment))

      add_offense(comment) { |corrector| autocorrect(corrector, comment) }
    end
  end
end


  








  

    #previous_token(node)   (private)
  

  [ GitHub ]


  

  


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



def previous_token(node)
  current_token = current_token(node)
  index = processed_source.tokens.index(current_token)
  index.zero? ? nil : processed_source.tokens[index - 1]
end