Class: Bundler::Installer
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/bundler/installer.rb |
Class Attribute Summary
Class Method Summary
-
.install(root, definition, options = {})
Begins the installation process for
::Bundler
. - .new(root, definition) ⇒ Installer constructor
Instance Attribute Summary
- #definition readonly
- #post_install_messages readonly
Instance Method Summary
- #generate_bundler_executable_stubs(spec, options = {})
- #generate_standalone_bundler_executable_stubs(spec, options = {})
-
#run(options)
Runs the install procedures for a specific Gemfile.
- #ensure_specs_are_compatible! private
-
#install(options)
private
the order that the resolver provides is significant, since dependencies might affect the installation of a gem.
- #installation_parallelization private
- #lock private
Constructor Details
.new(root, definition) ⇒ Installer
# File 'lib/bundler/installer.rb', line 28
def initialize(root, definition) @root = root @definition = definition @post_install_messages = {} end
Class Attribute Details
.ambiguous_gems (rw)
[ GitHub ]# File 'lib/bundler/installer.rb', line 11
attr_accessor :ambiguous_gems
Class Method Details
.install(root, definition, options = {})
# File 'lib/bundler/installer.rb', line 20
def self.install(root, definition, = {}) installer = new(root, definition) Plugin.hook(Plugin::Events::GEM_BEFORE_INSTALL_ALL, definition.dependencies) installer.run( ) Plugin.hook(Plugin::Events::GEM_AFTER_INSTALL_ALL, definition.dependencies) installer end
Instance Attribute Details
#definition (readonly)
[ GitHub ]# File 'lib/bundler/installer.rb', line 16
attr_reader :, :definition
#post_install_messages (readonly)
[ GitHub ]# File 'lib/bundler/installer.rb', line 16
attr_reader :, :definition
Instance Method Details
#ensure_specs_are_compatible! (private)
[ GitHub ]# File 'lib/bundler/installer.rb', line 212
def ensure_specs_are_compatible! @definition.specs.each do |spec| unless spec.matches_current_ruby? raise InstallError, "#{spec.full_name} requires ruby version #{spec.required_ruby_version}, " \ "which is incompatible with the current version, #{Gem.ruby_version}" end unless spec.matches_current_rubygems? raise InstallError, "#{spec.full_name} requires rubygems version #{spec.required_rubygems_version}, " \ "which is incompatible with the current version, #{Gem.rubygems_version}" end end end
#generate_bundler_executable_stubs(spec, options = {})
[ GitHub ]# File 'lib/bundler/installer.rb', line 93
def generate_bundler_executable_stubs(spec, = {}) if [:binstubs_cmd] && spec.executables.empty? = {} spec.runtime_dependencies.each do |dep| bins = @definition.specs[dep].first.executables [dep.name] = bins unless bins.empty? end if .any? Bundler.ui.warn "#{spec.name} has no executables, but you may want " \ "one from a gem it depends on." .each {|name, bins| Bundler.ui.warn " #{name} has: #{bins.join(", ")}" } else Bundler.ui.warn "There are no executables for the gem #{spec.name}." end return end # double-assignment to avoid warnings about variables that will be used by ERB bin_path = Bundler.bin_path bin_path = bin_path relative_gemfile_path = Bundler.default_gemfile.relative_path_from(bin_path) relative_gemfile_path = relative_gemfile_path ruby_command = Thor::Util.ruby_command ruby_command = ruby_command template_path = File. ("templates/Executable", __dir__) if spec.name == "bundler" template_path += ".bundler" spec.executables = %(bundle) end template = File.read(template_path) exists = [] spec.executables.each do |executable| binstub_path = "#{bin_path}/#{executable}" if File.exist?(binstub_path) && ! [:force] exists << executable next end mode = Gem.win_platform? ? "wb:UTF-8" : "w" require "erb" content = ERB.new(template, trim_mode: "-").result(binding) File.write(binstub_path, content, mode: mode, perm: 0o777 & ~File.umask) if Gem.win_platform? || [:all_platforms] prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n" File.write("#{binstub_path}.cmd", prefix + content, mode: mode) end end if [:binstubs_cmd] && exists.any? case exists.size when 1 Bundler.ui.warn "Skipped #{exists[0]} since it already exists." when 2 Bundler.ui.warn "Skipped #{exists.join(" and ")} since they already exist." else items = exists[0...-1].empty? ? nil : exists[0...-1].join(", ") skipped = [items, exists[-1]].compact.join(" and ") Bundler.ui.warn "Skipped #{skipped} since they already exist." end Bundler.ui.warn "If you want to overwrite skipped stubs, use --force." end end
#generate_standalone_bundler_executable_stubs(spec, options = {})
[ GitHub ]# File 'lib/bundler/installer.rb', line 158
def generate_standalone_bundler_executable_stubs(spec, = {}) # double-assignment to avoid warnings about variables that will be used by ERB bin_path = Bundler.bin_path unless path = Bundler.settings[:path] raise "Can't standalone without an explicit path set" end standalone_path = Bundler.root.join(path).relative_path_from(bin_path) standalone_path = standalone_path template = File.read(File. ("templates/Executable.standalone", __dir__)) ruby_command = Thor::Util.ruby_command ruby_command = ruby_command spec.executables.each do |executable| next if executable == "bundle" executable_path = Pathname(spec.full_gem_path).join(spec.bindir, executable).relative_path_from(bin_path) executable_path = executable_path mode = Gem.win_platform? ? "wb:UTF-8" : "w" require "erb" content = ERB.new(template, trim_mode: "-").result(binding) File.write("#{bin_path}/#{executable}", content, mode: mode, perm: 0o755) if Gem.win_platform? || [:all_platforms] prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n" File.write("#{bin_path}/#{executable}.cmd", prefix + content, mode: mode) end end end
#install(options) (private)
the order that the resolver provides is significant, since dependencies might affect the installation of a gem. that said, it’s a rare situation (other than rake), and parallel installation is SO MUCH FASTER. so we let people opt in.
# File 'lib/bundler/installer.rb', line 193
def install( ) standalone = [:standalone] force = [:force] local = [:local] jobs = installation_parallelization spec_installations = ParallelInstaller.call(self, @definition.specs, jobs, standalone, force, local: local) spec_installations.each do |installation| [installation.name] = installation. if installation. end end
#installation_parallelization (private)
[ GitHub ]#lock (private)
[ GitHub ]# File 'lib/bundler/installer.rb', line 225
def lock @definition.lock end
#run(options)
Runs the install procedures for a specific Gemfile.
Firstly, this method will check to see if Bundler.bundle_path exists and if not then ::Bundler
will create the directory. This is usually the same location as RubyGems which typically is the ~/.gem
directory unless other specified.
Secondly, it checks if ::Bundler
has been configured to be “frozen”. Frozen ensures that the Gemfile and the Gemfile.lock
file are matching. This stops a situation where a developer may update the Gemfile but may not run bundle install
, which leads to the Gemfile.lock
file not being correctly updated. If this file is not correctly updated then any other developer running bundle install
will potentially not install the correct gems.
Thirdly, ::Bundler
checks if there are any dependencies specified in the Gemfile. If there are no dependencies specified then ::Bundler
returns a warning message stating so and this method returns.
Fourthly, ::Bundler
checks if the Gemfile.lock
exists, and if so then proceeds to set up a definition based on the Gemfile and the Gemfile.lock
. During this step ::Bundler
will also download information about any new gems that are not in the Gemfile.lock
and resolve any dependencies if needed.
Fifthly, ::Bundler
resolves the dependencies either through a cache of gems or by remote. This then leads into the gems being installed, along with stubs for their executables, but only if the –binstubs option has been passed or ::Bundler
.options has been set earlier.
Sixthly, a new Gemfile.lock
is created from the installed gems to ensure that the next time that a user runs bundle install
they will receive any updates from this process.
Finally, if the user has specified the standalone flag, ::Bundler
will generate the needed require paths and save them in a setup.rb
file. See bundle standalone --help
for more information.
# File 'lib/bundler/installer.rb', line 68
def run( ) Bundler.create_bundle_path ProcessLock.lock do @definition.ensure_equivalent_gemfile_and_lockfile( [:deployment]) if @definition.dependencies.empty? Bundler.ui.warn "The Gemfile specifies no dependencies" lock return end if @definition.setup_domain!( ) ensure_specs_are_compatible! Bundler.load_plugins(@definition) end install( ) Gem::Specification.reset # invalidate gem specification cache so that installed gems are immediately available lock Standalone.new( [:standalone], @definition).generate if [:standalone] end end