class 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 %w(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
allow_git_ops?()
click to toggle source
# File lib/bundler/source/git.rb, line 218 def allow_git_ops? @allow_remote || @allow_cached end
app_cache_dirname()
click to toggle source
# File lib/bundler/source/git.rb, line 210 def app_cache_dirname "#{base_name}-#{shortref_for_path(cached_revision || revision)}" end
cache(spec, custom_path = nil)
click to toggle source
# File lib/bundler/source/git.rb, line 176 def cache(spec, custom_path = nil) app_cache_path = app_cache_path(custom_path) 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 198 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 53 def eql?(o) o.is_a?(Git) && uri == o.uri && ref == o.ref && branch == o.branch && name == o.name && version == o.version && submodules == o.submodules end
Also aliased as: ==
extension_dir_name()
click to toggle source
# File lib/bundler/source/git.rb, line 98 def extension_dir_name "#{base_name}-#{shortref_for_path(revision)}" end
hash()
click to toggle source
# File lib/bundler/source/git.rb, line 49 def hash [self.class, uri, ref, branch, name, version, submodules].hash end
install(spec, force = false)
click to toggle source
# File lib/bundler/source/git.rb, line 162 def install(spec, force = false) Bundler.ui.info "Using #{version_message(spec)} from #{to_s}" if requires_checkout? && !@copied && !force 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) requires_checkout? ? spec.post_install_message : nil 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 83 def install_path @install_path ||= begin git_scope = "#{base_name}-#{shortref_for_path(revision)}" path = Bundler.install_path.join(git_scope) if !path.exist? && Bundler.requires_sudo? Bundler.user_bundle_path.join(Bundler.ruby_scope).join(git_scope) else path end end end
Also aliased as: path
load_spec_files()
click to toggle source
Calls superclass method
# File lib/bundler/source/git.rb, line 187 def load_spec_files super rescue PathError => e Bundler.ui.trace e raise GitError, "#{to_s} is not yet checked out. Run `bundle install` first." end
local_override!(path)
click to toggle source
# File lib/bundler/source/git.rb, line 107 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 76 def name File.basename(@uri, '.git') end
revision()
click to toggle source
# File lib/bundler/source/git.rb, line 214 def revision git_proxy.revision end
specs(*)
click to toggle source
TODO: actually cache git specs
# File lib/bundler/source/git.rb, line 147 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" %w(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 65 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 102 def unlock! git_proxy.revision = nil @unlocked = true end
Private Instance Methods
base_name()
click to toggle source
# File lib/bundler/source/git.rb, line 254 def base_name File.basename(uri.sub(%r{^(\w+://)?([^/:]+:)?(//\w*/)?(\w*/)*},''),".git") end
cached?()
click to toggle source
# File lib/bundler/source/git.rb, line 282 def cached? cache_path.exist? end
cached_revision()
click to toggle source
# File lib/bundler/source/git.rb, line 278 def cached_revision options["revision"] end
git_proxy()
click to toggle source
# File lib/bundler/source/git.rb, line 286 def git_proxy @git_proxy ||= GitProxy.new(cache_path, uri, ref, cached_revision, self) end
has_app_cache?()
click to toggle source
Calls superclass method
# File lib/bundler/source/git.rb, line 242 def has_app_cache? cached_revision && super end
local?()
click to toggle source
# File lib/bundler/source/git.rb, line 246 def local? @local end
requires_checkout?()
click to toggle source
# File lib/bundler/source/git.rb, line 250 def requires_checkout? allow_git_ops? && !local? end
serialize_gemspecs_in(destination)
click to toggle source
# File lib/bundler/source/git.rb, line 224 def serialize_gemspecs_in(destination) expanded_path = destination.expand_path(Bundler.root) Dir["#{expanded_path}/#{@glob}"].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 File.open(spec_path, 'wb') {|file| file.write(spec.to_ruby) } end end
set_local!(path)
click to toggle source
# File lib/bundler/source/git.rb, line 236 def set_local!(path) @local = true @local_specs = @git_proxy = nil @cache_path = @install_path = path end
shortref_for_display(ref)
click to toggle source
# File lib/bundler/source/git.rb, line 258 def shortref_for_display(ref) ref[0..6] end
shortref_for_path(ref)
click to toggle source
# File lib/bundler/source/git.rb, line 262 def shortref_for_path(ref) ref[0..11] end
uri_hash()
click to toggle source
# File lib/bundler/source/git.rb, line 266 def uri_hash if uri =~ %r{^\w+://(\w+@)?} # Downcase the domain component of the URI # and strip off a trailing slash, if one is present input = 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 Digest::SHA1.hexdigest(input) end