Class: RuboCop::Cop::InternalAffairs::ExampleHeredocDelimiter

Inherits:

Base

• Object
• Base
• RuboCop::Cop::InternalAffairs::ExampleHeredocDelimiter

Extended by:

AutoCorrector

Defined in:

lib/rubocop/cop/internal_affairs/example_heredoc_delimiter.rb

Overview

Use ‘RUBY` for heredoc delimiter of example Ruby code.

Some editors may apply better syntax highlighting by using appropriate language names for the delimiter.

Examples:

# bad
expect_offense(<<~CODE)
  example_ruby_code
CODE

# good
expect_offense(<<~RUBY)
  example_ruby_code
RUBY

Constant Summary

EXPECTED_HEREDOC_DELIMITER =

'RUBY'

MSG =

'Use `RUBY` for heredoc delimiter of example Ruby code.'

RESTRICT_ON_SEND =

%i[
  expect_correction
  expect_no_corrections
  expect_no_offenses
  expect_offense
].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary

• #on_send(node) ⇒ void

Methods included from AutoCorrector

support_autocorrect?

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 RuboCop::Cop::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_send(node) ⇒ void

This method returns an undefined value.

Parameters:

• node (RuboCop::AST::SendNode)

# File 'lib/rubocop/cop/internal_affairs/example_heredoc_delimiter.rb', line 37

def on_send(node)
  heredoc_node = heredoc_node_from(node)
  return unless heredoc_node
  return if expected_heredoc_delimiter?(heredoc_node)
  return if expected_heredoc_delimiter_in_body?(heredoc_node)

  add_offense(heredoc_node) do |corrector|
    autocorrect(corrector, heredoc_node)
  end
end