123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Corrector

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Legacy::Corrector
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Parser::Source::TreeRewriter
Instance Chain:
self, Parser::Source::TreeRewriter
Inherits: Parser::Source::TreeRewriter
  • Object
Defined in: lib/rubocop/cop/corrector.rb

Overview

This class takes a source buffer and rewrite its source based on the different correction rules supplied.

Important! The nodes modified by the corrections should be part of the AST of the source_buffer.

Constant Summary

Class Method Summary

Instance Method Summary

Constructor Details

.new(source) ⇒ Corrector

corrector = Corrector.new(cop)

Parameters:

  • source (Parser::Source::Buffer, or anything leading to one via `(processed_source.)buffer`)
[ GitHub ] 

  


# File 'lib/rubocop/cop/corrector.rb', line 32



def initialize(source)
  source = self.class.source_buffer(source)
  super(
    source,
    different_replacements: :raise,
    swallowed_insertions: :raise,
    crossing_deletions: :accept
  )

  # Don't print warnings to stderr if corrections conflict with each other
  diagnostics.consumer = NOOP_CONSUMER
end


  







Class Method Details



  

    .source_buffer(source)  
  



  

    


Duck typing for get to a ::Parser::Source::Buffer



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 15



def self.source_buffer(source)
  source = source.processed_source if source.respond_to?(:processed_source)
  source = source.buffer if source.respond_to?(:buffer)
  source = source.source_buffer if source.respond_to?(:source_buffer)

  unless source.is_a? ::Parser::Source::Buffer
    raise TypeError, 'Expected argument to lead to a Parser::Source::Buffer ' \
                     "but got #{source.inspect}"
  end

  source
end


  







Instance Method Details



  

    #check_range_validity(node_or_range)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 119



def check_range_validity(node_or_range)
  super(to_range(node_or_range))
end


  








  

    #remove_leading(node_or_range, size)  
  



  

    


Removes size characters from the beginning of the given range.
If size is greater than the size of range, the removed region can
overrun the end of range.



  





  
Parameters:


    
  
  • 
    range
    (Parser::Source::Range, RuboCop::AST::Node)
—    
    

    or node
    

    
  
    • 
  
  • 
    size
    (Integer)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 63



def remove_leading(node_or_range, size)
  range = to_range(node_or_range)
  to_remove = range.with(end_pos: range.begin_pos + size)
  remove(to_remove)
end


  








  

    #remove_preceding(node_or_range, size)  
  



  

    


Removes size characters prior to the source range.



  





  
Parameters:


    
  
  • 
    range
    (Parser::Source::Range, RuboCop::AST::Node)
—    
    

    or node
    

    
  
    • 
  
  • 
    size
    (Integer)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 51



def remove_preceding(node_or_range, size)
  range = to_range(node_or_range)
  to_remove = range.with(begin_pos: range.begin_pos - size, end_pos: range.begin_pos)
  remove(to_remove)
end


  








  

    #remove_trailing(node_or_range, size)  
  



  

    


Removes size characters from the end of the given range.
If size is greater than the size of range, the removed region can
overrun the beginning of range.



  





  
Parameters:


    
  
  • 
    range
    (Parser::Source::Range, RuboCop::AST::Node)
—    
    

    or node
    

    
  
    • 
  
  • 
    size
    (Integer)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 75



def remove_trailing(node_or_range, size)
  range = to_range(node_or_range)
  to_remove = range.with(begin_pos: range.end_pos - size)
  remove(to_remove)
end


  








  

    #rewrite  
  



  

    


Legacy



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 45



alias rewrite process # Legacy


  








  

    #swap(node_or_range1, node_or_range2)  
  



  

    


Swaps sources at the given ranges.



  





  
Parameters:


    
  
  • 
    node_or_range1
    (Parser::Source::Range, RuboCop::AST::Node)
  
    • 
  
  • 
    node_or_range2
    (Parser::Source::Range, RuboCop::AST::Node)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 85



def swap(node_or_range1, node_or_range2)
  range1 = to_range(node_or_range1)
  range2 = to_range(node_or_range2)

  if range1.end_pos == range2.begin_pos
    insert_before(range1, range2.source)
    remove(range2)
  elsif range2.end_pos == range1.begin_pos
    insert_before(range2, range1.source)
    remove(range1)
  else
    replace(range1, range2.source)
    replace(range2, range1.source)
  end
end


  








  

    #to_range(node_or_range)   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 104



def to_range(node_or_range)
  range = case node_or_range
          when ::RuboCop::AST::Node, ::Parser::Source::Comment
            node_or_range.source_range
          when ::Parser::Source::Range
            node_or_range
          else
            raise TypeError,
                  'Expected a Parser::Source::Range, Comment or ' \
                  "RuboCop::AST::Node, got #{node_or_range.class}"
          end
  validate_buffer(range.source_buffer)
  range
end


  








  

    #validate_buffer(buffer)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/corrector.rb', line 123



def validate_buffer(buffer)
  return if buffer == source_buffer

  unless buffer.is_a?(::Parser::Source::Buffer)
    # actually this should be enforced by parser gem
    raise 'Corrector expected range source buffer to be a ' \
          "Parser::Source::Buffer, but got #{buffer.class}"
  end
  raise "Correction target buffer #{buffer.object_id} " \
        "name:#{buffer.name.inspect} " \
        "is not current #{@source_buffer.object_id} " \
        "name:#{@source_buffer.name.inspect} under investigation"
end