Class: Bundler::Source::Git
- Inherits:
-
Path
show all
- Defined in:
- lib/bundler/source/git.rb,
lib/bundler/source/git/git_proxy.rb more...
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
#expanded_original_path, #local_specs, #root
#add_dependency_names, #can_lock?, #dependency_names_to_double_check, #double_check_for, #extension_cache_path, #inspect, #local!, #local_only!, #path?, #prefer_local!, #spec_names, #unmet_deps, #version_message
Constructor Details
Returns a new instance of Git.
[View source]
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
Returns the value of attribute branch.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def branch
@branch
end
|
Returns the value of attribute glob.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def glob
@glob
end
|
Returns the value of attribute options.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def options
@options
end
|
Returns the value of attribute ref.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def ref
@ref
end
|
permalink
#submodules ⇒ Object
Returns the value of attribute submodules.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def submodules
@submodules
end
|
Returns the value of attribute uri.
10
11
12
|
# File 'lib/bundler/source/git.rb', line 10
def uri
@uri
end
|
Class Method Details
permalink
.from_lock(options) ⇒ Object
[View source]
49
50
51
|
# File 'lib/bundler/source/git.rb', line 49
def self.from_lock(options)
new(options.merge("uri" => options.delete("remote")))
end
|
Instance Method Details
permalink
#allow_git_ops? ⇒ Boolean
[View source]
260
261
262
|
# File 'lib/bundler/source/git.rb', line 260
def allow_git_ops?
@allow_remote || @allow_cached
end
|
permalink
#app_cache_dirname ⇒ Object
[View source]
248
249
250
|
# File 'lib/bundler/source/git.rb', line 248
def app_cache_dirname
"#{base_name}-#{shortref_for_path(locked_revision || revision)}"
end
|
permalink
#cache(spec, custom_path = nil) ⇒ Object
[View source]
225
226
227
|
# File 'lib/bundler/source/git.rb', line 225
def cache(spec, custom_path = nil)
cache_to(custom_path, try_migrate: false)
end
|
permalink
#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.
[View source]
[View source]
42
43
44
45
46
47
|
# File 'lib/bundler/source/git.rb', line 42
def cached!
return if @allow_cached
@local_specs = nil
@allow_cached = true
end
|
permalink
#current_branch ⇒ Object
[View source]
256
257
258
|
# File 'lib/bundler/source/git.rb', line 256
def current_branch
git_proxy.current_branch
end
|
permalink
#eql?(other) ⇒ Boolean
Also known as:
==
[View source]
76
77
78
79
80
81
|
# File 'lib/bundler/source/git.rb', line 76
def eql?(other)
other.is_a?(Git) && uri == other.uri && ref == other.ref &&
branch == other.branch && name == other.name &&
glob == other.glob &&
submodules == other.submodules
end
|
permalink
#extension_dir_name ⇒ Object
[View source]
138
139
140
|
# File 'lib/bundler/source/git.rb', line 138
def extension_dir_name
"#{base_name}-#{shortref_for_path(revision)}"
end
|
[View source]
72
73
74
|
# File 'lib/bundler/source/git.rb', line 72
def hash
[self.class, uri, ref, branch, name, glob, submodules].hash
end
|
permalink
#identifier ⇒ Object
[View source]
104
105
106
|
# File 'lib/bundler/source/git.rb', line 104
def identifier
uri_with_specifiers([humanized_ref, locked_revision, glob_for_display])
end
|
permalink
#include?(other) ⇒ Boolean
[View source]
85
86
87
88
89
90
|
# 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
|
permalink
#install(spec, options = {}) ⇒ Object
[View source]
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# File 'lib/bundler/source/git.rb', line 201
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
checkout
end
generate_bin_options = { disable_extensions: !spec.missing_extensions?, build_args: options[:build_args] }
generate_bin(spec, generate_bin_options)
requires_checkout? ? spec.post_install_message : nil
end
|
permalink
#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.
[View source]
128
129
130
131
132
133
134
|
# 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
|
permalink
#load_spec_files ⇒ Object
[View source]
229
230
231
232
233
234
|
# File 'lib/bundler/source/git.rb', line 229
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
|
[View source]
264
265
266
|
# File 'lib/bundler/source/git.rb', line 264
def local?
@local
end
|
permalink
#local_override!(path) ⇒ Object
[View source]
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
# 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.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
@local = true
set_paths!(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 = 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
|
permalink
#migrate_cache(custom_path = nil, local: false) ⇒ Object
[View source]
217
218
219
220
221
222
223
|
# File 'lib/bundler/source/git.rb', line 217
def migrate_cache(custom_path = nil, local: false)
if local
cache_to(custom_path, try_migrate: false)
else
cache_to(custom_path, try_migrate: true)
end
end
|
[View source]
121
122
123
|
# File 'lib/bundler/source/git.rb', line 121
def name
File.basename(@uri, ".git")
end
|
[View source]
35
36
37
38
39
40
|
# File 'lib/bundler/source/git.rb', line 35
def remote!
return if @allow_remote
@local_specs = nil
@allow_remote = true
end
|
permalink
#revision ⇒ Object
[View source]
252
253
254
|
# File 'lib/bundler/source/git.rb', line 252
def revision
git_proxy.revision
end
|
[View source]
190
191
192
193
194
195
196
197
198
199
|
# 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
|
permalink
#to_gemfile ⇒ Object
[View source]
64
65
66
67
68
69
70
|
# File 'lib/bundler/source/git.rb', line 64
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
|
[View source]
53
54
55
56
57
58
59
60
61
62
|
# 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}: #{options[opt]}\n" if options[opt]
end
out << " glob: #{@glob}\n" unless default_glob?
out << " specs:\n"
end
|
[View source]
92
93
94
95
96
97
98
99
100
101
102
|
# 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
|
[View source]
142
143
144
145
146
147
|
# File 'lib/bundler/source/git.rb', line 142
def unlock!
git_proxy.revision = nil
options["revision"] = nil
@unlocked = true
end
|
permalink
#uri_with_specifiers(specifiers) ⇒ Object
[View source]
108
109
110
111
112
113
114
115
116
117
118
119
|
# 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
|