123456789_123456789_123456789_123456789_123456789_

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

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::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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::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

#autocorrect(corrector, node) (private)

This method returns an undefined value.

Parameters:

[ GitHub ] 

  


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



def autocorrect(corrector, node)
  [
    heredoc_opening_delimiter_range_from(node),
    heredoc_closing_delimiter_range_from(node)
  ].each do |range|
    corrector.replace(range, EXPECTED_HEREDOC_DELIMITER)
  end
end


  








  

    #expected_heredoc_delimiter?(node)  ⇒ Boolean  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::StrNode)
  
    • 





  [ GitHub ]


  

  


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



def expected_heredoc_delimiter?(node)
  heredoc_delimiter_string_from(node) == EXPECTED_HEREDOC_DELIMITER
end


  








  

    #expected_heredoc_delimiter_in_body?(node)  ⇒ Boolean  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::StrNode)
  
    • 





  [ GitHub ]


  

  


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



def expected_heredoc_delimiter_in_body?(node)
  node.location.heredoc_body.source.lines.any? do |line|
    line.strip == EXPECTED_HEREDOC_DELIMITER
  end
end


  








  

    #heredoc_closing_delimiter_range_from(node)  ⇒ Parser::Source::Range  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::StrNode)
  
    • 





  [ GitHub ]


  

  


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



def heredoc_closing_delimiter_range_from(node)
  node.location.heredoc_end.end.adjust(
    begin_pos: -heredoc_delimiter_string_from(node).length
  )
end


  








  

    #heredoc_delimiter_string_from(node)  ⇒ String  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::StrNode)
  
    • 





  [ GitHub ]


  

  


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



def heredoc_delimiter_string_from(node)
  node.source[Heredoc::OPENING_DELIMITER, 2]
end


  








  

    #heredoc_node_from(node)  ⇒ RuboCop::AST::StrNode?  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::SendNode)
  
    • 





  [ GitHub ]


  

  


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



def heredoc_node_from(node)
  return unless node.first_argument.respond_to?(:heredoc?)
  return unless node.first_argument.heredoc?

  node.first_argument
end


  








  

    #heredoc_opening_delimiter_range_from(node)  ⇒ Parser::Source::Range  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::StrNode)
  
    • 





  [ GitHub ]


  

  


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



def heredoc_opening_delimiter_range_from(node)
  match_data = node.source.match(Heredoc::OPENING_DELIMITER)
  node.source_range.begin.adjust(
    begin_pos: match_data.begin(2),
    end_pos: match_data.end(2)
  )
end


  








  

    #on_send(node)  
  



  

    
This method returns an undefined value.

  





  
Parameters:


    
  
  • 
    node
    (RuboCop::AST::SendNode)
  
    • 





  [ GitHub ]


  

  


# 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