Module: Bundler

Defined in:
lib/bundler/lockfile_parser.rb,
lib/bundler.rb,
lib/bundler/ui.rb,
lib/bundler/env.rb,
lib/bundler/dsl.rb,
lib/bundler/cli.rb,
lib/bundler/retry.rb,
lib/bundler/graph.rb,
lib/bundler/index.rb,
lib/bundler/worker.rb,
lib/bundler/source.rb,
lib/bundler/cli/gem.rb,
lib/bundler/fetcher.rb,
lib/bundler/cli/viz.rb,
lib/bundler/version.rb,
lib/bundler/runtime.rb,
lib/bundler/cli/show.rb,
lib/bundler/settings.rb,
lib/bundler/cli/exec.rb,
lib/bundler/ui/shell.rb,
lib/bundler/spec_set.rb,
lib/bundler/cli/open.rb,
lib/bundler/cli/init.rb,
lib/bundler/injector.rb,
lib/bundler/resolver.rb,
lib/bundler/ruby_dsl.rb,
lib/bundler/cli/cache.rb,
lib/bundler/ui/silent.rb,
lib/bundler/cli/check.rb,
lib/bundler/deprecate.rb,
lib/bundler/installer.rb,
lib/bundler/constants.rb,
lib/bundler/dep_proxy.rb,
lib/bundler/cli/clean.rb,
lib/bundler/definition.rb,
lib/bundler/cli/inject.rb,
lib/bundler/cli/update.rb,
lib/bundler/cli/config.rb,
lib/bundler/cli/common.rb,
lib/bundler/deployment.rb,
lib/bundler/source/git.rb,
lib/bundler/dependency.rb,
lib/bundler/source/svn.rb,
lib/bundler/gem_helper.rb,
lib/bundler/s3_fetcher.rb,
lib/bundler/cli/package.rb,
lib/bundler/gem_helpers.rb,
lib/bundler/ui/rg_proxy.rb,
lib/bundler/source/path.rb,
lib/bundler/source_list.rb,
lib/bundler/environment.rb,
lib/bundler/cli/install.rb,
lib/bundler/cli/console.rb,
lib/bundler/cli/outdated.rb,
lib/bundler/current_ruby.rb,
lib/bundler/cli/platform.rb,
lib/bundler/cli/binstubs.rb,
lib/bundler/psyched_yaml.rb,
lib/bundler/ruby_version.rb,
lib/bundler/gem_installer.rb,
lib/bundler/shared_helpers.rb,
lib/bundler/match_platform.rb,
lib/bundler/source/rubygems.rb,
lib/bundler/friendly_errors.rb,
lib/bundler/anonymizable_uri.rb,
lib/bundler/lazy_specification.rb,
lib/bundler/similarity_detector.rb,
lib/bundler/source/git/git_proxy.rb,
lib/bundler/rubygems_integration.rb,
lib/bundler/remote_specification.rb,
lib/bundler/source/svn/svn_proxy.rb,
lib/bundler/gem_path_manipulation.rb,
lib/bundler/source/path/installer.rb,
lib/bundler/endpoint_specification.rb,
lib/bundler/ssl_certs/certificate_manager.rb

Overview

Some versions of the Bundler 1.1 RC series introduced corrupted lockfiles. There were two major problems:

  • multiple copies of the same GIT section appeared in the lockfile

  • when this happened, those sections got multiple copies of gems in those sections.

As a result, Bundler 1.1 contains code that fixes the earlier corruption. We will remove this fix-up code in Bundler 1.2.

Defined Under Namespace

Modules: GemHelpers, MatchPlatform, RubyDsl, SSLCerts, SharedHelpers, UI Classes: AnonymizableURI, BundlerError, CLI, CurrentRuby, CyclicDependencyError, Definition, DepProxy, Dependency, Deployment, DeprecatedError, Dsl, EndpointSpecification, Env, Environment, Fetcher, GemHelper, GemInstaller, GemNotFound, GemfileError, GemfileLockNotFound, GemfileNotFound, GemspecError, GitError, Graph, HTTPError, Index, Injector, InstallError, InstallHookError, Installer, InvalidOption, LazySpecification, LockfileError, LockfileParser, MarshalError, PathError, ProductionError, RemoteSpecification, Resolver, Retry, RubyVersion, RubyVersionMismatch, RubygemsIntegration, Runtime, S3Fetcher, SVNError, SecurityError, Settings, SimilarityDetector, Source, SourceList, SpecSet, SystemRubyVersion, VersionConflict, Worker

Constant Summary

ORIGINAL_ENV =
ENV.to_hash
VERSION =
"1.7.9"
Deprecate =
Gem::Deprecate
WINDOWS =
RbConfig::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
FREEBSD =
RbConfig::CONFIG["host_os"] =~ /bsd/
NULL =
WINDOWS ? "NUL" : "/dev/null"
YamlSyntaxError =

Syck raises ArgumentError

::ArgumentError

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.bundle_pathObject

Returns absolute path of where gems are installed on the filesystem.



102
103
104
# File 'lib/bundler.rb', line 102

def bundle_path
  @bundle_path ||= Pathname.new(settings.path).expand_path(root)
end

.rubygemsObject (readonly)

Returns the value of attribute rubygems



576
577
578
# File 'lib/bundler/rubygems_integration.rb', line 576

def rubygems
  @rubygems
end

.uiObject



97
98
99
# File 'lib/bundler.rb', line 97

def ui
  @ui ||= UI::Silent.new
end

Class Method Details

.app_cache(custom_path = nil) ⇒ Object



205
206
207
208
# File 'lib/bundler.rb', line 205

def app_cache(custom_path = nil)
  path = custom_path || root
  path.join("vendor/cache")
end

.app_config_pathObject



199
200
201
202
203
# File 'lib/bundler.rb', line 199

def app_config_path
  ENV['BUNDLE_APP_CONFIG'] ?
    Pathname.new(ENV['BUNDLE_APP_CONFIG']).expand_path(root) :
    root.join('.bundle')
end

.bin_pathObject

Returns absolute location of where binstubs are installed to.



107
108
109
110
111
112
113
114
# File 'lib/bundler.rb', line 107

def bin_path
  @bin_path ||= begin
    path = settings[:bin] || "bin"
    path = Pathname.new(path).expand_path(root).expand_path
    FileUtils.mkdir_p(path)
    path
  end
end

.cacheObject



191
192
193
# File 'lib/bundler.rb', line 191

def cache
  bundle_path.join("cache/bundler")
end

.clean_exec(*args) ⇒ Object



251
252
253
# File 'lib/bundler.rb', line 251

def clean_exec(*args)
  with_clean_env { Kernel.exec(*args) }
end

.clean_system(*args) ⇒ Object



247
248
249
# File 'lib/bundler.rb', line 247

def clean_system(*args)
  with_clean_env { Kernel.system(*args) }
end

.cleanupObject



215
216
217
218
# File 'lib/bundler.rb', line 215

def cleanup
  FileUtils.remove_entry_secure(@tmp) if @tmp
rescue
end

.clear_gemspec_cacheObject



366
367
368
# File 'lib/bundler.rb', line 366

def clear_gemspec_cache
  @gemspec_cache = {}
end

.configureObject



93
94
95
# File 'lib/bundler.rb', line 93

def configure
  @configured ||= configure_gem_home_and_path
end

.current_rubyCurrentRuby

Returns current version of Ruby

Returns:



5
6
7
# File 'lib/bundler/current_ruby.rb', line 5

def self.current_ruby
  @current_ruby ||= CurrentRuby.new
end

.default_gemfileObject



255
256
257
# File 'lib/bundler.rb', line 255

def default_gemfile
  SharedHelpers.default_gemfile
end

.default_lockfileObject



259
260
261
# File 'lib/bundler.rb', line 259

def default_lockfile
  SharedHelpers.default_lockfile
end

.definition(unlock = nil) ⇒ Bundler::Definition

Returns an instance of Bundler::Definition for given Gemfile and lockfile

Parameters:

  • unlock (Hash, Boolean, nil) (defaults to: nil)

    Gems that have been requested to be updated or true if all gems should be updated

Returns:



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

def definition(unlock = nil)
  @definition = nil if unlock
  @definition ||= begin
    configure
    upgrade_lockfile
    Definition.build(default_gemfile, default_lockfile, unlock)
  end
end

.environmentObject



143
144
145
# File 'lib/bundler.rb', line 143

def environment
  Bundler::Environment.new(root, definition)
end

.git_present?Boolean

Returns:

  • (Boolean)


370
371
372
373
# File 'lib/bundler.rb', line 370

def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git") || Bundler.which("git.exe")
end

.homeObject



179
180
181
# File 'lib/bundler.rb', line 179

def home
  bundle_path.join("bundler")
end

.install_pathObject



183
184
185
# File 'lib/bundler.rb', line 183

def install_path
  home.join("gems")
end

.issues_url(exception) ⇒ Object



70
71
72
73
# File 'lib/bundler/friendly_errors.rb', line 70

def self.issues_url(exception)
  'https://github.com/bundler/bundler/search?q=' \
  "#{CGI.escape(exception.message)}&type=Issues"
end

.loadObject



139
140
141
# File 'lib/bundler.rb', line 139

def load
  @load ||= Runtime.new(root, definition)
end

.load_gemspec(file) ⇒ Object



343
344
345
346
347
348
349
350
# File 'lib/bundler.rb', line 343

def load_gemspec(file)
  @gemspec_cache ||= {}
  key = File.expand_path(file)
  spec = ( @gemspec_cache[key] ||= load_gemspec_uncached(file) )
  # Protect against caching side-effected gemspecs by returning a
  # new instance each time.
  spec.dup if spec
end

.load_gemspec_uncached(file) ⇒ Object



352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/bundler.rb', line 352

def load_gemspec_uncached(file)
  path = Pathname.new(file)
  # Eval the gemspec from its parent directory, because some gemspecs
  # depend on "./" relative paths.
  SharedHelpers.chdir(path.dirname.to_s) do
    contents = path.read
    if contents[0..2] == "---" # YAML header
      eval_yaml_gemspec(path, contents)
    else
      eval_gemspec(path, contents)
    end
  end
end

.load_marshal(data) ⇒ Object



337
338
339
340
341
# File 'lib/bundler.rb', line 337

def load_marshal(data)
  Marshal.load(data)
rescue => e
  raise MarshalError, "#{e.class}: #{e.message}"
end

.locked_gemsObject



161
162
163
164
165
166
167
168
169
# File 'lib/bundler.rb', line 161

def locked_gems
  return @locked_gems if defined?(@locked_gems)
  if Bundler.default_lockfile.exist?
    lock = Bundler.read_file(Bundler.default_lockfile)
    @locked_gems = LockfileParser.new(lock)
  else
    @locked_gems = nil
  end
end

.mkdir_p(path) ⇒ Object



298
299
300
301
302
303
304
# File 'lib/bundler.rb', line 298

def mkdir_p(path)
  if requires_sudo?
    sudo "mkdir -p '#{path}'" unless File.exist?(path)
  else
    FileUtils.mkdir_p(path)
  end
end

.preserve_gem_pathObject



2
3
4
5
6
7
# File 'lib/bundler/gem_path_manipulation.rb', line 2

def self.preserve_gem_path
  original_gem_path = ENV["_ORIGINAL_GEM_PATH"]
  gem_path          = ENV["GEM_PATH"]
  ENV["_ORIGINAL_GEM_PATH"] = gem_path          if original_gem_path.nil? || original_gem_path == ""
  ENV["GEM_PATH"]           = original_gem_path if gem_path.nil? || gem_path == ""
end

.read_file(file) ⇒ Object



333
334
335
# File 'lib/bundler.rb', line 333

def read_file(file)
  File.open(file, "rb") { |f| f.read }
end

.request_issue_report_for(e) ⇒ Object



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/bundler/friendly_errors.rb', line 41

def self.request_issue_report_for(e)
  Bundler.ui.info "\#{'\u{2015}\u{2015}\u{2015} ERROR REPORT TEMPLATE \u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}'}\n- What did you do?\n- What did you expect to happen?\n- What happened instead?\n\nError details\n\n\#{e.class}: \#{e.message}\n\#{e.backtrace.join(\"\\n          \")}\n\n\#{Bundler::Env.new.report(:print_gemfile => false).gsub(/\\n/, \"\\n      \").strip}\n\#{'\u{2015}\u{2015}\u{2015} TEMPLATE END \u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}\u{2015}'}\n\n".gsub(/^ {6}/, '')

  Bundler.ui.error "Unfortunately, an unexpected error occurred, and Bundler cannot continue."

  Bundler.ui.warn "\nFirst, try this link to see if there are any existing issue reports for this error:\n\#{issues_url(e)}\n\nIf there aren't any reports for this error yet, please create copy and paste the report template above into a new issue. Don't forget to anonymize any private data! The new issue form is located at:\nhttps://github.com/bundler/bundler/issues/new\n".gsub(/^ {6}/, '')
end

.require(*groups) ⇒ Object



135
136
137
# File 'lib/bundler.rb', line 135

def require(*groups)
  setup(*groups).require(*groups)
end

.requires_sudo?Boolean

Returns:

  • (Boolean)


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/bundler.rb', line 272

def requires_sudo?
  return @requires_sudo if defined?(@requires_sudo_ran)

  if settings.allow_sudo?
    sudo_present = which "sudo"
  end

  if sudo_present
    # the bundle path and subdirectories need to be writable for Rubygems
    # to be able to unpack and install gems without exploding
    path = bundle_path
    path = path.parent until path.exist?

    # bins are written to a different location on OS X
    bin_dir = Pathname.new(Bundler.system_bindir)
    bin_dir = bin_dir.parent until bin_dir.exist?

    # if any directory is not writable, we need sudo
    files = [path, bin_dir] | Dir[path.join('build_info/*').to_s] | Dir[path.join('*').to_s]
    sudo_needed = files.any?{|f| !File.writable?(f) }
  end

  @requires_sudo_ran = true
  @requires_sudo = settings.allow_sudo? && sudo_present && sudo_needed
end

.reset!Object



384
385
386
# File 'lib/bundler.rb', line 384

def reset!
  @definition = nil
end

.rootObject



195
196
197
# File 'lib/bundler.rb', line 195

def root
  @root ||= default_gemfile.dirname.expand_path
end

.ruby_scopeObject



171
172
173
# File 'lib/bundler.rb', line 171

def ruby_scope
  "#{Bundler.rubygems.ruby_engine}/#{Bundler.rubygems.config_map[:ruby_version]}"
end

.ruby_versionObject



380
381
382
# File 'lib/bundler.rb', line 380

def ruby_version
  @ruby_version ||= SystemRubyVersion.new
end

.settingsObject



220
221
222
223
224
225
# File 'lib/bundler.rb', line 220

def settings
  return @settings if defined?(@settings)
  @settings = Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new
end

.setup(*groups) ⇒ Object



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

def setup(*groups)
  # Just return if all groups are already loaded
  return @setup if defined?(@setup)

  definition.validate_ruby!

  if groups.empty?
    # Load all groups, but only once
    @setup = load.setup
  else
    @completed_groups ||= []
    # Figure out which groups haven't been loaded yet
    unloaded = groups - @completed_groups
    # Record groups that are now loaded
    @completed_groups = groups
    unloaded.any? ? load.setup(*groups) : load
  end
end

.specs_pathObject



187
188
189
# File 'lib/bundler.rb', line 187

def specs_path
  bundle_path.join("specifications")
end

.sudo(str) ⇒ Object



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/bundler.rb', line 317

def sudo(str)
  prompt = "\n\n" + "Your user account isn't allowed to install to the system Rubygems.\nYou can cancel this installation and run:\n\nbundle install --path vendor/bundle\n\nto install the gems into ./vendor/bundle/, or you can enter your password\nand install the bundled gems to Rubygems using sudo.\n\nPassword:\n".gsub(/^ {6}/, '').strip + " "

  `sudo -p "#{prompt}" #{str}`
end

.svn_present?Boolean

Returns:

  • (Boolean)


375
376
377
378
# File 'lib/bundler.rb', line 375

def svn_present?
  return @svn_present if defined?(@svn_present)
  @svn_present = Bundler.which("svn") || Bundler.which("svn.exe")
end

.system_bindirObject



263
264
265
266
267
268
269
270
# File 'lib/bundler.rb', line 263

def system_bindir
  # Gem.bindir doesn't always return the location that Rubygems will install
  # system binaries. If you put '-n foo' in your .gemrc, Rubygems will
  # install binstubs there instead. Unfortunately, Rubygems doesn't expose
  # that directory at all, so rather than parse .gemrc ourselves, we allow
  # the directory to be set as well, via `bundle config bindir foo`.
  Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir
end

.tmp(name = Process.pid.to_s) ⇒ Object



210
211
212
213
# File 'lib/bundler.rb', line 210

def tmp(name = Process.pid.to_s)
  @tmp ||= Pathname.new Dir.mktmpdir("bundler")
  @tmp.join(name)
end

.user_bundle_pathObject



175
176
177
# File 'lib/bundler.rb', line 175

def user_bundle_path
  Pathname.new(Bundler.rubygems.user_home).join(".bundler")
end

.which(executable) ⇒ Object



306
307
308
309
310
311
312
313
314
315
# File 'lib/bundler.rb', line 306

def which(executable)
  if File.file?(executable) && File.executable?(executable)
    executable
  elsif ENV['PATH']
    path = ENV['PATH'].split(File::PATH_SEPARATOR).find do |p|
      File.executable?(File.join(p, executable))
    end
    path && File.expand_path(executable, path)
  end
end

.with_clean_envObject



235
236
237
238
239
240
241
242
243
244
245
# File 'lib/bundler.rb', line 235

def with_clean_env
  with_original_env do
    ENV['MANPATH'] = ENV['BUNDLE_ORIG_MANPATH']
    ENV.delete_if { |k,_| k[0,7] == 'BUNDLE_' }
    if ENV.has_key? 'RUBYOPT'
      ENV['RUBYOPT'] = ENV['RUBYOPT'].sub '-rbundler/setup', ''
      ENV['RUBYOPT'] = ENV['RUBYOPT'].sub "-I#{File.expand_path('..', __FILE__)}", ''
    end
    yield
  end
end

.with_friendly_errorsObject



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/bundler/friendly_errors.rb', line 5

def self.with_friendly_errors
  yield
rescue Bundler::BundlerError => e
  Bundler.ui.error e.message, :wrap => true
  Bundler.ui.trace e
  exit e.status_code
rescue Thor::AmbiguousTaskError => e
  Bundler.ui.error e.message
  exit 15
rescue Thor::UndefinedTaskError => e
  Bundler.ui.error e.message
  exit 15
rescue Thor::Error => e
  Bundler.ui.error e.message
  exit 1
rescue LoadError => e
  raise e unless e.message =~ /cannot load such file -- openssl|openssl.so|libcrypto.so/
  Bundler.ui.error "\nCould not load OpenSSL."
  Bundler.ui.warn "You must recompile Ruby with OpenSSL support or change the sources in your \\\nGemfile from 'https' to 'http'. Instructions for compiling with OpenSSL \\\nusing RVM are available at http://rvm.io/packages/openssl.\n", :wrap => true
  Bundler.ui.trace e
  exit 1
rescue Interrupt => e
  Bundler.ui.error "\nQuitting..."
  Bundler.ui.trace e
  exit 1
rescue SystemExit => e
  exit e.status
rescue Exception => e
  request_issue_report_for(e)
  exit 1
end

.with_original_envObject



227
228
229
230
231
232
233
# File 'lib/bundler.rb', line 227

def with_original_env
  bundled_env = ENV.to_hash
  ENV.replace(ORIGINAL_ENV)
  yield
ensure
  ENV.replace(bundled_env.to_hash)
end