Class: RBS::Collection::Sources::Local

Inherits:
Object
  • Object
show all
Includes:
Base
Defined in:
lib/rbs/collection/sources/local.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Base

#dependencies_of

Constructor Details

#initialize(path:, base_directory:) ⇒ Local

Returns a new instance of Local.



11
12
13
14
15
# File 'lib/rbs/collection/sources/local.rb', line 11

def initialize(path:, base_directory:)
  # TODO: resolve relative path from dir of rbs_collection.yaml
  @path = Pathname(path)
  @full_path = base_directory / path
end

Instance Attribute Details

#full_pathObject (readonly)

Returns the value of attribute full_path.



9
10
11
# File 'lib/rbs/collection/sources/local.rb', line 9

def full_path
  @full_path
end

#pathObject (readonly)

Returns the value of attribute path.



9
10
11
# File 'lib/rbs/collection/sources/local.rb', line 9

def path
  @path
end

Instance Method Details

#has?(name, version) ⇒ Boolean

Returns:

  • (Boolean)


17
18
19
20
21
22
23
# File 'lib/rbs/collection/sources/local.rb', line 17

def has?(name, version)
  if version
    @full_path.join(name, version).directory?
  else
    not versions(name).empty?
  end
end

#install(dest:, name:, version:, stdout:) ⇒ Object

Create a symlink instead of copying file to refer files in @path. By avoiding copying RBS files, the users do not need re-run ‘rbs collection install` when the RBS files are updated.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/rbs/collection/sources/local.rb', line 32

def install(dest:, name:, version:, stdout:)
  from = @full_path.join(name, version)
  gem_dir = dest.join(name, version)

  case
  when gem_dir.symlink? && gem_dir.readlink == from
    stdout.puts "Using #{name}:#{version} (#{from})"
  when gem_dir.symlink?
    prev = gem_dir.readlink
    gem_dir.unlink
    _install(from, dest.join(name, version))
    stdout.puts "Updating #{name}:#{version} to #{from} from #{prev}"
  when gem_dir.directory?
    # TODO: Show version of git source
    FileUtils.remove_entry_secure(gem_dir.to_s)
    _install(from, dest.join(name, version))
    stdout.puts "Updating #{name}:#{version} from git source"
  when !gem_dir.exist?
    _install(from, dest.join(name, version))
    stdout.puts "Installing #{name}:#{version} (#{from})"
  else
    raise
  end
end

#manifest_of(name, version) ⇒ Object



62
63
64
65
66
67
68
# File 'lib/rbs/collection/sources/local.rb', line 62

def manifest_of(name, version)
  gem_dir = @full_path.join(name, version)
  raise unless gem_dir.exist?

  manifest_path = gem_dir.join('manifest.yaml')
  YAML.safe_load(manifest_path.read) if manifest_path.exist?
end

#to_lockfileObject



70
71
72
73
74
75
# File 'lib/rbs/collection/sources/local.rb', line 70

def to_lockfile
  {
    'type' => 'local',
    'path' => @path.to_s,
  }
end

#versions(name) ⇒ Object



25
26
27
# File 'lib/rbs/collection/sources/local.rb', line 25

def versions(name)
  @full_path.join(name).glob('*/').map { |path| path.basename.to_s }
end