Module: Bundler

Defined in:
lib/bundler/lockfile_parser.rb,
lib/bundler.rb,
lib/bundler/ui.rb,
lib/bundler/dsl.rb,
lib/bundler/env.rb,
lib/bundler/cli.rb,
lib/bundler/graph.rb,
lib/bundler/retry.rb,
lib/bundler/index.rb,
lib/bundler/source.rb,
lib/bundler/worker.rb,
lib/bundler/errors.rb,
lib/bundler/runtime.rb,
lib/bundler/cli/viz.rb,
lib/bundler/version.rb,
lib/bundler/fetcher.rb,
lib/bundler/cli/gem.rb,
lib/bundler/ruby_dsl.rb,
lib/bundler/injector.rb,
lib/bundler/spec_set.rb,
lib/bundler/resolver.rb,
lib/bundler/cli/init.rb,
lib/bundler/cli/show.rb,
lib/bundler/cli/exec.rb,
lib/bundler/ui/shell.rb,
lib/bundler/settings.rb,
lib/bundler/cli/open.rb,
lib/bundler/cli/lock.rb,
lib/bundler/cli/clean.rb,
lib/bundler/constants.rb,
lib/bundler/cli/cache.rb,
lib/bundler/cli/check.rb,
lib/bundler/deprecate.rb,
lib/bundler/ui/silent.rb,
lib/bundler/installer.rb,
lib/bundler/dep_proxy.rb,
lib/bundler/source/git.rb,
lib/bundler/cli/common.rb,
lib/bundler/dependency.rb,
lib/bundler/definition.rb,
lib/bundler/cli/inject.rb,
lib/bundler/deployment.rb,
lib/bundler/cli/update.rb,
lib/bundler/cli/config.rb,
lib/bundler/gem_helper.rb,
lib/bundler/gem_helpers.rb,
lib/bundler/ui/rg_proxy.rb,
lib/bundler/environment.rb,
lib/bundler/cli/package.rb,
lib/bundler/source/path.rb,
lib/bundler/cli/install.rb,
lib/bundler/cli/console.rb,
lib/bundler/source_list.rb,
lib/bundler/cli/platform.rb,
lib/bundler/ruby_version.rb,
lib/bundler/fetcher/base.rb,
lib/bundler/psyched_yaml.rb,
lib/bundler/cli/binstubs.rb,
lib/bundler/cli/outdated.rb,
lib/bundler/current_ruby.rb,
lib/bundler/vendored_thor.rb,
lib/bundler/fetcher/index.rb,
lib/bundler/shared_helpers.rb,
lib/bundler/match_platform.rb,
lib/bundler/source/rubygems.rb,
lib/bundler/friendly_errors.rb,
lib/bundler/stub_specification.rb,
lib/bundler/gem_remote_fetcher.rb,
lib/bundler/fetcher/downloader.rb,
lib/bundler/lazy_specification.rb,
lib/bundler/vendored_molinillo.rb,
lib/bundler/fetcher/dependency.rb,
lib/bundler/similarity_detector.rb,
lib/bundler/rubygems_integration.rb,
lib/bundler/remote_specification.rb,
lib/bundler/source/git/git_proxy.rb,
lib/bundler/installer/standalone.rb,
lib/bundler/gem_path_manipulation.rb,
lib/bundler/source/path/installer.rb,
lib/bundler/rubygems_gem_installer.rb,
lib/bundler/source/rubygems/remote.rb,
lib/bundler/endpoint_specification.rb,
lib/bundler/installer/gem_installer.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, Molinillo, RubyDsl, SSLCerts, SharedHelpers, UI Classes: BundlerError, CLI, CurrentRuby, CyclicDependencyError, Definition, DepProxy, Dependency, Deployment, DeprecatedError, Dsl, EndpointSpecification, Env, Environment, Fetcher, GemHelper, GemInstaller, GemNotFound, GemRemoteFetcher, GemRequireError, GemfileError, GemfileEvalError, GemfileLockNotFound, GemfileNotFound, GemspecError, GitError, Graph, HTTPError, Index, Injector, InstallError, InstallHookError, Installer, InvalidOption, LazySpecification, LockfileError, LockfileParser, MarshalError, PathError, PermissionError, ProductionError, RemoteSpecification, Resolver, Retry, RubyGemsGemInstaller, RubyVersion, RubyVersionMismatch, RubygemsIntegration, Runtime, SecurityError, Settings, SimilarityDetector, Source, SourceList, SpecSet, Standalone, StubSpecification, SystemRubyVersion, Thor, VersionConflict, Worker, YamlSyntaxError

Constant Summary

ORIGINAL_ENV =
ENV.to_hash
SUDO_MUTEX =
Mutex.new
VERSION =
"1.11.2"
WINDOWS =
RbConfig::CONFIG["host_os"] =~ /(msdos|mswin|djgpp|mingw)/
FREEBSD =
RbConfig::CONFIG["host_os"] =~ /bsd/
NULL =
WINDOWS ? "NUL" : "/dev/null"
Deprecate =
Gem::Deprecate
YamlLibrarySyntaxError =

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.



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

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

.rubygemsObject (readonly)

Returns the value of attribute rubygems



686
687
688
# File 'lib/bundler/rubygems_integration.rb', line 686

def rubygems
  @rubygems
end

Class Method Details

.app_cache(custom_path = nil) ⇒ Object



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

def app_cache(custom_path = nil)
  path = custom_path || root
  path.join(settings.app_cache_path)
end

.app_config_pathObject



168
169
170
171
172
173
174
# File 'lib/bundler.rb', line 168

def app_config_path
  if ENV["BUNDLE_APP_CONFIG"]
    Pathname.new(ENV["BUNDLE_APP_CONFIG"]).expand_path(root)
  else
    root.join(".bundle")
  end
end

.bin_pathObject

Returns absolute location of where binstubs are installed to.



75
76
77
78
79
80
81
82
# File 'lib/bundler.rb', line 75

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

.cacheObject



154
155
156
# File 'lib/bundler.rb', line 154

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

.clean_exec(*args) ⇒ Object



227
228
229
# File 'lib/bundler.rb', line 227

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

.clean_system(*args) ⇒ Object



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

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

.clear_gemspec_cacheObject



355
356
357
# File 'lib/bundler.rb', line 355

def clear_gemspec_cache
  @gemspec_cache = {}
end

.configureObject



56
57
58
# File 'lib/bundler.rb', line 56

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_bundle_dirObject



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

def default_bundle_dir
  SharedHelpers.default_bundle_dir
end

.default_gemfileObject



231
232
233
# File 'lib/bundler.rb', line 231

def default_gemfile
  SharedHelpers.default_gemfile
end

.default_lockfileObject



235
236
237
# File 'lib/bundler.rb', line 235

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:



115
116
117
118
119
120
121
122
# File 'lib/bundler.rb', line 115

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

.environmentObject



106
107
108
# File 'lib/bundler.rb', line 106

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

.git_present?Boolean

Returns:

  • (Boolean)


359
360
361
362
# File 'lib/bundler.rb', line 359

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

.homeObject



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

def home
  bundle_path.join("bundler")
end

.install_pathObject



146
147
148
# File 'lib/bundler.rb', line 146

def install_path
  home.join("gems")
end

.issues_url(exception) ⇒ Object



91
92
93
94
# File 'lib/bundler/friendly_errors.rb', line 91

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

.loadObject



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

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

.load_gemspec(file, validate = false) ⇒ Object



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

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

.load_gemspec_uncached(file, validate = false) ⇒ Object



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/bundler.rb', line 335

def load_gemspec_uncached(file, validate = false)
  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
      spec = eval_yaml_gemspec(path, contents)
    else
      spec = eval_gemspec(path, contents)
    end
    Bundler.rubygems.validate(spec) if spec && validate
    spec
  end
rescue Gem::InvalidSpecificationException => e
  UI::Shell.new.warn "The gemspec at #{file} is not valid. " \
    "The validation error was '#{e.message}'"
  nil
end

.load_marshal(data) ⇒ Object



320
321
322
323
324
# File 'lib/bundler.rb', line 320

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

.locked_gemsObject



124
125
126
127
128
129
130
131
132
# File 'lib/bundler.rb', line 124

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



276
277
278
279
280
281
282
283
284
# File 'lib/bundler.rb', line 276

def mkdir_p(path)
  if requires_sudo?
    sudo "mkdir -p '#{path}'" unless File.exist?(path)
  else
    SharedHelpers.filesystem_access(path, :write) do |p|
      FileUtils.mkdir_p(p)
    end
  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



316
317
318
# File 'lib/bundler.rb', line 316

def read_file(file)
  File.open(file, "rb", &:read)
end

.request_issue_report_for(e) ⇒ Object



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/bundler/friendly_errors.rb', line 53

def self.request_issue_report_for(e)
  Bundler.ui.info <<-EOS.gsub(/^ {6}/, "")
    --- ERROR REPORT TEMPLATE -------------------------------------------------------
    - What did you do?

      I ran the command `#{$PROGRAM_NAME} #{ARGV.join(" ")}`

    - What did you expect to happen?

      I expected Bundler to...

    - What happened instead?

      Instead, what actually happened was...


    Error details

        #{e.class}: #{e.message}
          #{e.backtrace.join("\n            ")}

    #{Bundler::Env.new.report(:print_gemfile => false, :print_gemspecs => false).gsub(/\n/, "\n      ").strip}
    --- TEMPLATE END ----------------------------------------------------------------

  EOS

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

  Bundler.ui.warn <<-EOS.gsub(/^ {6}/, "")

    First, try this link to see if there are any existing issue reports for this error:
    #{issues_url(e)}

    If 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:
    https://github.com/bundler/bundler/issues/new
  EOS
end

.require(*groups) ⇒ Object



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

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

.requires_sudo?Boolean

Returns:

  • (Boolean)


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/bundler.rb', line 252

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

  sudo_present = which "sudo" if settings.allow_sudo?

  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



368
369
370
# File 'lib/bundler.rb', line 368

def reset!
  @definition = nil
end

.rm_rf(path) ⇒ Object



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

def rm_rf(path)
  FileUtils.remove_entry_secure(path) if path && File.exist?(path)
end

.rootObject



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

def root
  @root ||= begin
              default_gemfile.dirname.expand_path
            rescue GemfileNotFound
              bundle_dir = default_bundle_dir
              raise GemfileNotFound, "Could not locate Gemfile or .bundle/ directory" unless bundle_dir
              Pathname.new(File.expand_path("..", bundle_dir))
            end
end

.ruby_scopeObject



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

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

.ruby_versionObject



364
365
366
# File 'lib/bundler.rb', line 364

def ruby_version
  @ruby_version ||= SystemRubyVersion.new
end

.settingsObject



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

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

.setup(*groups) ⇒ Object



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

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
    load.setup(*groups)
  end
end

.specs_pathObject



150
151
152
# File 'lib/bundler.rb', line 150

def specs_path
  bundle_path.join("specifications")
end

.sudo(str) ⇒ Object



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/bundler.rb', line 298

def sudo(str)
  SUDO_MUTEX.synchronize do
    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
end

.system_bindirObject



243
244
245
246
247
248
249
250
# File 'lib/bundler.rb', line 243

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



181
182
183
# File 'lib/bundler.rb', line 181

def tmp(name = Process.pid.to_s)
  Pathname.new(Dir.mktmpdir(["bundler", name]))
end

.uiObject



60
61
62
# File 'lib/bundler.rb', line 60

def ui
  (defined?(@ui) && @ui) || (self.ui = UI::Silent.new)
end

.ui=(ui) ⇒ Object



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

def ui=(ui)
  Bundler.rubygems.ui = ui ? UI::RGProxy.new(ui) : nil
  @ui = ui
end

.user_bundle_pathObject



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

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

.which(executable) ⇒ Object



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

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

.with_clean_envObject



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/bundler.rb', line 204

def with_clean_env
  with_original_env do
    ENV["MANPATH"] = ENV["BUNDLE_ORIG_MANPATH"]
    ENV.delete_if {|k, _| k[0, 7] == "BUNDLE_" }

    if ENV.key?("RUBYOPT")
      ENV["RUBYOPT"] = ENV["RUBYOPT"].sub "-rbundler/setup", ""
    end

    if ENV.key?("RUBYLIB")
      rubylib = ENV["RUBYLIB"].split(File::PATH_SEPARATOR)
      rubylib.delete(File.expand_path("..", __FILE__))
      ENV["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
    end

    yield
  end
end

.with_friendly_errorsObject



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
42
43
44
45
46
47
48
49
50
51
# File 'lib/bundler/friendly_errors.rb', line 6

def self.with_friendly_errors
  yield
rescue Bundler::YamlSyntaxError => e
  Bundler.ui.error e.message
  Bundler.ui.trace e.orig_exception
  exit e.status_code
rescue Bundler::Dsl::DSLError => e
  Bundler.ui.error e.message
  exit e.status_code
rescue Bundler::GemRequireError => e
  Bundler.ui.error e.message
  Bundler.ui.trace e.orig_exception, nil, true
  exit e.status_code
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
  request_issue_report_for(e)
  exit 1
end

.with_original_envObject



196
197
198
199
200
201
202
# File 'lib/bundler.rb', line 196

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