module Bundler - bundler-1.15.4 Documentation

# module Bundler

Some versions of the Bundler 1.1 RC series introduced corrupted lockfiles. There were two major problems:

- multiple copies of the same GIT section appeared in the lockfile

- when this happened, those sections got multiple copies of gems in those sections.

As a result, Bundler 1.1 contains code that fixes the earlier corruption. We will remove this fix-up code in Bundler 1.2.

Ruby 1.9.3 and old RubyGems don't play nice with frozen version strings rubocop:disable MutableConstant

### Constants

Deprecate
FREEBSD
NULL
ORIGINAL_ENV
SUDO_MUTEX
VERSION

  We're doing this because we might write tests that deal with other versions of bundler and we are unsure how to handle this better.

WINDOWS
YamlLibrarySyntaxError

### Attributes

bundle_path[W]

### Public Class Methods

app_cache(custom_path = nil) click to toggle source

    # File lib/bundler.rb, line 224
    def app_cache(custom_path = nil)
      path = custom_path || root
      path.join(settings.app_cache_path)
    end

app_config_path() click to toggle source

    # File lib/bundler.rb, line 216
    def app_config_path
      if ENV["BUNDLE_APP_CONFIG"]
        Pathname.new(ENV["BUNDLE_APP_CONFIG"]).expand_path(root)
      else
        root.join(".bundle")
      end
    end

bin_path() click to toggle source

Returns absolute location of where binstubs are installed to.

    # File lib/bundler.rb, line 81
    def bin_path
      @bin_path ||= begin
        path = settings[:bin] || "bin"
        path = Pathname.new(path).expand_path(root).expand_path
        SharedHelpers.filesystem_access(path) {|p| FileUtils.mkdir_p(p) }
        path
      end
    end

bundle_path() click to toggle source

Returns absolute path of where gems are installed on the filesystem.

    # File lib/bundler.rb, line 76
    def bundle_path
      @bundle_path ||= Pathname.new(settings.path).expand_path(root)
    end

cache() click to toggle source

    # File lib/bundler.rb, line 198
    def cache
      bundle_path.join("cache/bundler")
    end

clean_env() click to toggle source

@deprecated Use `original_env` instead @return [Hash] Environment with all bundler-related variables removed

    # File lib/bundler.rb, line 258
    def clean_env
      Bundler::SharedHelpers.major_deprecation("`Bundler.clean_env` has weird edge cases, use `.original_env` instead")
      env = original_env

      if env.key?("BUNDLER_ORIG_MANPATH")
        env["MANPATH"] = env["BUNDLER_ORIG_MANPATH"]
      end

      env.delete_if {|k, _| k[0, 7] == "BUNDLE_" }

      if env.key?("RUBYOPT")
        env["RUBYOPT"] = env["RUBYOPT"].sub "-rbundler/setup", ""
      end

      if env.key?("RUBYLIB")
        rubylib = env["RUBYLIB"].split(File::PATH_SEPARATOR)
        rubylib.delete(File.expand_path("..", __FILE__))
        env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
      end

      env
    end

clean_exec(*args) click to toggle source

    # File lib/bundler.rb, line 293
    def clean_exec(*args)
      with_clean_env { Kernel.exec(*args) }
    end

clean_system(*args) click to toggle source

    # File lib/bundler.rb, line 289
    def clean_system(*args)
      with_clean_env { Kernel.system(*args) }
    end

clear_gemspec_cache() click to toggle source

    # File lib/bundler.rb, line 431
    def clear_gemspec_cache
      @gemspec_cache = {}
    end

configure() click to toggle source

    # File lib/bundler.rb, line 62
    def configure
      @configured ||= configure_gem_home_and_path
    end

current_ruby() click to toggle source

Returns current version of Ruby

@return [CurrentRuby] Current version of Ruby

    # File lib/bundler/current_ruby.rb, line 5
    def self.current_ruby
      @current_ruby ||= CurrentRuby.new
    end

default_bundle_dir() click to toggle source

    # File lib/bundler.rb, line 310
    def default_bundle_dir
      SharedHelpers.default_bundle_dir
    end

default_gemfile() click to toggle source

    # File lib/bundler.rb, line 302
    def default_gemfile
      SharedHelpers.default_gemfile
    end

default_lockfile() click to toggle source

    # File lib/bundler.rb, line 306
    def default_lockfile
      SharedHelpers.default_lockfile
    end

definition(unlock = nil) click to toggle source

Returns an instance of Bundler::Definition for given Gemfile and lockfile

@param unlock [Hash, Boolean, nil] Gems that have been requested

    to be updated or true if all gems should be updated

@return [Bundler::Definition]

    # File lib/bundler.rb, line 124
    def definition(unlock = nil)
      @definition = nil if unlock
      @definition ||= begin
        configure
        Definition.build(default_gemfile, default_lockfile, unlock)
      end
    end

environment() click to toggle source

    # File lib/bundler.rb, line 114
    def environment
      SharedHelpers.major_deprecation "Bundler.environment has been removed in favor of Bundler.load"
      load
    end

feature_flag() click to toggle source

    # File lib/bundler.rb, line 440
    def feature_flag
      @feature_flag ||= FeatureFlag.new(VERSION)
    end

git_present?() click to toggle source

    # File lib/bundler.rb, line 435
    def git_present?
      return @git_present if defined?(@git_present)
      @git_present = Bundler.which("git") || Bundler.which("git.exe")
    end

home() click to toggle source

    # File lib/bundler.rb, line 186
    def home
      bundle_path.join("bundler")
    end

install_path() click to toggle source

    # File lib/bundler.rb, line 190
    def install_path
      home.join("gems")
    end

load() click to toggle source

    # File lib/bundler.rb, line 110
    def load
      @load ||= Runtime.new(root, definition)
    end

load_gemspec(file, validate = false) click to toggle source

    # File lib/bundler.rb, line 404
    def load_gemspec(file, validate = false)
      @gemspec_cache ||= {}
      key = File.expand_path(file)
      @gemspec_cache[key] ||= load_gemspec_uncached(file, validate)
      # Protect against caching side-effected gemspecs by returning a
      # new instance each time.
      @gemspec_cache[key].dup if @gemspec_cache[key]
    end

load_gemspec_uncached(file, validate = false) click to toggle source

    # File lib/bundler.rb, line 413
    def load_gemspec_uncached(file, validate = false)
      path = Pathname.new(file)
      contents = path.read
      spec = if contents.start_with?("---") # YAML header
        eval_yaml_gemspec(path, contents)
      else
        # Eval the gemspec from its parent directory, because some gemspecs
        # depend on "./" relative paths.
        SharedHelpers.chdir(path.dirname.to_s) do
          eval_gemspec(path, contents)
        end
      end
      return unless spec
      spec.loaded_from = path.expand_path.to_s
      Bundler.rubygems.validate(spec) if validate
      spec
    end

load_marshal(data) click to toggle source

    # File lib/bundler.rb, line 398
    def load_marshal(data)
      Marshal.load(data)
    rescue => e
      raise MarshalError, "#{e.class}: #{e.message}"
    end

local_platform() click to toggle source

    # File lib/bundler.rb, line 297
    def local_platform
      return Gem::Platform::RUBY if settings[:force_ruby_platform]
      Gem::Platform.local
    end

locked_gems() click to toggle source

    # File lib/bundler.rb, line 132
    def locked_gems
      @locked_gems ||=
        if defined?(@definition) && @definition
          definition.locked_gems
        elsif Bundler.default_lockfile.file?
          lock = Bundler.read_file(Bundler.default_lockfile)
          LockfileParser.new(lock)
        end
    end

mkdir_p(path) click to toggle source

    # File lib/bundler.rb, line 347
    def mkdir_p(path)
      if requires_sudo?
        sudo "mkdir -p '#{path}'" unless File.exist?(path)
      else
        SharedHelpers.filesystem_access(path, :write) do |p|
          FileUtils.mkdir_p(p)
        end
      end
    end

original_env() click to toggle source

@return [Hash] Environment present before Bundler was activated

    # File lib/bundler.rb, line 252
    def original_env
      ORIGINAL_ENV.clone
    end

read_file(file) click to toggle source

    # File lib/bundler.rb, line 394
    def read_file(file)
      File.open(file, "rb", &:read)
    end

require(*groups) click to toggle source

    # File lib/bundler.rb, line 106
    def require(*groups)
      setup(*groups).require(*groups)
    end

require_thor_actions() click to toggle source

    # File lib/bundler/vendored_thor.rb, line 2
    def self.require_thor_actions
      Kernel.send(:require, "bundler/vendor/thor/lib/thor/actions")
    end

requires_sudo?() click to toggle source

    # File lib/bundler.rb, line 323
    def requires_sudo?
      return @requires_sudo if defined?(@requires_sudo_ran)

      sudo_present = which "sudo" if settings.allow_sudo?

      if sudo_present
        # the bundle path and subdirectories need to be writable for Rubygems
        # to be able to unpack and install gems without exploding
        path = bundle_path
        path = path.parent until path.exist?

        # bins are written to a different location on OS X
        bin_dir = Pathname.new(Bundler.system_bindir)
        bin_dir = bin_dir.parent until bin_dir.exist?

        # if any directory is not writable, we need sudo
        files = [path, bin_dir] | Dir[path.join("build_info/*").to_s] | Dir[path.join("*").to_s]
        sudo_needed = files.any? {|f| !File.writable?(f) }
      end

      @requires_sudo_ran = true
      @requires_sudo = settings.allow_sudo? && sudo_present && sudo_needed
    end

reset!() click to toggle source

    # File lib/bundler.rb, line 444
    def reset!
      reset_paths!
      Plugin.reset!
      reset_rubygems!
    end

reset_paths!() click to toggle source

    # File lib/bundler.rb, line 450
    def reset_paths!
      @root = nil
      @settings = nil
      @definition = nil
      @setup = nil
      @load = nil
      @locked_gems = nil
      @bundle_path = nil
      @bin_path = nil
      @user_home = nil
    end

reset_rubygems!() click to toggle source

    # File lib/bundler.rb, line 462
    def reset_rubygems!
      return unless defined?(@rubygems) && @rubygems
      rubygems.undo_replacements
      rubygems.reset
      @rubygems = nil
    end

rm_rf(path) click to toggle source

    # File lib/bundler.rb, line 233
        def rm_rf(path)
          FileUtils.remove_entry_secure(path) if path && File.exist?(path)
        rescue ArgumentError
          message = <<EOF
    It is a security vulnerability to allow your home directory to be world-writable, and bundler can not continue.
    You should probably consider fixing this issue by running `chmod o-w ~` on *nix.
    Please refer to http://ruby-doc.org/stdlib-2.1.2/libdoc/fileutils/rdoc/FileUtils.html#method-c-remove_entry_secure for details.
    EOF
          File.world_writable?(path) ? Bundler.ui.warn(message) : raise
          raise PathError, "Please fix the world-writable issue with your #{path} directory"
        end

root() click to toggle source

    # File lib/bundler.rb, line 206
    def root
      @root ||= begin
                  default_gemfile.dirname.expand_path
                rescue GemfileNotFound
                  bundle_dir = default_bundle_dir
                  raise GemfileNotFound, "Could not locate Gemfile or .bundle/ directory" unless bundle_dir
                  Pathname.new(File.expand_path("..", bundle_dir))
                end
    end

ruby_scope() click to toggle source

    # File lib/bundler.rb, line 142
    def ruby_scope
      "#{Bundler.rubygems.ruby_engine}/#{Bundler.rubygems.config_map[:ruby_version]}"
    end

rubygems() click to toggle source

    # File lib/bundler/rubygems_integration.rb, line 842
    def self.rubygems
      @rubygems ||= if RubygemsIntegration.provides?(">= 2.1.0")
        RubygemsIntegration::MoreFuture.new
      elsif RubygemsIntegration.provides?(">= 1.99.99")
        RubygemsIntegration::Future.new
      elsif RubygemsIntegration.provides?(">= 1.8.20")
        RubygemsIntegration::MoreModern.new
      elsif RubygemsIntegration.provides?(">= 1.8.5")
        RubygemsIntegration::Modern.new
      elsif RubygemsIntegration.provides?(">= 1.8.0")
        RubygemsIntegration::AlmostModern.new
      elsif RubygemsIntegration.provides?(">= 1.7.0")
        RubygemsIntegration::Transitional.new
      elsif RubygemsIntegration.provides?(">= 1.4.0")
        RubygemsIntegration::Legacy.new
      else # Rubygems 1.3.6 and 1.3.7
        RubygemsIntegration::Ancient.new
      end
    end

settings() click to toggle source

    # File lib/bundler.rb, line 245
    def settings
      @settings ||= Settings.new(app_config_path)
    rescue GemfileNotFound
      @settings = Settings.new(Pathname.new(".bundle").expand_path)
    end

setup(*groups) click to toggle source

    # File lib/bundler.rb, line 90
    def setup(*groups)
      # Return if all groups are already loaded
      return @setup if defined?(@setup) && @setup

      definition.validate_runtime!

      SharedHelpers.print_major_deprecations!

      if groups.empty?
        # Load all groups, but only once
        @setup = load.setup
      else
        load.setup(*groups)
      end
    end

specs_path() click to toggle source

    # File lib/bundler.rb, line 194
    def specs_path
      bundle_path.join("specifications")
    end

sudo(str) click to toggle source

    # File lib/bundler.rb, line 370
        def sudo(str)
          SUDO_MUTEX.synchronize do
            prompt = "\n\n" + "        Your user account isn't allowed to install to the system RubyGems.
            You can cancel this installation and run:

                bundle install --path vendor/bundle

            to install the gems into ./vendor/bundle/, or you can enter your password
            and install the bundled gems to RubyGems using sudo.

            Password:
    ".gsub(/^ {6}/, "").strip + " "

            unless @prompted_for_sudo ||= system(%Q(sudo -k -p "#{prompt}" true))
              raise SudoNotPermittedError,
                "Bundler requires sudo access to install at the moment. "              "Try installing again, granting Bundler sudo access when prompted, or installing into a different path."
            end

            %x`sudo -p "#{prompt}" #{str}`
          end
        end

system_bindir() click to toggle source

    # File lib/bundler.rb, line 314
    def system_bindir
      # Gem.bindir doesn't always return the location that Rubygems will install
      # system binaries. If you put '-n foo' in your .gemrc, Rubygems will
      # install binstubs there instead. Unfortunately, Rubygems doesn't expose
      # that directory at all, so rather than parse .gemrc ourselves, we allow
      # the directory to be set as well, via `bundle config bindir foo`.
      Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir
    end

tmp(name = Process.pid.to_s) click to toggle source

    # File lib/bundler.rb, line 229
    def tmp(name = Process.pid.to_s)
      Pathname.new(Dir.mktmpdir(["bundler", name]))
    end

tmp_home_path(login, warning) click to toggle source

    # File lib/bundler.rb, line 168
    def tmp_home_path(login, warning)
      login ||= "unknown"
      path = Pathname.new(Dir.tmpdir).join("bundler", "home")
      SharedHelpers.filesystem_access(path) do |tmp_home_path|
        unless tmp_home_path.exist?
          tmp_home_path.mkpath
          tmp_home_path.chmod(0o777)
        end
        tmp_home_path.join(login).tap(&:mkpath)
      end
    rescue => e
      raise e.exception("#{warning}\nBundler also failed to create a temporary home directory at `#{path}':\n#{e}")
    end

ui() click to toggle source

    # File lib/bundler.rb, line 66
    def ui
      (defined?(@ui) && @ui) || (self.ui = UI::Silent.new)
    end

ui=(ui) click to toggle source

    # File lib/bundler.rb, line 70
    def ui=(ui)
      Bundler.rubygems.ui = ui ? UI::RGProxy.new(ui) : nil
      @ui = ui
    end

user_bundle_path() click to toggle source

    # File lib/bundler.rb, line 182
    def user_bundle_path
      Pathname.new(user_home).join(".bundle")
    end

user_cache() click to toggle source

    # File lib/bundler.rb, line 202
    def user_cache
      user_bundle_path.join("cache")
    end

user_home() click to toggle source

    # File lib/bundler.rb, line 146
    def user_home
      @user_home ||= begin
        home = Bundler.rubygems.user_home

        warning = if home.nil?
          "Your home directory is not set."
        elsif !File.directory?(home)
          "`#{home}` is not a directory."
        elsif !File.writable?(home)
          "`#{home}` is not writable."
        end

        if warning
          user_home = tmp_home_path(Etc.getlogin, warning)
          Bundler.ui.warn "#{warning}\nBundler will use `#{user_home}' as your home directory temporarily.\n"
          user_home
        else
          Pathname.new(home)
        end
      end
    end

which(executable) click to toggle source

    # File lib/bundler.rb, line 357
    def which(executable)
      if File.file?(executable) && File.executable?(executable)
        executable
      elsif paths = ENV["PATH"]
        quote = '"'.freeze
        paths.split(File::PATH_SEPARATOR).find do |path|
          path = path[1..-2] if path.start_with?(quote) && path.end_with?(quote)
          executable_path = File.expand_path(executable, path)
          return executable_path if File.file?(executable_path) && File.executable?(executable_path)
        end
      end
    end

with_clean_env() { || ... } click to toggle source

    # File lib/bundler.rb, line 285
    def with_clean_env
      with_env(clean_env) { yield }
    end

with_friendly_errors() { || ... } click to toggle source

    # File lib/bundler/friendly_errors.rb, line 118
    def self.with_friendly_errors
      yield
    rescue Exception => e
      FriendlyErrors.log_error(e)
      exit FriendlyErrors.exit_status(e)
    end

with_original_env() { || ... } click to toggle source

    # File lib/bundler.rb, line 281
    def with_original_env
      with_env(original_env) { yield }
    end

### Private Class Methods

configure_gem_home() click to toggle source

    # File lib/bundler.rb, line 511
    def configure_gem_home
      # TODO: This mkdir_p is only needed for JRuby <= 1.5 and should go away (GH #602)
      begin
        FileUtils.mkdir_p bundle_path.to_s
      rescue
        nil
      end

      ENV["GEM_HOME"] = File.expand_path(bundle_path, root)
      Bundler.rubygems.clear_paths
    end

configure_gem_home_and_path() click to toggle source

    # File lib/bundler.rb, line 491
    def configure_gem_home_and_path
      configure_gem_path
      configure_gem_home
      bundle_path
    end

configure_gem_path(env = ENV, settings = self.settings) click to toggle source

    # File lib/bundler.rb, line 497
    def configure_gem_path(env = ENV, settings = self.settings)
      blank_home = env["GEM_HOME"].nil? || env["GEM_HOME"].empty?
      if settings[:disable_shared_gems]
        # this needs to be empty string to cause
        # PathSupport.split_gem_path to only load up the
        # Bundler --path setting as the GEM_PATH.
        env["GEM_PATH"] = ""
      elsif blank_home || Bundler.rubygems.gem_dir != bundle_path.to_s
        possibles = [Bundler.rubygems.gem_dir, Bundler.rubygems.gem_path]
        paths = possibles.flatten.compact.uniq.reject(&:empty?)
        env["GEM_PATH"] = paths.join(File::PATH_SEPARATOR)
      end
    end

eval_gemspec(path, contents) click to toggle source

    # File lib/bundler.rb, line 479
    def eval_gemspec(path, contents)
      eval(contents, TOPLEVEL_BINDING, path.expand_path.to_s)
    rescue ScriptError, StandardError => e
      msg = "There was an error while loading `#{path.basename}`: #{e.message}"

      if e.is_a?(LoadError) && RUBY_VERSION >= "1.9"
        msg += "\nDoes it try to require a relative path? That's been removed in Ruby 1.9"
      end

      raise GemspecError, Dsl::DSLError.new(msg, path, e.backtrace, contents)
    end

eval_yaml_gemspec(path, contents) click to toggle source

    # File lib/bundler.rb, line 471
    def eval_yaml_gemspec(path, contents)
      # If the YAML is invalid, Syck raises an ArgumentError, and Psych
      # raises a Psych::SyntaxError. See psyched_yaml.rb for more info.
      Gem::Specification.from_yaml(contents)
    rescue YamlLibrarySyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception
      eval_gemspec(path, contents)
    end

overwrite_loaded_gem_version() click to toggle source

    # File lib/bundler/version.rb, line 11
    def self.overwrite_loaded_gem_version
      begin
        require "rubygems"
      rescue LoadError
        return
      end
      return unless bundler_spec = Gem.loaded_specs["bundler"]
      return if bundler_spec.version == VERSION
      bundler_spec.version = Bundler::VERSION
    end

with_env(env) { || ... } click to toggle source

@param env [Hash]

    # File lib/bundler.rb, line 524
    def with_env(env)
      backup = ENV.to_hash
      ENV.replace(env)
      yield
    ensure
      ENV.replace(backup)
    end