Begins the installation process for Bundler. For more information see the run method on this class.
# File lib/bundler/installer.rb, line 21 def self.install(root, definition, options = {}) installer = new(root, definition) Plugin.hook("before-install-all", definition.dependencies) installer.run(options) installer end
# File lib/bundler/installer.rb, line 28 def initialize(root, definition) @root = root @definition = definition @post_install_messages = {} end
# File lib/bundler/installer.rb, line 86 def generate_bundler_executable_stubs(spec, options = {}) if options[:binstubs_cmd] && spec.executables.empty? options = {} spec.runtime_dependencies.each do |dep| bins = @definition.specs[dep].first.executables options[dep.name] = bins unless bins.empty? end if options.any? Bundler.ui.warn "#{spec.name} has no executables, but you may want " "one from a gem it depends on." options.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 = bin_path = Bundler.bin_path template = template = File.read(File.expand_path("../templates/Executable", __FILE__)) relative_gemfile_path = relative_gemfile_path = Bundler.default_gemfile.relative_path_from(bin_path) ruby_command = ruby_command = Thor::Util.ruby_command exists = [] spec.executables.each do |executable| next if executable == "bundle" binstub_path = "#{bin_path}/#{executable}" if File.exist?(binstub_path) && !options[:force] exists << executable next end File.open(binstub_path, "w", 0o777 & ~File.umask) do |f| f.puts ERB.new(template, nil, "-").result(binding) end end if options[: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
# File lib/bundler/installer.rb, line 139 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 standalone_path = standalone_path = Bundler.root.join(Bundler.settings[:path]).relative_path_from(bin_path) template = File.read(File.expand_path("../templates/Executable.standalone", __FILE__)) ruby_command = ruby_command = Thor::Util.ruby_command spec.executables.each do |executable| next if executable == "bundle" executable_path = executable_path = Pathname(spec.full_gem_path).join(spec.bindir, executable).relative_path_from(bin_path) File.open "#{bin_path}/#{executable}", "w", 0o755 do |f| f.puts ERB.new(template, nil, "-").result(binding) end end end
Runs the install procedures for a specific Gemfile.
Firstly, this method will check to see if Bundler.bundle_path exists and if not then will create it. This is usually the location of gems on the system, be it RVM or at a system path.
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 using Bundler::Environment#dependencies. If there are no dependencies specified then Bundler returns a warning message stating so and this method returns.
Fourthly, Bundler checks if the default lockfile (Gemfile.lock) exists, and if so then proceeds to set up a defintion based on the default gemfile (Gemfile) and the default lock file (Gemfile.lock). However, this is not the case if the platform is different to that which is specified in Gemfile.lock, or if there are any missing specs for the gems.
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: TODO add documentation for how the standalone process works.
# File lib/bundler/installer.rb, line 65 def run(options) create_bundle_path if Bundler.settings[:frozen] @definition.ensure_equivalent_gemfile_and_lockfile(options[:deployment]) end if @definition.dependencies.empty? Bundler.ui.warn "The Gemfile specifies no dependencies" lock return end resolve_if_need(options) ensure_specs_are_compatible! install(options) lock unless Bundler.settings[:frozen] Standalone.new(options[:standalone], @definition).generate if options[:standalone] end
# File lib/bundler/installer.rb, line 186 def can_install_in_parallel? if Bundler.rubygems.provides?(">= 2.1.0") true else Bundler.ui.warn "Rubygems #{Gem::VERSION} is not threadsafe, so your " "gems will be installed one at a time. Upgrade to Rubygems 2.1.0 " "or higher to enable parallel gem installation." false end end
# File lib/bundler/installer.rb, line 204 def create_bundle_path SharedHelpers.filesystem_access(Bundler.bundle_path.to_s) do |p| Bundler.mkdir_p(p) end unless Bundler.bundle_path.exist? rescue Errno::EEXIST raise PathError, "Could not install to path `#{Bundler.settings[:path]}` " "because of an invalid symlink. Remove the symlink so the directory can be created." end
# File lib/bundler/installer.rb, line 168 def ensure_specs_are_compatible! system_ruby = Bundler::RubyVersion.system rubygems_version = Gem::Version.create(Gem::VERSION) @definition.specs.each do |spec| if required_ruby_version = spec.required_ruby_version unless required_ruby_version.satisfied_by?(system_ruby.gem_version) raise InstallError, "#{spec.full_name} requires ruby version #{required_ruby_version}, " "which is incompatible with the current version, #{system_ruby}" end end next unless required_rubygems_version = spec.required_rubygems_version unless required_rubygems_version.satisfied_by?(rubygems_version) raise InstallError, "#{spec.full_name} requires rubygems version #{required_rubygems_version}, " "which is incompatible with the current version, #{rubygems_version}" end end end
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 161 def install(options) force = options["force"] jobs = 1 jobs = [Bundler.settings[:jobs].to_i - 1, 1].max if can_install_in_parallel? install_in_parallel jobs, options[:standalone], force end
# File lib/bundler/installer.rb, line 197 def install_in_parallel(size, standalone, force = false) spec_installations = ParallelInstaller.call(self, @definition.specs, size, standalone, force) spec_installations.each do |installation| post_install_messages[installation.name] = installation.post_install_message if installation.has_post_install_message? end end
# File lib/bundler/installer.rb, line 228 def lock(opts = {}) @definition.lock(Bundler.default_lockfile, opts[:preserve_unknown_sections]) end
# File lib/bundler/installer.rb, line 213 def resolve_if_need(options) if Bundler.default_lockfile.exist? && !options["update"] local = Bundler.ui.silence do begin tmpdef = Definition.build(Bundler.default_gemfile, Bundler.default_lockfile, nil) true unless tmpdef.new_platform? || tmpdef.missing_dependencies.any? rescue BundlerError end end end return if local options["local"] ? @definition.resolve_with_cache! : @definition.resolve_remotely! end