Class: RBS::EnvironmentLoader

Inherits:
Object
  • Object
show all
Defined in:
lib/rbs/environment_loader.rb

Defined Under Namespace

Classes: UnknownLibraryError

Constant Summary collapse

Library = 
_ = Struct.new(:name, :version, keyword_init: true)
DEFAULT_CORE_ROOT = 
Pathname(_ = __dir__) + "../../core"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EnvironmentLoader.



37
38
39
40
41
42
43
 
# 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

Instance Attribute Details

#core_root ⇒ Object (readonly)

Returns the value of attribute core_root.



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

def core_root
  @core_root
end

#dirs ⇒ Object (readonly)

Returns the value of attribute dirs.



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

def dirs
  @dirs
end

#libs ⇒ Object (readonly)

Returns the value of attribute libs.



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

def libs
  @libs
end

#repository ⇒ Object (readonly)

Returns the value of attribute repository.



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

def repository
  @repository
end

Class Method Details

.gem_sig_path(name, version) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
 
# 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 Method Details

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# 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) ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# 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 ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# 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 ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# 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) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# 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

Returns:

  • (Boolean) 


85
86
87
88
89
90
91
 
# 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:) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
 
# 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:) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# 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