123456789_123456789_123456789_123456789_123456789_

Class: RBS::EnvironmentLoader

Relationships & Source Files
Namespace Children
Exceptions:
UnknownLibraryError
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 37



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 25



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 17



attr_reader :core_root


  








  

    #dirs   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :dirs


  








  

    #libs   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :libs


  








  

    #repository   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :repository


  







Instance Method Details



  

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

  [ GitHub ]


  

  


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



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

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


  








  

    #add_collection(collection_config)  
  

  [ GitHub ]


  

  


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



def add_collection(collection_config)
  collection_config.check_rbs_availability!

  repository.add(collection_config.repo_path)

  collection_config.gems.each do |gem|
    add(library: gem['name'], version: gem['version'], resolve_dependencies: false)
  end
end


  








  

    #each_decl  
  

  [ GitHub ]


  

  


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



def each_decl
  files = Set[]

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

    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"))

      Parser.parse_signature(buffer).each do |decl|
        yield decl, buffer, source, path
      end
    end
  end
end


  








  

    #each_dir  
  

  [ GitHub ]


  

  


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



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_file(path, immediate:, skip_hidden:, &block)  
  

  [ GitHub ]


  

  


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



def each_file(path, immediate:, skip_hidden:, &block)
  case
  when path.file?
    if path.extname == ".rbs" || immediate
      yield path
    end

  when path.directory?
    if path.basename.to_s.start_with?("_")
      if skip_hidden
        unless immediate
          return
        end
      end
    end

    path.children.sort.each do |child|
      each_file(child, immediate: false, skip_hidden: skip_hidden, &block)
    end
  end
end


  








  

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



  

    
  





  


  [ GitHub ]


  

  


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



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 93



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

  each_decl do |decl, buf, source, path|
    env << decl
    loaded << [decl, path, source]
  end

  loaded
end


  








  

    #resolve_dependencies(library:, version:)  
  

  [ GitHub ]


  

  


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



def resolve_dependencies(library:, version:)
  [Collection::Sources::Rubygems.instance, Collection::Sources::Stdlib.instance].each do |source|
    # @type var gem: { 'name' => String, 'version' => String? }
    gem = { 'name' => library, 'version' => version }
    next unless source.has?(gem)

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