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/source.rb,
lib/bundler/cli/gem.rb,
lib/bundler/runtime.rb,
lib/bundler/version.rb,
lib/bundler/fetcher.rb,
lib/bundler/cli/viz.rb,
lib/bundler/settings.rb,
lib/bundler/cli/show.rb,
lib/bundler/spec_set.rb,
lib/bundler/ruby_dsl.rb,
lib/bundler/resolver.rb,
lib/bundler/cli/open.rb,
lib/bundler/cli/init.rb,
lib/bundler/ui/shell.rb,
lib/bundler/cli/exec.rb,
lib/bundler/injector.rb,
lib/bundler/constants.rb,
lib/bundler/dep_proxy.rb,
lib/bundler/cli/clean.rb,
lib/bundler/cli/cache.rb,
lib/bundler/ui/silent.rb,
lib/bundler/deprecate.rb,
lib/bundler/cli/check.rb,
lib/bundler/installer.rb,
lib/bundler/cli/config.rb,
lib/bundler/dependency.rb,
lib/bundler/cli/update.rb,
lib/bundler/cli/inject.rb,
lib/bundler/deployment.rb,
lib/bundler/definition.rb,
lib/bundler/source/git.rb,
lib/bundler/gem_helper.rb,
lib/bundler/cli/common.rb,
lib/bundler/cli/package.rb,
lib/bundler/environment.rb,
lib/bundler/ui/rg_proxy.rb,
lib/bundler/cli/install.rb,
lib/bundler/cli/console.rb,
lib/bundler/source/path.rb,
lib/bundler/gem_helpers.rb,
lib/bundler/cli/platform.rb,
lib/bundler/cli/binstubs.rb,
lib/bundler/current_ruby.rb,
lib/bundler/cli/outdated.rb,
lib/bundler/psyched_yaml.rb,
lib/bundler/ruby_version.rb,
lib/bundler/gem_installer.rb,
lib/bundler/match_platform.rb,
lib/bundler/shared_helpers.rb,
lib/bundler/source/rubygems.rb,
lib/bundler/friendly_errors.rb,
lib/bundler/parallel_workers.rb,
lib/bundler/lazy_specification.rb,
lib/bundler/similarity_detector.rb,
lib/bundler/remote_specification.rb,
lib/bundler/rubygems_integration.rb,
lib/bundler/source/git/git_proxy.rb,
lib/bundler/source/path/installer.rb,
lib/bundler/gem_path_manipulation.rb,
lib/bundler/endpoint_specification.rb,
lib/bundler/parallel_workers/worker.rb,
lib/bundler/parallel_workers/unix_worker.rb,
lib/bundler/ssl_certs/certificate_manager.rb,
lib/bundler/parallel_workers/thread_worker.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, ParallelWorkers, RubyDsl, SSLCerts, SharedHelpers, UI Classes: 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, SecurityError, Settings, SimilarityDetector, Source, SpecSet, SystemRubyVersion, VersionConflict

Constant Summary

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

Syck raises ArgumentError

::ArgumentError

Class Attribute Summary (collapse)

Class Method Summary (collapse)

Class Attribute Details

+ (Object) bundle_path

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



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

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

+ (Object) rubygems (readonly)

Returns the value of attribute rubygems



557
558
559
# File 'lib/bundler/rubygems_integration.rb', line 557

def rubygems
  @rubygems
end

+ (Object) ui



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

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

Class Method Details

+ (Object) app_cache(custom_path = nil)



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

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

+ (Object) app_config_path



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

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

+ (Object) bin_path

Returns absolute location of where binstubs are installed to.



103
104
105
106
107
108
109
110
# File 'lib/bundler.rb', line 103

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

+ (Object) cache



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

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

+ (Object) clean_exec(*args)



242
243
244
# File 'lib/bundler.rb', line 242

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

+ (Object) clean_system(*args)



238
239
240
# File 'lib/bundler.rb', line 238

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

+ (Object) clear_gemspec_cache



357
358
359
# File 'lib/bundler.rb', line 357

def clear_gemspec_cache
  @gemspec_cache = {}
end

+ (Object) configure



89
90
91
# File 'lib/bundler.rb', line 89

def configure
  @configured ||= configure_gem_home_and_path
end

+ (CurrentRuby) current_ruby

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

+ (Object) default_gemfile



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

def default_gemfile
  SharedHelpers.default_gemfile
end

+ (Object) default_lockfile



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

def default_lockfile
  SharedHelpers.default_lockfile
end

+ (Bundler::Definition) definition(unlock = nil)

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:



148
149
150
151
152
153
154
155
# File 'lib/bundler.rb', line 148

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

+ (Object) environment



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

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

+ (Boolean) git_present?

Returns:

  • (Boolean)


361
362
363
364
# File 'lib/bundler.rb', line 361

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

+ (Object) home



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

def home
  bundle_path.join("bundler")
end

+ (Object) install_path



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

def install_path
  home.join("gems")
end

+ (Object) load



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

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

+ (Object) load_gemspec(file)



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

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

+ (Object) load_gemspec_uncached(file)



343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/bundler.rb', line 343

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

+ (Object) load_marshal(data)



328
329
330
331
332
# File 'lib/bundler.rb', line 328

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

+ (Object) locked_gems



157
158
159
160
161
162
163
164
165
# File 'lib/bundler.rb', line 157

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

+ (Object) mkdir_p(path)



289
290
291
292
293
294
295
# File 'lib/bundler.rb', line 289

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

+ (Object) preserve_gem_path



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

+ (Object) read_file(file)



324
325
326
# File 'lib/bundler.rb', line 324

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

+ (Object) require(*groups)



131
132
133
# File 'lib/bundler.rb', line 131

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

+ (Boolean) requires_sudo?

Returns:

  • (Boolean)


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/bundler.rb', line 263

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

+ (Object) root



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

def root
  default_gemfile.dirname.expand_path
end

+ (Object) ruby_scope



167
168
169
# File 'lib/bundler.rb', line 167

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

+ (Object) ruby_version



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

def ruby_version
  @ruby_version ||= SystemRubyVersion.new
end

+ (Object) settings



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

def settings
  @settings ||= begin
    Settings.new(app_config_path)
  rescue GemfileNotFound
    Settings.new
  end
end

+ (Object) setup(*groups)



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/bundler.rb', line 112

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

+ (Object) specs_path



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

def specs_path
  bundle_path.join("specifications")
end

+ (Object) sudo(str)



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/bundler.rb', line 308

def sudo(str)
  prompt = "\n\n" + <<-PROMPT.gsub(/^ {6}/, '').strip + " "
  Your user account isn't allowed to install to the system Rubygems.
  You can cancel this installation and run:

      bundle install --path vendor/bundle

  to install the gems into ./vendor/bundle/, or you can enter your password
  and install the bundled gems to Rubygems using sudo.

  Password:
  PROMPT

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

+ (Object) system_bindir



254
255
256
257
258
259
260
261
# File 'lib/bundler.rb', line 254

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

+ (Object) tmp



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

def tmp
  user_bundle_path.join("tmp", Process.pid.to_s)
end

+ (Object) user_bundle_path



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

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

+ (Object) which(executable)



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

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

+ (Object) with_clean_env



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

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

+ (Object) with_friendly_errors



4
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
40
41
# File 'lib/bundler/friendly_errors.rb', line 4

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 <<-WARN, :wrap => true
    You must recompile Ruby with OpenSSL support or change the sources in your \
    Gemfile from 'https' to 'http'. Instructions for compiling with OpenSSL \
    using RVM are available at http://rvm.io/packages/openssl.
  WARN
  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
  Bundler.ui.error <<-ERR, :wrap => true
    Unfortunately, a fatal error has occurred. Please see the Bundler \
    troubleshooting documentation at http://bit.ly/bundler-issues. Thanks!
  ERR
  raise e
end

+ (Object) with_original_env



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

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