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 ,
::Bundler::Source
|
|
Instance Chain:
self,
Path ,
::Bundler::Source
|
|
Inherits: |
Bundler::Source::Path
|
Defined in: | lib/bundler/source/git.rb, lib/bundler/source/git/git_proxy.rb |
Constant Summary
Path
- Inherited
Class Method Summary
Instance Attribute Summary
- #allow_git_ops? ⇒ Boolean readonly
- #branch readonly
- #glob readonly
- #local? ⇒ Boolean readonly
- #options readonly
- #ref readonly
- #submodules readonly
- #uri readonly
- #cached? ⇒ Boolean readonly private
- #default_glob? ⇒ Boolean readonly private
- #has_app_cache? ⇒ Boolean readonly private
- #locked_revision_checked_out? ⇒ Boolean readonly private
- #requires_checkout? ⇒ Boolean readonly private
- #use_app_cache? ⇒ Boolean readonly private
Path
- Inherited
#name, #name=, #options, #path, #root_path, | |
#to_gemfile | Alias for Path#path. |
#version, #original_path, #has_app_cache? |
::Bundler::Source
- Inherited
Instance Method Summary
-
#==(other)
Alias for #eql?.
- #app_cache_dirname
- #cache(spec, custom_path = nil)
-
#cache_path
This is the path which is going to contain a cache of the git repository.
- #cached!
- #current_branch
- #eql?(other) ⇒ Boolean (also: #==)
- #extension_dir_name
- #hash
- #identifier
- #include?(other) ⇒ Boolean
- #install(spec, options = {})
-
#install_path
(also: #path)
This is the path which is going to contain a specific checkout of the git repository.
- #load_spec_files
- #local_override!(path)
- #migrate_cache(custom_path = nil, local: false)
- #name
-
#path
Alias for #install_path.
- #remote!
- #revision
- #specs
- #to_gemfile
- #to_lock
- #to_s
- #unlock!
- #uri_with_specifiers(specifiers)
- #bare_repo?(path) ⇒ Boolean private
- #base_name private
- #cache_to(custom_path, try_migrate: false) private
- #checkout private
- #extension_cache_slug(_) private
- #fetch private
- #git_proxy private
- #git_scope private
- #glob_for_display private
- #humanized_ref private
- #load_gemspec(file) private
- #locked_revision private
- #override_for(path) private
- #serialize_gemspecs_in(destination) private
- #set_cache_path!(path) private
- #set_install_path!(path) private
- #set_paths!(path) private
- #shortref_for_display(ref) private
- #shortref_for_path(ref) private
- #uri_hash private
-
#validate_spec(_spec)
private
no-op, since we validate when re-serializing the gemspec.
Path
- Inherited
::Bundler::Source
- Inherited
#add_dependency_names, #cached!, #can_lock?, #dependency_names_to_double_check, | |
#double_check_for | it’s possible that gems from one source depend on gems from some other source, so now we download gemspecs and iterate over those dependencies, looking for gems we don’t have info on yet. |
#extension_cache_path, #identifier, #include?, #inspect, #local!, #local_only!, #remote!, #spec_names, #unmet_deps, #version_message, #earlier_version?, #extension_cache_slug, #print_using_message, #version_color |
Constructor Details
.new(options) ⇒ Git
# File 'lib/bundler/source/git.rb', line 12
def initialize( ) @options = @checksum_store = Checksum::Store.new @glob = ["glob"] || DEFAULT_GLOB @allow_cached = false @allow_remote = false # Stringify options that could be set as symbols %w[ref branch tag revision].each {|k| [k] = [k].to_s if [k] } @uri = URINormalizer.normalize_suffix( ["uri"] || "", trailing_slash: false) @safe_uri = URICredentialsFilter.credential_filtered_uri(@uri) @branch = ["branch"] @ref = ["ref"] || ["branch"] || ["tag"] @submodules = ["submodules"] @name = ["name"] @version = ["version"].to_s.strip.gsub("-", ".pre.") @copied = false @local = false end
Class Method Details
.from_lock(options)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 49
def self.from_lock( ) new( .merge("uri" => .delete("remote"))) end
Instance Attribute Details
#allow_git_ops? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 260
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, :, :glob, :submodules
#cached? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 403
def cached? cache_path.exist? end
#default_glob? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 381
def default_glob? @glob == DEFAULT_GLOB end
#glob (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#has_app_cache? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 349
def has_app_cache? locked_revision && super end
#local? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 264
def local? @local end
#locked_revision_checked_out? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 361
def locked_revision_checked_out? locked_revision && locked_revision == revision && install_path.exist? end
#options (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#ref (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#requires_checkout? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 357
def requires_checkout? allow_git_ops? && !local? && !locked_revision_checked_out? end
#submodules (readonly)
[ GitHub ]#uri (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#use_app_cache? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 353
def use_app_cache? has_app_cache? && !local? end
Instance Method Details
#==(other)
Alias for #eql?.
# File 'lib/bundler/source/git.rb', line 83
alias_method :==, :eql?
#app_cache_dirname
[ GitHub ]# File 'lib/bundler/source/git.rb', line 248
def app_cache_dirname "#{base_name}-#{shortref_for_path(locked_revision || revision)}" end
#bare_repo?(path) ⇒ Boolean
(private)
#base_name (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 365
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 225
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.
# File 'lib/bundler/source/git.rb', line 240
def cache_path @cache_path ||= if Bundler.feature_flag.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 270
def cache_to(custom_path, try_migrate: false) return unless Bundler.feature_flag.cache_all? app_cache_path = app_cache_path(custom_path) migrate = try_migrate ? (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) end
#cached!
[ GitHub ]# File 'lib/bundler/source/git.rb', line 42
def cached! return if @allow_cached @local_specs = nil @allow_cached = true end
#checkout (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 287
def checkout Bundler.ui.debug " * Checking out revision: #{ref}" if use_app_cache? && ! (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? && (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 256
def current_branch git_proxy.current_branch end
#eql?(other) ⇒ Boolean
Also known as: #==
#extension_cache_slug(_) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 434
def extension_cache_slug(_) extension_dir_name end
#extension_dir_name
[ GitHub ]# File 'lib/bundler/source/git.rb', line 138
def extension_dir_name "#{base_name}-#{shortref_for_path(revision)}" end
#fetch (private)
[ GitHub ]#git_proxy (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 407
def git_proxy @git_proxy ||= GitProxy.new(cache_path, uri, , locked_revision, self) end
#git_scope (private)
[ GitHub ]#glob_for_display (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 377
def glob_for_display default_glob? ? nil : "glob: #{@glob}" end
#hash
[ GitHub ]#humanized_ref (private)
[ GitHub ]#identifier
[ GitHub ]# File 'lib/bundler/source/git.rb', line 104
def identifier uri_with_specifiers([humanized_ref, locked_revision, glob_for_display]) end
#include?(other) ⇒ Boolean
# File 'lib/bundler/source/git.rb', line 85
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 201
def install(spec, = {}) return if Bundler.settings[:no_install] force = [:force] "Using #{ (spec, [:previous_spec])} from #{self}" if (requires_checkout? && !@copied) || force checkout end = { disable_extensions: !spec.missing_extensions?, build_args: [:build_args] } generate_bin(spec, ) requires_checkout? ? spec. : 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.
# File 'lib/bundler/source/git.rb', line 128
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 421
def load_gemspec(file) dirname = Pathname.new(file).dirname SharedHelpers.chdir(dirname.to_s) do stub = Gem::StubSpecification.gemspec_stub(file, install_path.parent, install_path.parent) stub.full_gem_path = dirname. (root).to_s StubSpecification.from_stub(stub) end end
#load_spec_files
[ GitHub ]#local_override!(path)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 149
def local_override!(path) return false if local? original_path = path path = Pathname.new(path) path = 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, ) 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 399
def locked_revision ["revision"] end
#migrate_cache(custom_path = nil, local: false)
[ GitHub ]#name
[ GitHub ]# File 'lib/bundler/source/git.rb', line 121
def name File.basename(@uri, ".git") end
#override_for(path) (private)
[ GitHub ]#path
Alias for #install_path.
# File 'lib/bundler/source/git.rb', line 136
alias_method :path, :install_path
#remote!
[ GitHub ]# File 'lib/bundler/source/git.rb', line 35
def remote! return if @allow_remote @local_specs = nil @allow_remote = true end
#revision
[ GitHub ]# File 'lib/bundler/source/git.rb', line 252
def revision git_proxy.revision end
#serialize_gemspecs_in(destination) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 320
def serialize_gemspecs_in(destination) destination = destination. (Bundler.root) if destination.relative? Dir["#{destination}/#{@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 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 ]#set_install_path!(path) (private)
[ GitHub ]#set_paths!(path) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 334
def set_paths!(path) set_cache_path!(path) set_install_path!(path) end
#shortref_for_display(ref) (private)
[ GitHub ]#shortref_for_path(ref) (private)
[ GitHub ]#specs
[ GitHub ]# File 'lib/bundler/source/git.rb', line 190
def specs(*) set_cache_path!(app_cache_path) if use_app_cache? if requires_checkout? && !@copied fetch unless use_app_cache? checkout end local_specs end
#to_gemfile
[ GitHub ]# File 'lib/bundler/source/git.rb', line 64
def to_gemfile specifiers = %w[ref branch tag submodules glob].map do |opt| "#{opt}: #{ [opt]}" if [opt] end uri_with_specifiers(specifiers) end
#to_lock
[ GitHub ]# File 'lib/bundler/source/git.rb', line 53
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}: #{ [opt]}\n" if [opt] end out << " glob: #{@glob}\n" unless default_glob? out << " specs:\n" end
#to_s
[ GitHub ]# File 'lib/bundler/source/git.rb', line 92
def to_s begin at = humanized_ref || current_branch rev = "at #{at}@#{shortref_for_display(revision)}" rescue GitError "" end uri_with_specifiers([rev, glob_for_display]) end
#unlock!
[ GitHub ]#uri_hash (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 385
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 108
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
# File 'lib/bundler/source/git.rb', line 419
def validate_spec(_spec); end