Class: Bundler::Source::Git

### Home Classes Methods

### In Files

- lib/bundler/source/git/git_proxy.rb
- lib/bundler/source/git.rb

### Parent

Bundler::Source::Path

### Namespace

- CLASS Bundler::Source::Git::GitProxy

### Methods

- ::from_lock
- ::new
- #==
- #app_cache_dirname
- #cache
- #cache_path
- #eql?
- #install
- #install_path
- #load_spec_files
- #local_override!
- #name
- #path
- #specs
- #to_lock
- #to_s
- #unlock!

### Files

- bundle
- bundle-config
- bundle-config.txt
- bundle-exec
- bundle-exec.txt
- bundle-install
- bundle-install.txt
- bundle-package
- bundle-package.txt
- bundle-platform
- bundle-platform.txt
- bundle-update
- bundle-update.txt
- bundle.txt
- gemfile.5.txt
- Executable
- Gemfile

### Class/Module Index

Quicksearch

- Bundler
- Bundler::BundlerError
- Bundler::CLI
- Bundler::Definition
- Bundler::DepProxy
- Bundler::Dependency
- Bundler::Deployment
- Bundler::Deprecate
- Bundler::DeprecatedError
- Bundler::Dsl
- Bundler::EndpointSpecification
- Bundler::Env
- Bundler::Environment
- Bundler::Fetcher
- Bundler::Fetcher::CertificateFailureError
- Bundler::Fetcher::FallbackError
- Bundler::Fetcher::SSLError
- Bundler::GemHelper
- Bundler::GemHelpers
- Bundler::GemInstaller
- Bundler::GemNotFound
- Bundler::GemfileError
- Bundler::GemfileNotFound
- Bundler::GemspecError
- Bundler::GitError
- Bundler::Graph
- Bundler::Graph::GraphVizClient
- Bundler::HTTPError
- Bundler::Index
- Bundler::Injector
- Bundler::InstallError
- Bundler::InstallHookError
- Bundler::Installer
- Bundler::InvalidOption
- Bundler::InvalidSpecSet
- Bundler::LazySpecification
- Bundler::LockfileError
- Bundler::LockfileParser
- Bundler::MarshalError
- Bundler::MatchPlatform
- Bundler::PathError
- Bundler::ProductionError
- Bundler::RemoteSpecification
- Bundler::Resolver
- Bundler::Resolver::SpecGroup
- Bundler::RubyDsl
- Bundler::RubyVersion
- Bundler::RubyVersionMismatch
- Bundler::RubygemsIntegration
- Bundler::RubygemsIntegration::AlmostModern
- Bundler::RubygemsIntegration::Ancient
- Bundler::RubygemsIntegration::Future
- Bundler::RubygemsIntegration::Gem
- Bundler::RubygemsIntegration::Gem::SourceIndex
- Bundler::RubygemsIntegration::Legacy
- Bundler::RubygemsIntegration::Modern
- Bundler::RubygemsIntegration::Transitional
- Bundler::Runtime
- Bundler::SecurityError
- Bundler::Settings
- Bundler::SharedHelpers
- Bundler::SimilarityDetector
- Bundler::Source
- Bundler::Source::Git
- Bundler::Source::Git::GitProxy
- Bundler::Source::Path
- Bundler::Source::Path::Installer
- Bundler::Source::Rubygems
- Bundler::SpecSet
- Bundler::SystemRubyVersion
- Bundler::UI
- Bundler::UI::RGProxy
- Bundler::UI::Shell
- Bundler::VersionConflict
- Gem
- Gem::Dependency
- Gem::Platform
- Gem::Requirement
- Gem::Specification
- Object

No matching classes.

# Bundler::Source::Git

### Attributes

branch[R]
options[R]
ref[R]
submodules[R]
uri[R]

### Public Class Methods

from_lock(options) click to toggle source

    # File lib/bundler/source/git.rb, line 34
    def self.from_lock(options)
      new(options.merge("uri" => options.delete("remote")))
    end

new(options) click to toggle source

    # File lib/bundler/source/git.rb, line 13
    def initialize(options)
      @options = options
      @glob = options["glob"] || DEFAULT_GLOB

      @allow_cached = false
      @allow_remote = false

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

      @uri        = options["uri"]
      @branch     = options["branch"]
      @ref        = options["ref"] || options["branch"] || options["tag"] || 'master'
      @submodules = options["submodules"]
      @name       = options["name"]
      @version    = options["version"]

      @copied     = false
      @local      = false
    end

### Public Instance Methods

==(o) click to toggle source
Alias for: eql?
app_cache_dirname() click to toggle source

    # File lib/bundler/source/git.rb, line 196
    def app_cache_dirname
      "#{base_name}-#{shortref_for_path(cached_revision || revision)}"
    end

cache(spec) click to toggle source

    # File lib/bundler/source/git.rb, line 164
    def cache(spec)
      return unless Bundler.settings[:cache_all]
      return if path == app_cache_path
      cached!
      FileUtils.rm_rf(app_cache_path)
      git_proxy.checkout if requires_checkout?
      git_proxy.copy_to(app_cache_path, @submodules)
      serialize_gemspecs_in(app_cache_path)
    end

cache_path() click to toggle source

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.

    # File lib/bundler/source/git.rb, line 184
    def cache_path
      @cache_path ||= begin
        git_scope = "#{base_name}-#{uri_hash}"

        if Bundler.requires_sudo?
          Bundler.user_bundle_path.join("cache/git", git_scope)
        else
          Bundler.cache.join("git", git_scope)
        end
      end
    end

eql?(o) click to toggle source

    # File lib/bundler/source/git.rb, line 49
    def eql?(o)
      Git === o            &&
      uri == o.uri         &&
      ref == o.ref         &&
      branch == o.branch   &&
      name == o.name       &&
      version == o.version &&
      submodules == o.submodules
    end

Also aliased as: ==
install(spec) click to toggle source

    # File lib/bundler/source/git.rb, line 153
    def install(spec)
      Bundler.ui.info "Using #{spec.name} (#{spec.version}) from #{to_s} "
      if requires_checkout? && !@copied
        Bundler.ui.debug "  * Checking out revision: #{ref}"
        git_proxy.copy_to(install_path, submodules)
        serialize_gemspecs_in(install_path)
        @copied = true
      end
      generate_bin(spec)
    end

install_path() click to toggle source

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.

    # File lib/bundler/source/git.rb, line 79
    def install_path
      @install_path ||= begin
        git_scope = "#{base_name}-#{shortref_for_path(revision)}"

        if Bundler.requires_sudo?
          Bundler.user_bundle_path.join(Bundler.ruby_scope).join(git_scope)
        else
          Bundler.install_path.join(git_scope)
        end
      end
    end

Also aliased as: path
load_spec_files() click to toggle source

    # File lib/bundler/source/git.rb, line 174
    def load_spec_files
      super
    rescue PathError, GitError
      raise GitError, "#{to_s} is not checked out. Please run `bundle install`"
    end

local_override!(path) click to toggle source

    # File lib/bundler/source/git.rb, line 98
    def local_override!(path)
      return false if local?

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

      unless options["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 use "              "`bundle config --delete` to remove the local override"
      end

      unless path.exist?
        raise GitError, "Cannot use local override for #{name} because #{path} "              "does not exist. Check `bundle config --delete` to remove the local override"
      end

      set_local!(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, ref)

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

      changed = cached_revision && cached_revision != git_proxy.revision

      if changed && !@unlocked && !git_proxy.contains?(cached_revision)
        raise GitError, "The Gemfile lock is pointing to revision #{shortref_for_display(cached_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

name() click to toggle source

    # File lib/bundler/source/git.rb, line 72
    def name
      File.basename(@uri, '.git')
    end

path() click to toggle source
Alias for: install_path
specs(*) click to toggle source

TODO: actually cache git specs

    # File lib/bundler/source/git.rb, line 138
    def specs(*)
      if has_app_cache? && !local?
        set_local!(app_cache_path)
      end

      if requires_checkout? && !@copied
        git_proxy.checkout
        git_proxy.copy_to(install_path, submodules)
        serialize_gemspecs_in(install_path)
        @copied = true
      end

      local_specs
    end

to_lock() click to toggle source

    # File lib/bundler/source/git.rb, line 38
    def to_lock
      out = "GIT\n"
      out << "  remote: #{@uri}\n"
      out << "  revision: #{revision}\n"
      %(ref branch tag submodules).each do |opt|
        out << "  #{opt}: #{options[opt]}\n" if options[opt]
      end
      out << "  glob: #{@glob}\n" unless @glob == DEFAULT_GLOB
      out << "  specs:\n"
    end

to_s() click to toggle source

    # File lib/bundler/source/git.rb, line 61
    def to_s
      at = if local?
        path
      elsif options["ref"]
        shortref_for_display(options["ref"])
      else
        ref
      end
      "#{uri} (at #{at})"
    end

unlock!() click to toggle source

    # File lib/bundler/source/git.rb, line 93
    def unlock!
      git_proxy.revision = nil
      @unlocked = true
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.