Class: RuboCop::Cop::Layout::IndentHeredoc

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, Heredoc, SafeMode
Defined in:
lib/rubocop/cop/layout/indent_heredoc.rb

Overview

This cops checks the indentation of the here document bodies. The bodies are indented one step. In Ruby 2.3 or newer, squiggly heredocs (‘<<~`) should be used. If you use the older rubies, you should introduce some library to your project (e.g. ActiveSupport, Powerpack or Unindent). Note: When `Metrics/LineLength`’s ‘AllowHeredoc` is false (not default),

this cop does not add any offenses for long here documents to
avoid `Metrics/LineLength`'s offenses.

Examples:

EnforcedStyle: auto_detection (default)

# bad
<<-RUBY
something
RUBY

# good
# When using Ruby 2.3 or higher.
<<~RUBY
  something
RUBY

# good
# When using Ruby 2.2 or lower and enabled Rails department.
# The following is possible to enable Rails department by
# adding for example:
#
# Rails:
#   Enabled: true
#
<<-RUBY.strip_heredoc
  something
RUBY

EnforcedStyle: squiggly

# good
# When EnforcedStyle is squiggly, bad code is auto-corrected to the
# following code.
<<~RUBY
  something
RUBY

EnforcedStyle: active_support

# good
# When EnforcedStyle is active_support, bad code is auto-corrected to
# the following code.
<<-RUBY.strip_heredoc
  something
RUBY

EnforcedStyle: powerpack

# good
# When EnforcedStyle is powerpack, bad code is auto-corrected to
# the following code.
<<-RUBY.strip_indent
  something
RUBY

EnforcedStyle: unindent

# good
# When EnforcedStyle is unindent, bad code is auto-corrected to
# the following code.
<<-RUBY.unindent
  something
RUBY

Constant Summary collapse

RUBY23_TYPE_MSG = 
'Use %<indentation_width>d spaces for indentation ' \
'in a heredoc by using `<<~` instead of ' \
'`%<current_indent_type>s`.'.freeze
RUBY23_WIDTH_MSG = 
'Use %<indentation_width>d spaces for '\
'indentation in a heredoc.'.freeze
LIBRARY_MSG = 
'Use %<indentation_width>d spaces for indentation in a ' \
'heredoc by using %<method>s.'.freeze
STRIP_METHODS = 
{
  unindent: 'unindent',
  active_support: 'strip_heredoc',
  powerpack: 'strip_indent'
}.freeze

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods included from Heredoc

#on_str

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

#s

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, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rubocop/cop/layout/indent_heredoc.rb', line 106

def autocorrect(node)
  check_style!

  case style
  when :squiggly
    correct_by_squiggly(node)
  else
    correct_by_library(node)
  end
end

#on_heredoc(node) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/rubocop/cop/layout/indent_heredoc.rb', line 89

def on_heredoc(node)
  body = heredoc_body(node)
  return if body =~ /\A\s*\z/

  body_indent_level = indent_level(body)

  if heredoc_indent_type(node) == '~'
    expected_indent_level = base_indent_level(node) + indentation_width
    return if expected_indent_level == body_indent_level
  else
    return unless body_indent_level.zero?
  end

  return if too_long_line?(node)
  add_offense(node, location: :heredoc_body)
end