123456789_123456789_123456789_123456789_123456789_

Class: Bundler::SelfManager

Relationships & Source Files
Inherits: Object
Defined in: lib/bundler/self_manager.rb

Overview

This class handles installing and switching to the version of bundler needed by an application.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#autoswitching_applies?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 107

def autoswitching_applies?
  ENV["BUNDLER_VERSION"].nil? &&
    Bundler.rubygems.supports_bundler_trampolining? &&
    ruby_can_restart_with_same_arguments? &&
    SharedHelpers.in_bundle? &&
    lockfile_version
end

#installed?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 178

def installed?
  Bundler.configure

  Bundler.rubygems.find_bundler(restart_version.to_s)
end

#needs_switching?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 99

def needs_switching?
  autoswitching_applies? &&
    Bundler.settings[:version] != "system" &&
    released?(restart_version) &&
    !running?(restart_version) &&
    !updating?
end

#ruby_can_restart_with_same_arguments?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 170

def ruby_can_restart_with_same_arguments?
  $PROGRAM_NAME != "-e"
end

#updating?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 174

def updating?
  "update".start_with?(ARGV.first || " ") && ARGV[1..-1].any? {|a| a.start_with?("--bundler") }
end

Instance Method Details

#current_version (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 184

def current_version
  @current_version ||= Gem::Version.new(Bundler::VERSION)
end

#find_latest_matching_spec(requirement) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 144

def find_latest_matching_spec(requirement)
  local_result = find_latest_matching_spec_from_collection(local_specs, requirement)
  return local_result if local_result && requirement.specific?

  remote_result = find_latest_matching_spec_from_collection(remote_specs, requirement)
  return remote_result if local_result.nil?

  [local_result, remote_result].max
end

#find_latest_matching_spec_from_collection(specs, requirement) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 154

def find_latest_matching_spec_from_collection(specs, requirement)
  specs.sort.reverse_each.find {|spec| requirement.satisfied_by?(spec.version) }
end

#install(spec) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 65

def install(spec)
  spec.source.install(spec)
end

#install_and_restart_with(version) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 48

def install_and_restart_with(version)
  requirement = Gem::Requirement.new(version)
  spec = find_latest_matching_spec(requirement)

  if spec.nil?
    Bundler.ui.warn "Your lockfile is locked to a version of bundler (#{lockfile_version}) that doesn't exist at https://rubygems.org/. Going on using #{current_version}"
    return
  end

  install(spec)
rescue StandardError => e
  Bundler.ui.trace e
  Bundler.ui.warn "There was an error installing the locked bundler version (#{lockfile_version}), rerun with the `--verbose` flag for more details. Going on using bundler #{current_version}."
else
  restart_with(version)
end

#install_locked_bundler_and_restart_with_it_if_needed

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 15

def install_locked_bundler_and_restart_with_it_if_needed
  return unless needs_switching?

  if restart_version == lockfile_version
    Bundler.ui.info \
      "Bundler #{current_version} is running, but your lockfile was generated with #{lockfile_version}. " \
      "Installing Bundler #{lockfile_version} and restarting using that version."
  else
    Bundler.ui.info \
      "Bundler #{current_version} is running, but your configuration was #{restart_version}. " \
      "Installing Bundler #{restart_version} and restarting using that version."
  end

  install_and_restart_with(restart_version)
end

#local_specs (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 131

def local_specs
  @local_specs ||= Bundler::Source::Rubygems.new("allow_local" => true).specs.select {|spec| spec.name == "bundler" }
end

#lockfile_version (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 188

def lockfile_version
  return @lockfile_version if defined?(@lockfile_version)

  parsed_version = Bundler::LockfileParser.bundled_with
  @lockfile_version = parsed_version ? Gem::Version.new(parsed_version) : nil
rescue ArgumentError
  @lockfile_version = nil
end

#released?(version) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 166

def released?(version)
  !version.to_s.end_with?(".dev")
end

#remote_specs (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 135

def remote_specs
  @remote_specs ||= begin
    source = Bundler::Source::Rubygems.new("remotes" => "https://rubygems.org")
    source.remote!
    source.add_dependency_names("bundler")
    source.specs.select(&:matches_current_metadata?)
  end
end

#resolve_update_version_from(target) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 115

def resolve_update_version_from(target)
  requirement = Gem::Requirement.new(target)
  update_candidate = find_latest_matching_spec(requirement)

  if update_candidate.nil?
    raise InvalidOption, "The `bundle update --bundler` target version (#{target}) does not exist"
  end

  resolved_version = update_candidate.version
  needs_update = requirement.specific? ? !running?(resolved_version) : running_older_than?(resolved_version)

  return unless needs_update

  update_candidate
end

#restart_version (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 197

def restart_version
  return @restart_version if defined?(@restart_version)
  # BUNDLE_VERSION=x.y.z
  @restart_version = Gem::Version.new(Bundler.settings[:version])
rescue ArgumentError
  # BUNDLE_VERSION=lockfile
  @restart_version = lockfile_version
end

#restart_with(version) (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 69

def restart_with(version)
  configured_gem_home = ENV["GEM_HOME"]
  configured_gem_path = ENV["GEM_PATH"]

  # Bundler specs need some stuff to be required before Bundler starts
  # running, for example, for faking the compact index API. However, these
  # flags are lost when we reexec to a different version of Bundler. In the
  # future, we may be able to properly reconstruct the original Ruby
  # invocation (see https://bugs.ruby-lang.org/issues/6648), but for now
  # there's no way to do it, so we need to be explicit about how to re-exec.
  # This may be a feature end users request at some point, but maybe by that
  # time, we have builtin tools to do. So for now, we use an undocumented
  # ENV variable only for our specs.
  bundler_spec_original_cmd = ENV["BUNDLER_SPEC_ORIGINAL_CMD"]
  if bundler_spec_original_cmd
    require "shellwords"
    cmd = [*Shellwords.shellsplit(bundler_spec_original_cmd), *ARGV]
  else
    cmd = [$PROGRAM_NAME, *ARGV]
    cmd.unshift(Gem.ruby) unless File.executable?($PROGRAM_NAME)
  end

  Bundler.with_original_env do
    Kernel.exec(
      { "GEM_HOME" => configured_gem_home, "GEM_PATH" => configured_gem_path, "BUNDLER_VERSION" => version.to_s },
      *cmd
    )
  end
end

#restart_with_locked_bundler_if_needed

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 9

def restart_with_locked_bundler_if_needed
  return unless needs_switching? && installed?

  restart_with(restart_version)
end

#running?(version) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 158

def running?(version)
  version == current_version
end

#running_older_than?(version) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 162

def running_older_than?(version)
  current_version < version
end

#update_bundler_and_restart_with_it_if_needed(target)

[ GitHub ]

  
# File 'lib/bundler/self_manager.rb', line 31

def update_bundler_and_restart_with_it_if_needed(target)
  return unless autoswitching_applies?

  spec = resolve_update_version_from(target)
  return unless spec

  version = spec.version

  Bundler.ui.info "Updating bundler to #{version}."

  install(spec)

  restart_with(version)
end