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: GitCommandError, GitNotAllowedError, GitNotInstalledError, GitProxy

Constant Summary

Constant Summary

Constants inherited from Path

Path::DEFAULT_GLOB

Instance Attribute Summary collapse

Attributes inherited from Path

#version

Attributes inherited from Bundler::Source

#dependency_names

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Path

#cached!, #local_specs, #remote!

Methods inherited from Bundler::Source

#can_lock?, #include?, #unmet_deps, #version_message

Constructor Details

#initialize(options) ⇒ Git



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/bundler/source/git.rb', line 12

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

Instance Attribute Details

#branchObject (readonly)

Returns the value of attribute branch



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

def branch
  @branch
end

#optionsObject (readonly)

Returns the value of attribute options



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

def options
  @options
end

#refObject (readonly)

Returns the value of attribute ref



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

def ref
  @ref
end

#submodulesObject (readonly)

Returns the value of attribute submodules



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

def submodules
  @submodules
end

#uriObject (readonly)

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



33
34
35
# File 'lib/bundler/source/git.rb', line 33

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

Instance Method Details

#allow_git_ops?Boolean



218
219
220
# File 'lib/bundler/source/git.rb', line 218

def allow_git_ops?
  @allow_remote || @allow_cached
end

#app_cache_dirnameObject



210
211
212
# 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) ⇒ Object



176
177
178
179
180
181
182
183
184
185
# 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_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.



198
199
200
201
202
203
204
205
206
207
208
# 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?(other) ⇒ Boolean Also known as: ==



52
53
54
55
56
# File 'lib/bundler/source/git.rb', line 52

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



100
101
102
# File 'lib/bundler/source/git.rb', line 100

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

#hashObject



48
49
50
# File 'lib/bundler/source/git.rb', line 48

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

#install(spec, force = false) ⇒ Object



162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/bundler/source/git.rb', line 162

def install(spec, force = false)
  Bundler.ui.info "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(spec)

  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.



85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/bundler/source/git.rb', line 85

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



187
188
189
190
191
192
# File 'lib/bundler/source/git.rb', line 187

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



109
110
111
112
113
114
115
116
117
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
# File 'lib/bundler/source/git.rb', line 109

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



78
79
80
# File 'lib/bundler/source/git.rb', line 78

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

#revisionObject



214
215
216
# File 'lib/bundler/source/git.rb', line 214

def revision
  git_proxy.revision
end

#specsObject

TODO: actually cache git specs



149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/bundler/source/git.rb', line 149

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

  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_lockObject



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

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_sObject



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/bundler/source/git.rb', line 60

def to_s
  at = if local?
    path
  elsif options["ref"]
    shortref_for_display(options["ref"])
  else
    ref
  end

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

  "#{uri} (at #{at}#{rev})"
end

#unlock!Object



104
105
106
107
# File 'lib/bundler/source/git.rb', line 104

def unlock!
  git_proxy.revision = nil
  @unlocked = true
end