Class: RuboCop::Cop::Style::CommentedKeyword

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/commented_keyword.rb

Overview

This cop checks for comments put on the same line as some keywords. These keywords are: ‘begin`, `class`, `def`, `end`, `module`.

Note that some comments (‘:nodoc:`, `:yields:`, `rubocop:disable` and `rubocop:todo`) are allowed.

Examples:

# bad
if condition
  statement
end # end if

# bad
class X # comment
  statement
end

# bad
def x; end # comment

# good
if condition
  statement
end

# good
class X # :nodoc:
  y
end

Constant Summary collapse

MSG = 
'Do not place comments on the same line as the ' \
'`%<keyword>s` keyword.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

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

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_new_investigation ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 40

def on_new_investigation
  processed_source.comments.each do |comment|
    next unless (match = line(comment).match(/(?<keyword>\S+).*#/))

    if offensive?(comment)
      add_offense(comment, message: format(MSG, keyword: match[:keyword]))
    end
  end
end