module Bundler::SharedHelpers - bundler-1.15.4 Documentation

# module Bundler::SharedHelpers

### Public Instance Methods

chdir(dir, &blk) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 52
    def chdir(dir, &blk)
      Bundler.rubygems.ext_lock.synchronize do
        Dir.chdir dir, &blk
      end
    end

const_get_safely(constant_name, namespace) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 124
    def const_get_safely(constant_name, namespace)
      const_in_namespace = namespace.constants.include?(constant_name.to_s) ||
        namespace.constants.include?(constant_name.to_sym)
      return nil unless const_in_namespace
      namespace.const_get(constant_name)
    end

default_bundle_dir() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 36
    def default_bundle_dir
      bundle_dir = find_directory(".bundle")
      return nil unless bundle_dir

      bundle_dir = Pathname.new(bundle_dir)

      global_bundle_dir = Bundler.user_home.join(".bundle")
      return nil if bundle_dir == global_bundle_dir

      bundle_dir
    end

default_gemfile() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 21
    def default_gemfile
      gemfile = find_gemfile
      raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
      Pathname.new(gemfile).untaint
    end

default_lockfile() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 27
    def default_lockfile
      gemfile = default_gemfile

      case gemfile.basename.to_s
      when "gems.rb" then Pathname.new(gemfile.sub(/.rb$/, ".locked"))
      else Pathname.new("#{gemfile}.lock")
      end.untaint
    end

ensure_same_dependencies(spec, old_deps, new_deps) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 154
    def ensure_same_dependencies(spec, old_deps, new_deps)
      new_deps = new_deps.reject {|d| d.type == :development }
      old_deps = old_deps.reject {|d| d.type == :development }

      without_type = proc {|d| Gem::Dependency.new(d.name, d.requirements_list.sort) }
      new_deps.map!(&without_type)
      old_deps.map!(&without_type)

      extra_deps = new_deps - old_deps
      return if extra_deps.empty?

      Bundler.ui.debug "#{spec.full_name} from #{spec.remote} has either corrupted API or lockfile dependencies"          " (was expecting #{old_deps.map(&:to_s)}, but the real spec has #{new_deps.map(&:to_s)})"
      raise APIResponseMismatchError,
        "Downloading #{spec.full_name} revealed dependencies not in the API or the lockfile (#{extra_deps.join(", ")})."          "\nEither installing with `--full-index` or running `bundle update #{spec.name}` should fix the problem."
    end

filesystem_access(path, action = :write, &block) click to toggle source

Rescues permissions errors raised by file system operations (ie. Errno:EACCESS, Errno::EAGAIN) and raises more friendly errors instead.

@param path [String] the path that the action will be attempted to @param action [Symbol, to_s] the type of operation that will be

    performed. For example: :write, :read, :exec

@yield path

@raise [Bundler::PermissionError] if Errno:EACCES is raised in the

    given block

@raise [Bundler::TemporaryResourceError] if Errno:EAGAIN is raised in the

    given block

@example

    filesystem_access("vendor/cache", :write) do
      FileUtils.mkdir_p("vendor/cache")
    end

@see {Bundler::PermissionError}

    # File lib/bundler/shared_helpers.rb, line 104
    def filesystem_access(path, action = :write, &block)
      # Use block.call instead of yield because of a bug in Ruby 2.2.2
      # See https://github.com/bundler/bundler/issues/5341 for details
      block.call(path.dup.untaint)
    rescue Errno::EACCES
      raise PermissionError.new(path, action)
    rescue Errno::EAGAIN
      raise TemporaryResourceError.new(path, action)
    rescue Errno::EPROTO
      raise VirtualProtocolError.new
    rescue Errno::ENOSPC
      raise NoSpaceOnDeviceError.new(path, action)
    rescue *[const_get_safely(:ENOTSUP, Errno)].compact
      raise OperationNotSupportedError.new(path, action)
    rescue Errno::EEXIST, Errno::ENOENT
      raise
    rescue SystemCallError => e
      raise GenericSystemCallError.new(e, "There was an error accessing `#{path}`.")
    end

in_bundle?() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 48
    def in_bundle?
      find_gemfile
    end

major_deprecation(message) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 131
    def major_deprecation(message)
      return unless prints_major_deprecations?
      @major_deprecation_ui ||= Bundler::UI::Shell.new("no-color" => true)
      ui = Bundler.ui.is_a?(@major_deprecation_ui.class) ? Bundler.ui : @major_deprecation_ui
      ui.warn("[DEPRECATED FOR #{Bundler::VERSION.split(".").first.to_i + 1}.0] #{message}")
    end

print_major_deprecations!() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 138
    def print_major_deprecations!
      deprecate_gemfile(find_gemfile) if find_gemfile == find_file("Gemfile")
      if RUBY_VERSION < "2"
        major_deprecation("Bundler will only support ruby >= 2.0, you are running #{RUBY_VERSION}")
      end
      return if Bundler.rubygems.provides?(">= 2")
      major_deprecation("Bundler will only support rubygems >= 2.0, you are running #{Bundler.rubygems.version}")
    end

pwd() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 58
    def pwd
      Bundler.rubygems.ext_lock.synchronize do
        Pathname.pwd
      end
    end

set_bundle_environment() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 77
    def set_bundle_environment
      set_bundle_variables
      set_path
      set_rubyopt
      set_rubylib
    end

trap(signal, override = false, &block) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 147
    def trap(signal, override = false, &block)
      prior = Signal.trap(signal) do
        block.call
        prior.call unless override
      end
    end

with_clean_git_env(&block) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 64
    def with_clean_git_env(&block)
      keys    = %w(GIT_DIR GIT_WORK_TREE)
      old_env = keys.inject({}) do |h, k|
        h.update(k => ENV[k])
      end

      keys.each {|key| ENV.delete(key) }

      block.call
    ensure
      keys.each {|key| ENV[key] = old_env[key] }
    end

### Private Instance Methods

bundler_ruby_lib() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 254
    def bundler_ruby_lib
      File.expand_path("../..", __FILE__)
    end

clean_load_path() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 258
    def clean_load_path
      # handle 1.9 where system gems are always on the load path
      return unless defined?(::Gem)

      bundler_lib = bundler_ruby_lib

      loaded_gem_paths = Bundler.rubygems.loaded_gem_paths

      $LOAD_PATH.reject! do |p|
        next if File.expand_path(p).start_with?(bundler_lib)
        loaded_gem_paths.delete(p)
      end
      $LOAD_PATH.uniq!
    end

deprecate_gemfile(gemfile) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 282
    def deprecate_gemfile(gemfile)
      return unless gemfile && File.basename(gemfile) == "Gemfile"
      Bundler::SharedHelpers.major_deprecation          "gems.rb and gems.locked will be preferred to Gemfile and Gemfile.lock."
    end

find_directory(*names) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 197
    def find_directory(*names)
      search_up(*names) do |dirname|
        return dirname if File.directory?(dirname)
      end
    end

find_file(*names) click to toggle source

    # File lib/bundler/shared_helpers.rb, line 191
    def find_file(*names)
      search_up(*names) do |filename|
        return filename if File.file?(filename)
      end
    end

find_gemfile() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 185
    def find_gemfile
      given = ENV["BUNDLE_GEMFILE"]
      return given if given && !given.empty?
      find_file("Gemfile", "gems.rb")
    end

prints_major_deprecations?() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 273
    def prints_major_deprecations?
      require "bundler"
      deprecation_release = Bundler::VERSION.split(".").drop(1).include?("99")
      return false if !deprecation_release && !Bundler.settings[:major_deprecations]
      require "bundler/deprecate"
      return false if Bundler::Deprecate.skip
      true
    end

search_up(*names) { |filename| ... } click to toggle source

    # File lib/bundler/shared_helpers.rb, line 203
    def search_up(*names)
      previous = nil
      current  = File.expand_path(SharedHelpers.pwd).untaint

      until !File.directory?(current) || current == previous
        if ENV["BUNDLE_SPEC_RUN"]
          # avoid stepping above the tmp directory when testing
          return nil if File.file?(File.join(current, "bundler.gemspec"))
        end

        names.each do |name|
          filename = File.join(current, name)
          yield filename
        end
        previous = current
        current = File.expand_path("..", current)
      end
    end

set_bundle_variables() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 222
    def set_bundle_variables
      begin
        ENV["BUNDLE_BIN_PATH"] = Bundler.rubygems.bin_path("bundler", "bundle", VERSION)
      rescue Gem::GemNotFoundException
        ENV["BUNDLE_BIN_PATH"] = File.expand_path("../../../exe/bundle", __FILE__)
      end

      # Set BUNDLE_GEMFILE
      ENV["BUNDLE_GEMFILE"] = find_gemfile.to_s
      ENV["BUNDLER_VERSION"] = Bundler::VERSION
    end

set_path() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 234
    def set_path
      validate_bundle_path
      paths = (ENV["PATH"] || "").split(File::PATH_SEPARATOR)
      paths.unshift "#{Bundler.bundle_path}/bin"
      ENV["PATH"] = paths.uniq.join(File::PATH_SEPARATOR)
    end

set_rubylib() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 248
    def set_rubylib
      rubylib = (ENV["RUBYLIB"] || "").split(File::PATH_SEPARATOR)
      rubylib.unshift bundler_ruby_lib
      ENV["RUBYLIB"] = rubylib.uniq.join(File::PATH_SEPARATOR)
    end

set_rubyopt() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 241
    def set_rubyopt
      rubyopt = [ENV["RUBYOPT"]].compact
      return if !rubyopt.empty? && rubyopt.first =~ %r{-rbundler/setup}
      rubyopt.unshift %Q(-rbundler/setup)
      ENV["RUBYOPT"] = rubyopt.join(" ")
    end

validate_bundle_path() click to toggle source

    # File lib/bundler/shared_helpers.rb, line 174
    def validate_bundle_path
      return unless Bundler.bundle_path.to_s.include?(File::PATH_SEPARATOR)
      message = "Your bundle path contains a '#{File::PATH_SEPARATOR}', "                  "which is the path separator for your system. Bundler cannot "                  "function correctly when the Bundle path contains the "                  "system's PATH separator. Please change your "                  "bundle path to not include '#{File::PATH_SEPARATOR}'."                  "\nYour current bundle path is '#{Bundler.bundle_path}'."
      raise Bundler::PathError, message
    end