class ArchSpec::Sources::Base

Shared interface for source adapters. Normalizes the file path, parses eagerly, and converts parser errors to ArchSpec source locations. Subclasses provide supported extensions, a Prism program, and comments.

Attributes

path [R]

Public Class Methods

extensions ()

Source

# File lib/archspec/sources/base.rb, line 11
def self.extensions
  raise NotImplementedError
end

new (path)

Source

# File lib/archspec/sources/base.rb, line 21
def initialize(path)
  @path = File.expand_path(path)
  @result = parse_file
end

rubydex_indexable? ()

Source

# File lib/archspec/sources/base.rb, line 15
def self.rubydex_indexable?
  false
end

Public Instance Methods

comments ()

Source

# File lib/archspec/sources/base.rb, line 26
def comments
  raise NotImplementedError
end

parse_errors ()

Source

# File lib/archspec/sources/base.rb, line 34
def parse_errors
  result.errors.map do |error|
    ParseError.new(error.message, SourceLocation.from_prism(path, error.location))
  end
end

prism ()

Source

# File lib/archspec/sources/base.rb, line 30
def prism
  raise NotImplementedError
end