Class: RuboCop::Cop::Naming::HeredocDelimiterNaming

Inherits:
Base
  • Object
show all
Includes:
Heredoc
Defined in:
lib/rubocop/cop/naming/heredoc_delimiter_naming.rb

Overview

This cop checks that your heredocs are using meaningful delimiters. By default it disallows ‘END` and `EO*`, and can be configured through forbidden listing additional delimiters.

Examples:


# good
"  SELECT * FROM foo\n"

# bad
"  SELECT * FROM foo\n"

# bad
"  SELECT * FROM foo\n"

Constant Summary collapse

MSG = 
'Use meaningful heredoc delimiters.'

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

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 included from Heredoc

#on_str

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_new_investigation, #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_heredoc(node) ⇒ Object 



31
32
33
34
35
 
# File 'lib/rubocop/cop/naming/heredoc_delimiter_naming.rb', line 31

def on_heredoc(node)
  return if meaningful_delimiters?(node)

  add_offense(node.loc.heredoc_end)
end