123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::HeredocMethodCallPosition

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/heredoc_method_call_position.rb

Overview

Checks for the ordering of a method call where the receiver of the call is a HEREDOC.

Examples:

# bad
<<-SQL
  bar
SQL
.strip_indent

<<-SQL
  bar
SQL
.strip_indent
.trim

# good
<<~SQL
  bar
SQL

<<~SQL.trim
  bar
SQL

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed,
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#all_on_same_line?(nodes) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 97



def all_on_same_line?(nodes)
  return true if nodes.empty?

  nodes.first.first_line == nodes.last.last_line
end


  








  

    #autocorrect(corrector, node, heredoc)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 50



def autocorrect(corrector, node, heredoc)
  call_range = call_range_to_safely_reposition(node, heredoc)
  return if call_range.nil?

  call_source = call_range.source.strip
  corrector.remove(call_range)
  corrector.insert_after(heredoc_begin_line_range(node), call_source)
end


  








  

    #call_after_heredoc_range(heredoc)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 77



def call_after_heredoc_range(heredoc)
  pos = heredoc_end_pos(heredoc)
  range_between(pos + 1, pos + 2)
end


  








  

    #call_end_pos(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 107



def call_end_pos(node)
  node.source_range.end_pos
end


  








  

    #call_line_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 116



def call_line_range(node)
  pos = node.source_range.end_pos
  range_by_whole_lines(range_between(pos, pos))
end


  








  

    #call_range_to_safely_reposition(node, heredoc)   (private)
  



  

    


Returns nil if no range can be safely repositioned.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 122



def call_range_to_safely_reposition(node, heredoc)
  return nil if calls_on_multiple_lines?(node, heredoc)

  heredoc_end_pos = heredoc_end_pos(heredoc)
  call_end_pos = call_end_pos(node)

  call_range = range_between(heredoc_end_pos, call_end_pos)
  call_line_range = call_line_range(node)

  call_source = call_range.source.strip
  call_line_source = call_line_range.source.strip

  return call_range if call_source == call_line_source

  if trailing_comma?(call_source, call_line_source)
    # If there's some on the last line other than the call, e.g.
    # a trailing comma, then we leave the "\n" following the
    # heredoc_end in place.
    return range_between(heredoc_end_pos, call_end_pos + 1)
  end

  nil
end


  








  

    #calls_on_multiple_lines?(node, _heredoc)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 86



def calls_on_multiple_lines?(node, _heredoc)
  last_line = node.last_line
  while send_node?(node)
    return true unless last_line == node.last_line
    return true unless all_on_same_line?(node.arguments)

    node = node.receiver
  end
  false
end


  








  

    #correctly_positioned?(node, heredoc)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 82



def correctly_positioned?(node, heredoc)
  heredoc_end_pos(heredoc) > call_end_pos(node)
end


  








  

    #heredoc_begin_line_range(heredoc)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 111



def heredoc_begin_line_range(heredoc)
  pos = heredoc.source_range.begin_pos
  range_by_whole_lines(range_between(pos, pos))
end


  








  

    #heredoc_end_pos(heredoc)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 103



def heredoc_end_pos(heredoc)
  heredoc.location.heredoc_end.end_pos
end


  








  

    #heredoc_node?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 73



def heredoc_node?(node)
  node.respond_to?(:heredoc?) && node.heredoc?
end


  








  

    #heredoc_node_descendent_receiver(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 59



def heredoc_node_descendent_receiver(node)
  while send_node?(node)
    return node.receiver if heredoc_node?(node.receiver)

    node = node.receiver
  end
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 46



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 37



def on_send(node)
  heredoc = heredoc_node_descendent_receiver(node)
  return unless heredoc
  return if correctly_positioned?(node, heredoc)

  add_offense(call_after_heredoc_range(heredoc)) do |corrector|
    autocorrect(corrector, node, heredoc)
  end
end


  








  

    #send_node?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 67



def send_node?(node)
  return false unless node

  node.call_type?
end


  








  

    #trailing_comma?(call_source, call_line_source)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 146



def trailing_comma?(call_source, call_line_source)
  "#{call_source}," == call_line_source
end