Class: RuboCop::Cop::Style::CommentedKeyword
- Includes:
- RangeHelp
- 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:, and `rubocop:disable`) are allowed.
Constant Summary collapse
- MSG =
'Do not place comments on the same line as the ' \ '`%<keyword>s` keyword.'
Constants included from Util
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?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#investigate(processed_source) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 41 def investigate(processed_source) heredoc_lines = extract_heredoc_lines(processed_source.ast) processed_source.each_comment do |comment| location = comment.location line_position = location.line line = processed_source.lines[line_position - 1] next if heredoc_lines.any? { |r| r.include?(line_position) } next unless offensive?(line) range = source_range(processed_source.buffer, line_position, (location.column)...(location.last_column)) add_offense(range, location: range) end end |