Class: RuboCop::Cop::Style::EmptyHeredoc

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
Heredoc, RangeHelp, RuboCop::Cop::StringLiteralsHelp
Defined in:
lib/rubocop/cop/style/empty_heredoc.rb

Overview

Checks for using empty heredoc to reduce redundancy.

Examples:


# bad
<<~EOS
EOS

<<-EOS
EOS

<<EOS
EOS

# good
''

# bad
do_something(<<~EOS)
EOS

do_something(<<-EOS)
EOS

do_something(<<EOS)
EOS

# good
do_something('')

Constant Summary collapse

MSG = 
'Use an empty string literal instead of heredoc.'

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

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, #project_index

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

cop_dir_for, #exclude_limit, read_limits

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 



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/empty_heredoc.rb', line 44

def on_heredoc(node)
  heredoc_body = node.loc.heredoc_body

  return unless heredoc_body.source.empty?

  add_offense(node) do |corrector|
    heredoc_end = node.loc.heredoc_end

    corrector.replace(node, preferred_string_literal)
    corrector.remove(range_by_whole_lines(heredoc_body, include_final_newline: true))
    corrector.remove(range_by_whole_lines(heredoc_end, include_final_newline: true))
  end
end