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

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

Overview

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
<<-SQL
  SELECT * FROM foo
SQL

# bad
<<-END
  SELECT * FROM foo
END

# bad
<<-EOS
  SELECT * FROM foo
EOS

Constant Summary collapse

MSG = 
'Use meaningful heredoc delimiters.'

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

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 Heredoc

#on_str

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #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_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, 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_heredoc(node) ⇒ Object 



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

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

  range = node.children.empty? ? node : node.loc.heredoc_end

  add_offense(range)
end