123456789_123456789_123456789_123456789_123456789_

Class: RBS::EnvironmentLoader

Relationships & Source Files
Namespace Children
Exceptions:
UnknownLibraryError
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, FileFinder
Inherits: Object
Defined in: lib/rbs/environment_loader.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(core_root: DEFAULT_CORE_ROOT, repository: Repository.new) ⇒ EnvironmentLoader

[ GitHub ] 

  


# File 'lib/rbs/environment_loader.rb', line 39



def initialize(core_root: DEFAULT_CORE_ROOT, repository: Repository.new)
  @core_root = core_root
  @repository = repository

  @libs = Set.new
  @dirs = []
end


  







Class Method Details



  

    .gem_sig_path(name, version)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 27



def self.gem_sig_path(name, version)
  requirements = []
  requirements << version if version
  spec = Gem::Specification.find_by_name(name, *requirements)
  path = Pathname(spec.gem_dir) + "sig"
  if path.directory?
    [spec, path]
  end
rescue Gem::MissingSpecError
  nil
end


  







Instance Attribute Details



  

    #core_root   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 19



attr_reader :core_root


  








  

    #dirs   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 23



attr_reader :dirs


  








  

    #libs   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 22



attr_reader :libs


  








  

    #repository   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 20



attr_reader :repository


  







Instance Method Details



  

    #add(path: nil, library: nil, version: nil, resolve_dependencies: true)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 47



def add(path: nil, library: nil, version: nil, resolve_dependencies: true)
  case
  when path
    dirs << path
  when library
    case library
    when 'rubygems', 'set'
      RBS.logger.warn "`#{library}` has been moved to core library, so it is always loaded. Remove explicit loading `#{library}`"
      return
    end

    if libs.add?(Library.new(name: library, version: version)) && resolve_dependencies
      resolve_dependencies(library: library, version: version)
    end
  end
end


  








  

    #add_collection(lockfile)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 79



def add_collection(lockfile)
  lockfile.check_rbs_availability!

  repository.add(lockfile.fullpath)

  lockfile.gems.each_value do |gem|
    name = gem[:name]
    locked_version = gem[:version]

    if (source = gem[:source]).is_a?(Collection::Sources::Rubygems)
      # allow loading different version of a gem

      unless source.has?(name, locked_version)
        if (spec, _ = self.class.gem_sig_path(name, nil))
          RBS.logger.warn { "Loading type definition from gem `#{name}-#{spec.version}` because locked version `#{locked_version}` is unavailable. Try `rbs collection update` to fix the (potential) issue." }
          locked_version = spec.version.to_s
        end
      end
    end

    add(library: gem[:name], version: locked_version, resolve_dependencies: false)
  end
end


  








  

    #each_dir  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 125



def each_dir
  if root = core_root
    yield :core, root
  end

  libs.each do |lib|
    unless has_library?(version: lib.version, library: lib.name)
      raise UnknownLibraryError.new(lib: lib)
    end

    case
    when from_gem = self.class.gem_sig_path(lib.name, lib.version)
      yield lib, from_gem[1]
    when from_repo = repository.lookup(lib.name, lib.version)
      yield lib, from_repo
    end
  end

  dirs.each do |dir|
    yield dir, dir
  end
end


  








  

    #each_signature  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 148



def each_signature
  files = Set[]

  each_dir do |source, dir|
    skip_hidden = !source.is_a?(Pathname)

    FileFinder.each_file(dir, skip_hidden: skip_hidden, immediate: true) do |path|
      next if files.include?(path)

      files << path
      buffer = Buffer.new(name: path.to_s, content: path.read(encoding: "UTF-8"))

      _, dirs, decls = Parser.parse_signature(buffer)

      yield source, path, buffer, decls, dirs
    end
  end
end


  








  

    #has_library?(library:, version:)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 103



def has_library?(library:, version:)
  if self.class.gem_sig_path(library, version) || repository.lookup(library, version)
    true
  else
    false
  end
end


  








  

    #load(env:)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 111



def load(env:)
  # @type var loaded: Array[[AST::Declarations::t, Pathname, source]]
  loaded = []

  each_signature do |source, path, buffer, decls, dirs|
    decls.each do |decl|
      loaded << [decl, path, source]
    end
    env.add_signature(buffer: buffer, directives: dirs, decls: decls)
  end

  loaded
end


  








  

    #resolve_dependencies(library:, version:)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/environment_loader.rb', line 64



def resolve_dependencies(library:, version:)
  [Collection::Sources::Rubygems.instance, Collection::Sources::Stdlib.instance].each do |source|
    next unless source.has?(library, version)

    unless version
      version = source.versions(library).last or raise
    end

    source.dependencies_of(library, version)&.each do |dep|
      add(library: dep['name'], version: nil)
    end
    return
  end
end