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

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?, mirror_for, #unmet_deps, #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

#optionsObject (readonly)

Returns the value of attribute options


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

def options
  @options
end

#refObject (readonly)

Returns the value of attribute ref


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

def ref
  @ref
end

#uriObject (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)

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

def allow_svn_ops?
  @allow_remote || @allow_cached
end

#app_cache_dirnameObject


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

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

#cache(spec, custom_path = nil) ⇒ Object


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

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_pathObject

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.


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

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)

49
50
51
52
53
54
55
# File 'lib/bundler/source/svn.rb', line 49

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

#extension_dir_nameObject


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

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

#hashObject


45
46
47
# File 'lib/bundler/source/svn.rb', line 45

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

#install(spec) ⇒ Object


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

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_pathObject 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.


77
78
79
80
81
82
83
84
85
86
87
# File 'lib/bundler/source/svn.rb', line 77

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_filesObject


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

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


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

def local_override!(path)
  return false if local?

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

  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

#nameObject


70
71
72
# File 'lib/bundler/source/svn.rb', line 70

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

#revisionObject


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

def revision
  svn_proxy.revision
end

#specsObject

TODO: actually cache svn specs


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

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_lockObject


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

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

#to_sObject


59
60
61
62
63
64
65
66
67
68
# File 'lib/bundler/source/svn.rb', line 59

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

#unlock!Object


95
96
97
98
# File 'lib/bundler/source/svn.rb', line 95

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