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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/commented_keyword.rb

Overview

Checks for comments put on the same line as some keywords. These keywords are: class, module, def, begin, end.

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

Autocorrection removes comments from end keyword and keeps comments for class, module, def and begin above the keyword.

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

Cop Safety Information:

  • Autocorrection is unsafe because it may remove a comment that is meaningful.

Constant Summary collapse

MSG = 
'Do not place comments on the same line as the `%<keyword>s` keyword.'
KEYWORDS = 
%w[begin class def end module].freeze
KEYWORD_REGEXES = 
KEYWORDS.map { |w| /^\s*#{w}\s/ }.freeze
ALLOWED_COMMENTS = 
%w[:nodoc: :yields: rubocop:disable rubocop:todo].freeze
ALLOWED_COMMENT_REGEXES = 
ALLOWED_COMMENTS.map { |c| /#\s*#{c}/ }.freeze
REGEXP = 
/(?<keyword>\S+).*#/.freeze

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

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, #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, #inspect, 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?, #autocorrect_with_disable_uncorrectable?, #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_investigation ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 57

def on_new_investigation
  processed_source.comments.each do |comment|
    next unless offensive?(comment) && (match = source_line(comment).match(REGEXP))

    register_offense(comment, match[:keyword])
  end
end