Class: Bundler::Source::SVN

Inherits:
Path show all
Defined in:
lib/bundler/source/svn.rb,
lib/bundler/source/svn/svn_proxy.rb

Defined Under Namespace

Classes: SVNCommandError, SVNNotAllowedError, SVNNotInstalledError, SVNProxy

Constant Summary

Constants inherited from Path

Path::DEFAULT_GLOB

Instance Attribute Summary collapse

Attributes inherited from Path

#version

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Path

#cached!, #hash, #local_specs, #remote!

Methods inherited from Bundler::Source

mirror_for, #version_message

Constructor Details

#initialize(options) ⇒ SVN

Returns a new instance of SVN.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/bundler/source/svn.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 revision).each{|k| options[k] = options[k].to_s if options[k] }

  @uri        = options["uri"]
  @ref        = options["ref"] || 'HEAD'
  @name       = options["name"]
  @version    = options["version"]

  @copied     = false
  @local      = false
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

#ref ⇒ Object (readonly)

Returns the value of attribute ref.



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

def ref
  @ref
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Class Method Details

.from_lock(options) ⇒ Object 



32
33
34
 
# File 'lib/bundler/source/svn.rb', line 32

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

Instance Method Details

#allow_svn_ops? ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/bundler/source/svn.rb', line 193

def allow_svn_ops?
  @allow_remote || @allow_cached
end

#app_cache_dirname ⇒ Object 



185
186
187
 
# File 'lib/bundler/source/svn.rb', line 185

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

#cache(spec, custom_path = nil) ⇒ Object 



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

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)
  svn_proxy.checkout if requires_checkout?
  svn_proxy.copy_to(app_cache_path)
  serialize_gemspecs_in(app_cache_path)
end

#cache_path ⇒ Object

This is the path which is going to contain a cache of the svn repository. When using the same svn repository across different projects, this cache will be shared. When using local svn repos, this is set to the local repo.



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/bundler/source/svn.rb', line 173

def cache_path
  @cache_path ||= begin
    svn_scope = "#{base_name}-#{uri_hash}"

    if Bundler.requires_sudo?
      Bundler.user_bundle_path.join("cache/svn", svn_scope)
    else
      Bundler.cache.join("svn", svn_scope)
    end
  end
end

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

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
 
# File 'lib/bundler/source/svn.rb', line 44

def eql?(o)
  o.is_a?(SVN)         &&
  uri == o.uri         &&
  ref == o.ref         &&
  name == o.name       &&
  version == o.version
end

#extension_dir_name ⇒ Object 



86
87
88
 
# File 'lib/bundler/source/svn.rb', line 86

def extension_dir_name
  "#{base_name}-#{revision}"
end

#install(spec) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/bundler/source/svn.rb', line 136

def install(spec)
  debug = nil
  if requires_checkout? && !@copied
    debug = "  * Checking out revision: #{ref}"
    svn_proxy.copy_to(install_path)
    serialize_gemspecs_in(install_path)
    @copied = true
  end
  generate_bin(spec)
  if requires_checkout? && spec.post_install_message
    Installer.post_install_messages[spec.name] = spec.post_install_message
  end
  ["Using #{version_message(spec)} from #{to_s}", nil, debug]
end

#install_path ⇒ Object Also known as: path

This is the path which is going to contain a specific checkout of the svn repository. When using local svn repos, this is set to the local repo.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/bundler/source/svn.rb', line 72

def install_path
  @install_path ||= begin
    svn_scope = "#{base_name}-#{revision}"

    if Bundler.requires_sudo?
      Bundler.user_bundle_path.join(Bundler.ruby_scope).join(svn_scope)
    else
      Bundler.install_path.join(svn_scope)
    end
  end
end

#load_spec_files ⇒ Object 



162
163
164
165
166
167
 
# File 'lib/bundler/source/svn.rb', line 162

def load_spec_files
  super
rescue PathError => e
  Bundler.ui.trace e
  raise SVNError, "#{to_s} is not yet checked out. Run `bundle install` first."
end

#local_override!(path) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/bundler/source/svn.rb', line 95

def local_override!(path)
  return false if local?

  path = Pathname.new(path)
  path = path.expand_path(Bundler.root) unless path.relative?

  if options["ref"]
    raise SVNError, "Cannot use local override for #{name} at #{path} because " \
      ":ref is specified in Gemfile. Don't specify a revision or use " \
      "`bundle config --delete` to remove the local override"
  end

  unless path.exist?
    raise SVNError, "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 svn proxy without the cached revision
  # so the Gemfile.lock always picks up the new revision.
  @svn_proxy = SVNProxy.new(path, uri, ref)
  true
end

#name ⇒ Object 



65
66
67
 
# File 'lib/bundler/source/svn.rb', line 65

def name
  File.basename(@uri, '.svn')
end

#revision ⇒ Object 



189
190
191
 
# File 'lib/bundler/source/svn.rb', line 189

def revision
  svn_proxy.revision
end

#specs ⇒ Object

TODO: actually cache svn specs



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/bundler/source/svn.rb', line 121

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

  if requires_checkout? && !@copied
    svn_proxy.checkout
    svn_proxy.copy_to(install_path)
    serialize_gemspecs_in(install_path)
    @copied = true
  end

  local_specs
end

#to_lock ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/bundler/source/svn.rb', line 36

def to_lock
  out = "SVN\n"
  out << "  remote: #{@uri}\n"
  out << "  revision: #{revision}\n"
  out << "  glob: #{@glob}\n" unless @glob == DEFAULT_GLOB
  out << "  specs:\n"
end

#to_s ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/bundler/source/svn.rb', line 54

def to_s
  at = if local?
    path
  elsif options["ref"]
    options["ref"]
  else
    ref
  end
  "#{uri} (at #{at})"
end

#unlock! ⇒ Object 



90
91
92
93
 
# File 'lib/bundler/source/svn.rb', line 90

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