Class: Bundler::RubyGemsGemInstaller

Inherits:
Gem::Installer
  • Object
show all
Defined in:
lib/bundler/rubygems_gem_installer.rb

Direct Known Subclasses

Source::Path::Installer

Constant Summary collapse

MAX_JOBS_PER_GEM =

Cap how many jobserver slots a single gem’s ‘make` may grab so that one gem with many recipes doesn’t starve the others sharing the pool. Beyond a handful of jobs the extra parallelism rarely pays off in practice.

3

Instance Method Summary collapse

Instance Method Details

#build_extensions ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 117

def build_extensions
  @jobserver_tokens = +""
  @jobserver_read_io, @jobserver_write_io = connect_to_jobserver

  extension_cache_path = options[:bundler_extension_cache_path]
  extension_dir = spec.extension_dir
  unless extension_cache_path && extension_dir
    prepare_extension_build(extension_dir)
    return super
  end

  build_complete = SharedHelpers.filesystem_access(extension_cache_path.join("gem.build_complete"), :read, &:file?)
  if build_complete && !options[:force]
    SharedHelpers.filesystem_access(File.dirname(extension_dir)) do |p|
      FileUtils.mkpath p
    end
    SharedHelpers.filesystem_access(extension_cache_path) do
      FileUtils.cp_r extension_cache_path, extension_dir
    end
  else
    prepare_extension_build(extension_dir)
    super
    SharedHelpers.filesystem_access(extension_cache_path.parent, &:mkpath)
    SharedHelpers.filesystem_access(extension_cache_path) do
      FileUtils.cp_r extension_dir, extension_cache_path
    end
  end
ensure
  unless @jobserver_tokens.empty?
    @jobserver_write_io.write(@jobserver_tokens)
    @jobserver_write_io.flush
  end
end

#build_jobs ⇒ Object 



108
109
110
111
112
113
114
115
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 108

def build_jobs
  @jobserver_read_io&.read_nonblock(MAX_JOBS_PER_GEM, @jobserver_tokens)
  acquired_jobs = @jobserver_tokens.empty? ? nil : @jobserver_tokens.size

  acquired_jobs || Bundler.settings[:jobs] || super
rescue IO::WaitReadable, EOFError
  1
end

#check_executable_overwrite(filename) ⇒ Object 



12
13
14
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 12

def check_executable_overwrite(filename)
  # Bundler needs to install gems regardless of binstub overwriting
end

#ensure_writable_dir(dir) ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 68

def ensure_writable_dir(dir)
  super
rescue Gem::FilePermissionError
  # Ignore permission checks in RubyGems. Instead, go on, and try to write
  # for real. We properly handle permission errors when they happen.
  nil
end

#gem_checksum ⇒ Object 



159
160
161
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 159

def gem_checksum
  Checksum.from_gem_package(@package)
end

#generate_bin_script(filename, bindir) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 89

def generate_bin_script(filename, bindir)
  bin_script_path = File.join bindir, formatted_program_filename(filename)

  Gem.open_file_with_lock(bin_script_path) do
    require "fileutils"
    FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers

    File.open(bin_script_path, "wb", 0o755) do |file|
      file.write app_script_text(filename)
      file.chmod(options[:prog_mode] || 0o755)
    end
  end

  verbose bin_script_path

  generate_windows_script filename, bindir
end

#generate_plugins ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 76

def generate_plugins
  return unless Gem::Installer.method_defined?(:generate_plugins, false)

  ensure_writable_dir @plugins_dir

  if spec.plugins.empty?
    remove_plugins_for(spec, @plugins_dir)
  else
    regenerate_plugins_for(spec, @plugins_dir)
  end
end

#install ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 16

def install
  pre_install_checks

  run_pre_install_hooks

  spec.loaded_from = spec_file

  # Completely remove any previous gem files
  strict_rm_rf gem_dir
  strict_rm_rf spec.extension_dir

  SharedHelpers.filesystem_access(gem_dir, :create) do
    FileUtils.mkdir_p gem_dir
  end

  SharedHelpers.filesystem_access(gem_dir, :write) do
    extract_files
  end

  build_extensions if spec.extensions.any?
  write_build_info_file
  run_post_build_hooks

  SharedHelpers.filesystem_access(bin_dir, :write) do
    generate_bin
  end

  generate_plugins

  write_spec

  SharedHelpers.filesystem_access("#{gem_home}/cache", :write) do
    write_cache_file
  end

  say spec.post_install_message unless spec.post_install_message.nil?

  run_post_install_hooks

  spec
end

#pre_install_checks ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 59

def pre_install_checks
  super
rescue Gem::FilePermissionError
  # Ignore permission checks in RubyGems. Instead, go on, and try to write
  # for real. We properly handle permission errors when they happen.
  nil
end

#spec ⇒ Object 



151
152
153
154
155
156
157
 
# File 'lib/bundler/rubygems_gem_installer.rb', line 151

def spec
  if Bundler.rubygems.provides?("< 3.3.12") # RubyGems implementation rescues and re-raises errors before 3.3.12 and we don't want that
    @package.spec
  else
    super
  end
end