123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Source::Git

Relationships & Source Files
Namespace Children
Classes:
Exceptions:
Extension / Inclusion / Inheritance Descendants
Subclasses:
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Path, Source
Instance Chain:
self, Path, Source
Inherits: Bundler::Source::Path
Defined in: lib/bundler/source/git.rb,
lib/bundler/source/git/git_proxy.rb

Constant Summary

Path - Inherited

DEFAULT_GLOB

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Path - Inherited

Constructor Details

.new(options) ⇒ Git

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 12

def initialize(options)
  @options = options
  @checksum_store = Checksum::Store.new
  @glob = options["glob"] || DEFAULT_GLOB

  @allow_cached = false
  @allow_remote = false

  # Stringify options that could be set as symbols
  %w[ref branch tag revision].each {|k| options[k] = options[k].to_s if options[k] }

  @uri        = URINormalizer.normalize_suffix(options["uri"] || "", trailing_slash: false)
  @safe_uri   = URICredentialsFilter.credential_filtered_uri(@uri)
  @branch     = options["branch"]
  @ref        = options["ref"] || options["branch"] || options["tag"]
  @submodules = options["submodules"]
  @name       = options["name"]
  @version    = options["version"].to_s.strip.gsub("-", ".pre.")

  @copied     = false
  @local      = false
  @cached_app_cache_path = nil
end

Class Method Details

.from_lock(options)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 50

def self.from_lock(options)
  new(options.merge("uri" => options.delete("remote")))
end

Instance Attribute Details

#allow_git_ops?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 266

def allow_git_ops?
  @allow_remote || @allow_cached
end

#branch (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#default_glob?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 399

def default_glob?
  @glob == DEFAULT_GLOB
end

#glob (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#has_app_cache?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 363

def has_app_cache?
  locked_revision && super
end

#installed?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 379

def installed?
  git_proxy.installed_to?(install_path)
end

#local?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 270

def local?
  @local
end

#locked_revision_checked_out?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 375

def locked_revision_checked_out?
  locked_revision && locked_revision == revision && installed?
end

#options (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#ref (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#requires_checkout?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 371

def requires_checkout?
  allow_git_ops? && !local? && !locked_revision_checked_out?
end

#submodules (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#uri (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 10

attr_reader :uri, :ref, :branch, :options, :glob, :submodules

#use_app_cache?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 367

def use_app_cache?
  has_app_cache? && !local?
end

Instance Method Details

#==(other)

Alias for #eql?.

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 84

alias_method :==, :eql?

#app_cache_dirname

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 254

def app_cache_dirname
  "#{base_name}-#{shortref_for_path(locked_revision || revision)}"
end

#bare_repo?(path) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 457

def bare_repo?(path)
  File.exist?(path.join("objects")) && File.exist?(path.join("HEAD"))
end

#base_name (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 383

def base_name
  File.basename(uri.sub(%r{^(\w://)?([^/:]:)?(//\w*/)?(\w*/)*}, ""), ".git")
end

#cache(spec, custom_path = nil)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 231

def cache(spec, custom_path = nil)
  cache_to(custom_path, try_migrate: false)
end

#cache_path

This is the path which is going to contain a cache of the git repository. When using the same git repository across different projects, this cache will be shared. When using local git repos, this is set to the local repo.

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 246

def cache_path
  @cache_path ||= if Bundler.settings[:global_gem_cache]
    Bundler.user_cache
  else
    Bundler.bundle_path.join("cache", "bundler")
  end.join("git", git_scope)
end

#cache_to(custom_path, try_migrate: false) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 276

def cache_to(custom_path, try_migrate: false)
  return unless Bundler.settings[:cache_all]

  app_cache_path = app_cache_path(custom_path)

  # When several gems share a single git source, this is called once per
  # gem. Copying the repository is expensive for large repos, so skip it
  # if we already populated this cache during the same command.
  return if @cached_app_cache_path == app_cache_path

  migrate = try_migrate ? bare_repo?(app_cache_path) : false

  set_cache_path!(nil) if migrate

  return if cache_path == app_cache_path

  cached!
  FileUtils.rm_rf(app_cache_path)
  git_proxy.checkout if migrate || requires_checkout?
  git_proxy.copy_to(app_cache_path, @submodules)
  serialize_gemspecs_in(app_cache_path)

  @cached_app_cache_path = app_cache_path
end

#cached!

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 43

def cached!
  return if @allow_cached

  @local_specs = nil
  @allow_cached = true
end

#checkout (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 301

def checkout
  Bundler.ui.debug "  * Checking out revision: #{ref}"
  if use_app_cache? && !bare_repo?(app_cache_path)
    SharedHelpers.filesystem_access(install_path.dirname) do |p|
      FileUtils.mkdir_p(p)
    end
    FileUtils.cp_r("#{app_cache_path}/.", install_path)
  else
    if use_app_cache? && bare_repo?(app_cache_path)
      Bundler.ui.warn "Installing from cache in old \"bare repository\" format for compatibility. " \
                      "Please run `bundle cache` and commit the updated cache to migrate to the new format and get rid of this warning."
    end

    git_proxy.copy_to(install_path, submodules)
  end
  serialize_gemspecs_in(install_path)
  @copied = true
end

#current_branch

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 262

def current_branch
  git_proxy.current_branch
end

#eql?(other) ⇒ Boolean Also known as: #==

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 77

def eql?(other)
  other.is_a?(Git) && uri == other.uri && ref == other.ref &&
    branch == other.branch && name == other.name &&
    glob == other.glob &&
    submodules == other.submodules
end

#extension_cache_slug(_) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 449

def extension_cache_slug(_)
  extension_dir_name
end

#extension_dir_name

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 139

def extension_dir_name
  "#{base_name}-#{shortref_for_path(revision)}"
end

#fetch (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 425

def fetch
  git_proxy.checkout
rescue GitError => e
  Bundler.ui.warn "Using cached git data because of network errors:\n#{e}"
end

#git_proxy (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 421

def git_proxy
  @git_proxy ||= GitProxy.new(cache_path, uri, options, locked_revision, self)
end

#git_scope (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 445

def git_scope
  "#{base_name}-#{uri_hash}"
end

#glob_for_display (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 395

def glob_for_display
  default_glob? ? nil : "glob: #{@glob}"
end

#hash

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 73

def hash
  [self.class, uri, ref, branch, name, glob, submodules].hash
end

#humanized_ref (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 320

def humanized_ref
  if local?
    path
  elsif user_ref = options["ref"]
    if /\A[a-z0-9]{4,}\z/i.match?(ref)
      shortref_for_display(user_ref)
    else
      user_ref
    end
  elsif ref
    ref
  end
end

#identifier

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 105

def identifier
  uri_with_specifiers([humanized_ref, locked_revision, glob_for_display])
end

#include?(other) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 86

def include?(other)
  other.is_a?(Git) && uri == other.uri &&
    name == other.name &&
    glob == other.glob &&
    submodules == other.submodules
end

#install(spec, options = {})

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 207

def install(spec, options = {})
  return if Bundler.settings[:no_install]
  force = options[:force]

  print_using_message "Using #{version_message(spec, options[:previous_spec])} from #{self}"

  if (requires_checkout? && !@copied) || force
    checkout
  end

  generate_bin_options = { disable_extensions: !spec.missing_extensions?, build_args: options[:build_args] }
  generate_bin(spec, generate_bin_options)

  requires_checkout? ? spec.post_install_message : nil
end

#install_path Also known as: #path

This is the path which is going to contain a specific checkout of the git repository. When using local git repos, this is set to the local repo.

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 129

def install_path
  @install_path ||= begin
    git_scope = "#{base_name}-#{shortref_for_path(revision)}"

    Bundler.install_path.join(git_scope)
  end
end

#load_gemspec(file) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 434

def load_gemspec(file)
  # Expand the path before the chdir below, since resolving it inside the
  # block would base it on the gemspec directory instead of `root`.
  gemspec_path = Pathname.new(file).expand_path(root)
  SharedHelpers.chdir(gemspec_path.dirname.to_s) do
    stub = Gem::StubSpecification.gemspec_stub(gemspec_path.to_s, install_path.parent, install_path.parent)
    stub.full_gem_path = gemspec_path.dirname.to_s
    StubSpecification.from_stub(stub)
  end
end

#load_spec_files

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 235

def load_spec_files
  super
rescue PathError => e
  Bundler.ui.trace e
  raise GitError, "#{self} is not yet checked out. Run `bundle install` first."
end

#local_override!(path)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 150

def local_override!(path)
  return false if local?

  original_path = path
  path = Pathname.new(path)
  path = path.expand_path(Bundler.root) unless path.relative?

  unless branch || Bundler.settings[:disable_local_branch_check]
    raise GitError, "Cannot use local override for #{name} at #{path} because " \
      ":branch is not specified in Gemfile. Specify a branch or run " \
      "`bundle config unset local.#{override_for(original_path)}` to remove the local override"
  end

  unless path.exist?
    raise GitError, "Cannot use local override for #{name} because #{path} " \
      "does not exist. Run `bundle config unset local.#{override_for(original_path)}` to remove the local override"
  end

  @local = true
  set_paths!(path)

  # Create a new git proxy without the cached revision
  # so the Gemfile.lock always picks up the new revision.
  @git_proxy = GitProxy.new(path, uri, options)

  if current_branch != branch && !Bundler.settings[:disable_local_branch_check]
    raise GitError, "Local override for #{name} at #{path} is using branch " \
      "#{current_branch} but Gemfile specifies #{branch}"
  end

  changed = locked_revision && locked_revision != revision

  if !Bundler.settings[:disable_local_revision_check] && changed && !@unlocked && !git_proxy.contains?(locked_revision)
    raise GitError, "The Gemfile lock is pointing to revision #{shortref_for_display(locked_revision)} " \
      "but the current branch in your local override for #{name} does not contain such commit. " \
      "Please make sure your branch is up to date."
  end

  changed
end

#locked_revision (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 417

def locked_revision
  options["revision"]
end

#migrate_cache(custom_path = nil, local: false)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 223

def migrate_cache(custom_path = nil, local: false)
  if local
    cache_to(custom_path, try_migrate: false)
  else
    cache_to(custom_path, try_migrate: true)
  end
end

#name

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 122

def name
  File.basename(@uri, ".git")
end

#override_for(path) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 453

def override_for(path)
  Bundler.settings.local_overrides.key(path)
end

#path

Alias for #install_path.

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 137

alias_method :path, :install_path

#remote!

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 36

def remote!
  return if @allow_remote

  @local_specs = nil
  @allow_remote = true
end

#revision

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 258

def revision
  git_proxy.revision
end

#serialize_gemspecs_in(destination) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 334

def serialize_gemspecs_in(destination)
  destination = destination.expand_path(Bundler.root) if destination.relative?
  SharedHelpers.glob_files_in_dir(@glob, destination.to_s).each do |spec_path|
    # Evaluate gemspecs and cache the result. Gemspecs
    # in git might require git or other dependencies.
    # The gemspecs we cache should already be evaluated.
    spec = Bundler.load_gemspec(spec_path)
    next unless spec
    spec.installed_by_version = Gem::VERSION
    Bundler.rubygems.validate(spec)
    File.open(spec_path, "wb") {|file| file.write(spec.to_ruby) }
  end
end

#set_cache_path!(path) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 353

def set_cache_path!(path)
  @git_proxy = nil
  @cache_path = path
end

#set_install_path!(path) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 358

def set_install_path!(path)
  @local_specs = nil
  @install_path = path
end

#set_paths!(path) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 348

def set_paths!(path)
  set_cache_path!(path)
  set_install_path!(path)
end

#shortref_for_display(ref) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 387

def shortref_for_display(ref)
  ref[0..6]
end

#shortref_for_path(ref) (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 391

def shortref_for_path(ref)
  ref[0..11]
end

#specs

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 191

def specs(*)
  set_cache_path!(app_cache_path) if use_app_cache?

  if requires_checkout? && !@copied
    Plugin.hook(Plugin::Events::GIT_BEFORE_FETCH, self)
    begin
      fetch unless use_app_cache?
      checkout
    ensure
      Plugin.hook(Plugin::Events::GIT_AFTER_FETCH, self)
    end
  end

  local_specs
end

#to_gemfile

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 65

def to_gemfile
  specifiers = %w[ref branch tag submodules glob].map do |opt|
    "#{opt}: #{options[opt]}" if options[opt]
  end

  uri_with_specifiers(specifiers)
end

#to_lock

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 54

def to_lock
  out = String.new("GIT\n")
  out << "  remote: #{@uri}\n"
  out << "  revision: #{revision}\n"
  %w[ref branch tag submodules].each do |opt|
    out << "  #{opt}: #{options[opt]}\n" if options[opt]
  end
  out << "  glob: #{@glob}\n" unless default_glob?
  out << "  specs:\n"
end

#to_s

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 93

def to_s
  begin
    at = humanized_ref
    at = "#{at}@" if at
    rev = "at #{at}#{shortref_for_display(revision)}"
  rescue GitError
    ""
  end

  uri_with_specifiers([rev, glob_for_display])
end

#unlock!

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 143

def unlock!
  git_proxy.revision = nil
  options["revision"] = nil

  @unlocked = true
end

#uri_hash (private)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 403

def uri_hash
  if %r{^\w://(\w@)?}.match?(uri)
    # Downcase the domain component of the URI
    # and strip off a trailing slash, if one is present
    input = Gem::URI.parse(uri).normalize.to_s.sub(%r{/$}, "")
  else
    # If there is no URI scheme, assume it is an ssh/git URI
    input = uri
  end
  # We use SHA1 here for historical reason and to preserve backward compatibility.
  # But a transition to a simpler mangling algorithm would be welcome.
  Bundler::Digest.sha1(input)
end

#uri_with_specifiers(specifiers)

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 109

def uri_with_specifiers(specifiers)
  specifiers.compact!

  suffix =
    if specifiers.any?
      " (#{specifiers.join(", ")})"
    else
      ""
    end

  "#{@safe_uri}#{suffix}"
end

#validate_spec(_spec) (private)

no-op, since we validate when re-serializing the gemspec

[ GitHub ]

  
# File 'lib/bundler/source/git.rb', line 432

def validate_spec(_spec); end