123456789_123456789_123456789_123456789_123456789_

Class: Prism::Relocation::Entry

Relationships & Source Files
Namespace Children
Exceptions:
MissingValueError
Inherits: Object
Defined in: lib/prism/relocation.rb

Overview

An entry in a repository that will lazily reify its values when they are first accessed.

Class Method Summary

Instance Method Summary

Constructor Details

.new(repository) ⇒ Entry

Initialize a new entry with the given repository.

[ GitHub ] 

  


# File 'lib/prism/relocation.rb', line 59



def initialize(repository)
  @repository = repository
  @values = nil
end


  







Instance Method Details



  

    #comments  
  



  

    

Fetch the leading and trailing comments of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 190



def comments
  [*leading_comments, *trailing_comments]
end


  








  

    #end_character_column  
  



  

    

Fetch the end character column of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 153



def end_character_column
  fetch_value(:end_character_column)
end


  








  

    #end_character_offset  
  



  

    

Fetch the end character offset of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 109



def end_character_offset
  fetch_value(:end_character_offset)
end


  








  

    #end_code_units_column  
  



  

    

Fetch the end code units column of the value, for the encoding that was configured on the repository.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 169



def end_code_units_column
  fetch_value(:end_code_units_column)
end


  








  

    #end_code_units_offset  
  



  

    

Fetch the end code units offset of the value, for the encoding that was configured on the repository.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 125



def end_code_units_offset
  fetch_value(:end_code_units_offset)
end


  








  

    #end_column  
  



  

    

Fetch the end byte column of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 139



def end_column
  fetch_value(:end_column)
end


  








  

    #end_line  
  



  

    

Fetch the end line of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 81



def end_line
  fetch_value(:end_line)
end


  








  

    #end_offset  
  



  

    

Fetch the end byte offset of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 95



def end_offset
  fetch_value(:end_offset)
end


  








  

    #fetch_value(name)   (private)
  



  

    

Fetch a value from the entry, raising an error if it is missing.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 209



def fetch_value(name)
  values.fetch(name) do
    raise MissingValueError, "No value for #{name}, make sure the " \
      "repository has been properly configured"
  end
end


  








  

    #filepath  
  



  

    

Fetch the filepath of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 67



def filepath
  fetch_value(:filepath)
end


  








  

    #leading_comments  
  



  

    

Fetch the leading comments of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 176



def leading_comments
  fetch_value(:leading_comments)
end


  








  

    #reify!(values)  
  

  

    This method is for internal use only.
  



  

    

Reify the values on this entry with the given values. This is an internal-only API that is called from the repository when it is time to reify the values.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 199



def reify!(values) # :nodoc:
  @repository = nil
  @values = values
end


  








  

    #start_character_column  
  



  

    

Fetch the start character column of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 146



def start_character_column
  fetch_value(:start_character_column)
end


  








  

    #start_character_offset  
  



  

    

Fetch the start character offset of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 102



def start_character_offset
  fetch_value(:start_character_offset)
end


  








  

    #start_code_units_column  
  



  

    

Fetch the start code units column of the value, for the encoding that was configured on the repository.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 161



def start_code_units_column
  fetch_value(:start_code_units_column)
end


  








  

    #start_code_units_offset  
  



  

    

Fetch the start code units offset of the value, for the encoding that was configured on the repository.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 117



def start_code_units_offset
  fetch_value(:start_code_units_offset)
end


  








  

    #start_column  
  



  

    

Fetch the start byte column of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 132



def start_column
  fetch_value(:start_column)
end


  








  

    #start_line  
  



  

    

Fetch the start line of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 74



def start_line
  fetch_value(:start_line)
end


  








  

    #start_offset  
  



  

    

Fetch the start byte offset of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 88



def start_offset
  fetch_value(:start_offset)
end


  








  

    #trailing_comments  
  



  

    

Fetch the trailing comments of the value.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 183



def trailing_comments
  fetch_value(:trailing_comments)
end


  








  

    #values   (private)
  



  

    

Return the values from the repository, reifying them if necessary.


  



  [ GitHub ]


  

  


# File 'lib/prism/relocation.rb', line 219



def values
  @values || (@repository&.reify!; @values) #: entry_values
end