Class: RuboCop::Cop::Layout::SpaceBeforeComment

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/layout/space_before_comment.rb

Overview

This cop checks for missing space between a token and a comment on the same line.

Examples:

# bad
1 + 1# this operation does ...

# good
1 + 1 # this operation does ...

Constant Summary collapse

MSG =
'Put a space before an end-of-line comment.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_new_investigationObject


20
21
22
23
24
25
26
27
28
29
30
# File 'lib/rubocop/cop/layout/space_before_comment.rb', line 20

def on_new_investigation
  processed_source.tokens.each_cons(2) do |token1, token2|
    next unless token2.comment?
    next unless token1.line == token2.line
    next unless token1.pos.end == token2.pos.begin

    range = token2.pos

    add_offense(range) { |corrector| corrector.insert_before(range, ' ') }
  end
end