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

Inherits:
Cop
  • Object
show all
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.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



28
29
30
 
# File 'lib/rubocop/cop/layout/space_before_comment.rb', line 28

def autocorrect(range)
  ->(corrector) { corrector.insert_before(range, ' ') }
end

#investigate(processed_source) ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/rubocop/cop/layout/space_before_comment.rb', line 18

def investigate(processed_source)
  processed_source.tokens.each_cons(2) do |token1, token2|
    next unless token2.comment?
    next unless token1.line == token2.line
    if token1.pos.end == token2.pos.begin
      add_offense(token2.pos, location: token2.pos)
    end
  end
end