Class: Bundler::Source::Git
- Inherits:
-
Path
show all
- Defined in:
- lib/bundler/source/git.rb,
lib/bundler/source/git/git_proxy.rb
Defined Under Namespace
Classes: AmbiguousGitReference, 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
#checksum_store, #dependency_names
Class Method Summary
collapse
Instance Method Summary
collapse
Methods inherited from Path
#cached!, #expanded_original_path, #local_specs, #remote!, #root
#add_dependency_names, #cached!, #can_lock?, #dependency_names_to_double_check, #double_check_for, #extension_cache_path, #inspect, #local!, #local_only!, #path?, #remote!, #spec_names, #unmet_deps, #version_message
Constructor Details
#initialize(options) ⇒ Git
Returns a new instance of Git.
12
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 12
def initialize(options)
@options = options
@checksum_store = Checksum::Store.new
@glob = options["glob"] || DEFAULT_GLOB
@allow_cached = false
@allow_remote = false
%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
end
|
Instance Attribute Details
#branch ⇒ Object
Returns the value of attribute branch.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def branch
@branch
end
|
#glob ⇒ Object
Returns the value of attribute glob.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def glob
@glob
end
|
#options ⇒ Object
Returns the value of attribute options.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def options
@options
end
|
#ref ⇒ Object
Returns the value of attribute ref.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def ref
@ref
end
|
#submodules ⇒ Object
Returns the value of attribute submodules.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def submodules
@submodules
end
|
#uri ⇒ Object
Returns the value of attribute uri.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
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
249
250
251
|
# File 'lib/bundler/source/git.rb', line 249
def allow_git_ops?
@allow_remote || @allow_cached
end
|
#app_cache_dirname ⇒ Object
237
238
239
|
# File 'lib/bundler/source/git.rb', line 237
def app_cache_dirname
"#{base_name}-#{shortref_for_path(cached_revision || revision)}"
end
|
#cache(spec, custom_path = nil) ⇒ Object
207
208
209
210
211
212
213
214
215
216
|
# File 'lib/bundler/source/git.rb', line 207
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_path ⇒ Object
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.
#current_branch ⇒ Object
245
246
247
|
# File 'lib/bundler/source/git.rb', line 245
def current_branch
git_proxy.current_branch
end
|
#eql?(other) ⇒ Boolean
Also known as:
==
62
63
64
65
66
67
|
# File 'lib/bundler/source/git.rb', line 62
def eql?(other)
other.is_a?(Git) && uri == other.uri && ref == other.ref &&
branch == other.branch && name == other.name &&
version == other.version && glob == other.glob &&
submodules == other.submodules
end
|
#extension_dir_name ⇒ Object
124
125
126
|
# File 'lib/bundler/source/git.rb', line 124
def extension_dir_name
"#{base_name}-#{shortref_for_path(revision)}"
end
|
#hash ⇒ Object
58
59
60
|
# File 'lib/bundler/source/git.rb', line 58
def hash
[self.class, uri, ref, branch, name, version, glob, submodules].hash
end
|
#identifier ⇒ Object
90
91
92
|
# File 'lib/bundler/source/git.rb', line 90
def identifier
uri_with_specifiers([humanized_ref, cached_revision, glob_for_display])
end
|
#include?(other) ⇒ Boolean
71
72
73
74
75
76
|
# File 'lib/bundler/source/git.rb', line 71
def include?(other)
other.is_a?(Git) && uri == other.uri &&
name == other.name &&
glob == other.glob &&
submodules == other.submodules
end
|
#install(spec, options = {}) ⇒ Object
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
# File 'lib/bundler/source/git.rb', line 188
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
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_path ⇒ Object
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.
114
115
116
117
118
119
120
|
# File 'lib/bundler/source/git.rb', line 114
def install_path
@install_path ||= begin
git_scope = "#{base_name}-#{shortref_for_path(revision)}"
Bundler.install_path.join(git_scope)
end
end
|
#load_spec_files ⇒ Object
218
219
220
221
222
223
|
# File 'lib/bundler/source/git.rb', line 218
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? ⇒ Boolean
253
254
255
|
# File 'lib/bundler/source/git.rb', line 253
def local?
@local
end
|
#local_override!(path) ⇒ Object
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
# File 'lib/bundler/source/git.rb', line 135
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
set_local!(path)
@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 = cached_revision && cached_revision != revision
if !Bundler.settings[:disable_local_revision_check] && 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 ⇒ Object
107
108
109
|
# File 'lib/bundler/source/git.rb', line 107
def name
File.basename(@uri, ".git")
end
|
#revision ⇒ Object
241
242
243
|
# File 'lib/bundler/source/git.rb', line 241
def revision
git_proxy.revision
end
|
#specs ⇒ Object
175
176
177
178
179
180
181
182
183
184
185
186
|
# File 'lib/bundler/source/git.rb', line 175
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_gemfile ⇒ Object
50
51
52
53
54
55
56
|
# File 'lib/bundler/source/git.rb', line 50
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 ⇒ Object
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 default_glob?
out << " specs:\n"
end
|
#to_s ⇒ Object
78
79
80
81
82
83
84
85
86
87
88
|
# File 'lib/bundler/source/git.rb', line 78
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! ⇒ Object
128
129
130
131
132
133
|
# File 'lib/bundler/source/git.rb', line 128
def unlock!
git_proxy.revision = nil
options["revision"] = nil
@unlocked = true
end
|
#uri_with_specifiers(specifiers) ⇒ Object
94
95
96
97
98
99
100
101
102
103
104
105
|
# File 'lib/bundler/source/git.rb', line 94
def uri_with_specifiers(specifiers)
specifiers.compact!
suffix =
if specifiers.any?
" (#{specifiers.join(", ")})"
else
""
end
"#{@safe_uri}#{suffix}"
end
|