123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::EmptyLineAfterMagicComment

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_line_after_magic_comment.rb

Overview

Checks for a newline after the final magic comment.

NumberOfEmptyLines configures the minimum number of empty lines required. Set it to 2 when using YARD, which otherwise treats the magic comments as documentation for the first module or class in the file.

Note
 Layout/EmptyLines has to be disabled for values greater than 1, as it removes the extra empty lines this cop adds, and autocorrecting with both enabled loops between them.

Examples:

# good
# frozen_string_literal: true

# Some documentation for Person
class Person
  # Some code
end

# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

NumberOfEmptyLines: 1 (default)

# good
# frozen_string_literal: true

class Person
end

NumberOfEmptyLines: 2

# bad
# frozen_string_literal: true

class Person
end

# good
# frozen_string_literal: true

class Person
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

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?, #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.

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

Instance Method Details

#comments_before_code(source) (private)

[ GitHub ] 

  


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



def comments_before_code(source)
  if source.ast
    source.comments.take_while { |comment| comment.loc.line < source.ast.loc.line }
  else
    source.comments
  end
end


  








  

    #empty_lines_after(last_magic_comment)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_line_after_magic_comment.rb', line 90



def empty_lines_after(last_magic_comment)
  first_line = last_magic_comment.loc.line
  count = 0
  count += 1 while (line = processed_source[first_line + count]) && line.strip.empty?
  count
end


  








  

    #last_magic_comment(source)  ⇒ Parser::Source::Comment?  (private)
  



  

    


Find the last magic comment in the source file.






Take all comments that precede the first line of code (or just take
them all in the case when there is no code), select the
magic comments, and return the last magic comment in the file.



  





  
Returns:


    
  
  • 
    (Parser::Source::Comment)
—    
    

    if magic comments exist before code
    

    
  
    • 
  
  • 
    (nil)
—    
    

    otherwise
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_line_after_magic_comment.rb', line 113



def last_magic_comment(source)
  comments_before_code(source)
    .reverse
    .find { |comment| MagicComment.parse(comment.text).any? }
end


  








  

    #message(actual)   (private)
  

  [ GitHub ]


  

  


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



def message(actual)
  format(MSG, expected: number_of_empty_lines, actual: actual,
              lines: number_of_empty_lines == 1 ? 'line' : 'lines')
end


  








  

    #number_of_empty_lines   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_line_after_magic_comment.rb', line 101



def number_of_empty_lines
  cop_config.fetch('NumberOfEmptyLines', 1)
end


  








  

    #offending_range(last_magic_comment)   (private)
  

  [ GitHub ]


  

  


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



def offending_range(last_magic_comment)
  source_range(processed_source.buffer, last_magic_comment.loc.line + 1, 0)
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_line_after_magic_comment.rb', line 68



def on_new_investigation
  return unless (last_magic_comment = last_magic_comment(processed_source))

  actual = empty_lines_after(last_magic_comment)
  # Trailing empty lines are `Layout/TrailingEmptyLines`' responsibility.
  return unless processed_source[last_magic_comment.loc.line + actual]
  return if actual >= number_of_empty_lines

  offending_range = offending_range(last_magic_comment)

  add_offense(offending_range, message: message(actual)) do |corrector|
    corrector.insert_before(offending_range, "\n" * (number_of_empty_lines - actual))
  end
end


  








  

    #validate_config  
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/empty_line_after_magic_comment.rb', line 59



def validate_config
  return if number_of_empty_lines.is_a?(Integer) && number_of_empty_lines.positive?

  raise ValidationError,
        'The `Layout/EmptyLineAfterMagicComment` cop only accepts a positive ' \
        'integer for its `NumberOfEmptyLines` configuration parameter, but ' \
        "`#{number_of_empty_lines.inspect}` was given."
end