Class: Bundler::Source::Git

Inherits:
Path show all
Defined in:
lib/bundler/source/git.rb,
lib/bundler/source/git/git_proxy.rb

Direct Known Subclasses

Plugin::Installer::Git

Defined Under Namespace

Classes: GitCommandError, GitNotAllowedError, GitNotInstalledError, GitProxy, MissingGitRevisionError

Constant Summary

Constants inherited from Path

Path::DEFAULT_GLOB

Instance Attribute Summary collapse

Attributes inherited from Path

#root_path, #version

Attributes inherited from Bundler::Source

#dependency_names

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Path

#cached!, #expanded_original_path, #local_specs, #remote!, #root

Methods inherited from Bundler::Source

#can_lock?, #dependency_names_to_double_check, #double_check_for, #include?, #inspect, #path?, #unmet_deps, #version_message

Constructor Details

#initialize(options) ⇒ Git

Returns a new instance of Git



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 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"] || ""
  @safe_uri   = URICredentialsFilter.credential_filtered_uri(@uri)
  @branch     = options["branch"]
  @ref        = options["ref"] || options["branch"] || options["tag"] || "master"
  @submodules = options["submodules"]
  @name       = options["name"]
  @version    = options["version"].to_s.strip.gsub("-", ".pre.")

  @copied     = false
  @local      = false
end

Instance Attribute Details

#branchObject (readonly)

Returns the value of attribute branch



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

def branch
  @branch
end

#optionsObject (readonly)

Returns the value of attribute options



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

def options
  @options
end

#refObject (readonly)

Returns the value of attribute ref



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

def ref
  @ref
end

#submodulesObject (readonly)

Returns the value of attribute submodules



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

def submodules
  @submodules
end

#uriObject (readonly)

Returns the value of attribute uri



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

def uri
  @uri
end

Class Method Details

.from_lock(options) ⇒ Object



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

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

Instance Method Details

#allow_git_ops?Boolean

Returns:

  • (Boolean)


228
229
230
# File 'lib/bundler/source/git.rb', line 228

def allow_git_ops?
  @allow_remote || @allow_cached
end

#app_cache_dirnameObject



220
221
222
# File 'lib/bundler/source/git.rb', line 220

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

#cache(spec, custom_path = nil) ⇒ Object



188
189
190
191
192
193
194
195
196
197
# File 'lib/bundler/source/git.rb', line 188

def cache(spec, custom_path = nil)
  app_cache_path = app_cache_path(custom_path)
  return unless Bundler.feature_flag.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_pathObject

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.



210
211
212
213
214
215
216
217
218
# File 'lib/bundler/source/git.rb', line 210

def cache_path
  @cache_path ||= begin
    if Bundler.requires_sudo? || Bundler.feature_flag.global_gem_cache?
      Bundler.user_cache
    else
      Bundler.bundle_path.join("cache", "bundler")
    end.join("git", git_scope)
  end
end

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

Returns:

  • (Boolean)


54
55
56
57
58
# File 'lib/bundler/source/git.rb', line 54

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

#extension_dir_nameObject



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

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

#hashObject



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

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

#install(spec, options = {}) ⇒ Object



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/bundler/source/git.rb', line 170

def install(spec, options = {})
  force = options[:force]

  print_using_message "Using #{version_message(spec)} from #{self}"

  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_options = { :disable_extensions => !Bundler.rubygems.spec_missing_extensions?(spec), :build_args => options[:build_args] }
  generate_bin(spec, generate_bin_options)

  requires_checkout? ? spec.post_install_message : nil
end

#install_pathObject 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.



91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/bundler/source/git.rb', line 91

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

#load_spec_filesObject



199
200
201
202
203
204
# File 'lib/bundler/source/git.rb', line 199

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) ⇒ Object



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/bundler/source/git.rb', line 118

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

#nameObject



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

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

#revisionObject



224
225
226
# File 'lib/bundler/source/git.rb', line 224

def revision
  git_proxy.revision
end

#specsObject



157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/bundler/source/git.rb', line 157

def specs(*)
  set_local!(app_cache_path) if has_app_cache? && !local?

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

  local_specs
end

#to_lockObject



39
40
41
42
43
44
45
46
47
48
# File 'lib/bundler/source/git.rb', line 39

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 @glob == DEFAULT_GLOB
  out << "  specs:\n"
end

#to_sObject



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/bundler/source/git.rb', line 62

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

  rev = begin
          "@#{shortref_for_display(revision)}"
        rescue GitError
          nil
        end

  "#{@safe_uri} (at #{at}#{rev})"
end

#unlock!Object



111
112
113
114
115
116
# File 'lib/bundler/source/git.rb', line 111

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

  @unlocked = true
end