bundler 1.9.0 → 1.17.3

data/man/bundle-exec.1

@@ -0,0 +1,165 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-EXEC" "1" "November 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-exec\fR \- Execute a command in the context of the bundle
+.
+.SH "SYNOPSIS"
+\fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR
+.
+.SH "DESCRIPTION"
+This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\.
+.
+.P
+Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
+.
+.P
+Note that \fBbundle exec\fR does not require that an executable is available on your shell\'s \fB$PATH\fR\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-keep\-file\-descriptors\fR
+Exec in Ruby 2\.0 began discarding non\-standard file descriptors\. When this flag is passed, exec will revert to the 1\.9 behaviour of passing all file descriptors to the new process\.
+.
+.SH "BUNDLE INSTALL \-\-BINSTUBS"
+If you use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR, Bundler will automatically create a directory (which defaults to \fBapp_root/bin\fR) containing all of the executables available from gems in the bundle\.
+.
+.P
+After using \fB\-\-binstubs\fR, \fBbin/rspec spec/my_spec\.rb\fR is identical to \fBbundle exec rspec spec/my_spec\.rb\fR\.
+.
+.SH "ENVIRONMENT MODIFICATIONS"
+\fBbundle exec\fR makes a number of changes to the shell environment, then executes the command you specify in full\.
+.
+.IP "\(bu" 4
+make sure that it\'s still possible to shell out to \fBbundle\fR from inside a command invoked by \fBbundle exec\fR (using \fB$BUNDLE_BIN_PATH\fR)
+.
+.IP "\(bu" 4
+put the directory containing executables (like \fBrails\fR, \fBrspec\fR, \fBrackup\fR) for your bundle on \fB$PATH\fR
+.
+.IP "\(bu" 4
+make sure that if bundler is invoked in the subshell, it uses the same \fBGemfile\fR (by setting \fBBUNDLE_GEMFILE\fR)
+.
+.IP "\(bu" 4
+add \fB\-rbundler/setup\fR to \fB$RUBYOPT\fR, which makes sure that Ruby programs invoked in the subshell can see the gems in the bundle
+.
+.IP "" 0
+.
+.P
+It also modifies Rubygems:
+.
+.IP "\(bu" 4
+disallow loading additional gems not in the bundle
+.
+.IP "\(bu" 4
+modify the \fBgem\fR method to be a no\-op if a gem matching the requirements is in the bundle, and to raise a \fBGem::LoadError\fR if it\'s not
+.
+.IP "\(bu" 4
+Define \fBGem\.refresh\fR to be a no\-op, since the source index is always frozen when using bundler, and to prevent gems from the system leaking into the environment
+.
+.IP "\(bu" 4
+Override \fBGem\.bin_path\fR to use the gems in the bundle, making system executables work
+.
+.IP "\(bu" 4
+Add all gems in the bundle into Gem\.loaded_specs
+.
+.IP "" 0
+.
+.P
+Finally, \fBbundle exec\fR also implicitly modifies \fBGemfile\.lock\fR if the lockfile and the Gemfile do not match\. Bundler needs the Gemfile to determine things such as a gem\'s groups, \fBautorequire\fR, and platforms, etc\., and that information isn\'t stored in the lockfile\. The Gemfile and lockfile must be synced in order to \fBbundle exec\fR successfully, so \fBbundle exec\fR updates the lockfile beforehand\.
+.
+.SS "Loading"
+By default, when attempting to \fBbundle exec\fR to a file with a ruby shebang, Bundler will \fBKernel\.load\fR that file instead of using \fBKernel\.exec\fR\. For the vast majority of cases, this is a performance improvement\. In a rare few cases, this could cause some subtle side\-effects (such as dependence on the exact contents of \fB$0\fR or \fB__FILE__\fR) and the optimization can be disabled by enabling the \fBdisable_exec_load\fR setting\.
+.
+.SS "Shelling out"
+Any Ruby code that opens a subshell (like \fBsystem\fR, backticks, or \fB%x{}\fR) will automatically use the current Bundler environment\. If you need to shell out to a Ruby command that is not part of your current bundle, use the \fBwith_clean_env\fR method with a block\. Any subshells created inside the block will be given the environment present before Bundler was activated\. For example, Homebrew commands run Ruby, but don\'t work inside a bundle:
+.
+.IP "" 4
+.
+.nf
+
+Bundler\.with_clean_env do
+  `brew install wget`
+end
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Using \fBwith_clean_env\fR is also necessary if you are shelling out to a different bundle\. Any Bundler commands run in a subshell will inherit the current Gemfile, so commands that need to run in the context of a different bundle also need to use \fBwith_clean_env\fR\.
+.
+.IP "" 4
+.
+.nf
+
+Bundler\.with_clean_env do
+  Dir\.chdir "/other/bundler/project" do
+    `bundle exec \./script`
+  end
+end
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Bundler provides convenience helpers that wrap \fBsystem\fR and \fBexec\fR, and they can be used like this:
+.
+.IP "" 4
+.
+.nf
+
+Bundler\.clean_system(\'brew install wget\')
+Bundler\.clean_exec(\'brew install wget\')
+.
+.fi
+.
+.IP "" 0
+.
+.SH "RUBYGEMS PLUGINS"
+At present, the Rubygems plugin system requires all files named \fBrubygems_plugin\.rb\fR on the load path of \fIany\fR installed gem when any Ruby code requires \fBrubygems\.rb\fR\. This includes executables installed into the system, like \fBrails\fR, \fBrackup\fR, and \fBrspec\fR\.
+.
+.P
+Since Rubygems plugins can contain arbitrary Ruby code, they commonly end up activating themselves or their dependencies\.
+.
+.P
+For instance, the \fBgemcutter 0\.5\fR gem depended on \fBjson_pure\fR\. If you had that version of gemcutter installed (even if you \fIalso\fR had a newer version without this problem), Rubygems would activate \fBgemcutter 0\.5\fR and \fBjson_pure <latest>\fR\.
+.
+.P
+If your Gemfile(5) also contained \fBjson_pure\fR (or a gem with a dependency on \fBjson_pure\fR), the latest version on your system might conflict with the version in your Gemfile(5), or the snapshot version in your \fBGemfile\.lock\fR\.
+.
+.P
+If this happens, bundler will say:
+.
+.IP "" 4
+.
+.nf
+
+You have already activated json_pure 1\.4\.6 but your Gemfile
+requires json_pure 1\.4\.3\. Consider using bundle exec\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+In this situation, you almost certainly want to remove the underlying gem with the problematic gem plugin\. In general, the authors of these plugins (in this case, the \fBgemcutter\fR gem) have released newer versions that are more careful in their plugins\.
+.
+.P
+You can find a list of all the gems containing gem plugins by running
+.
+.IP "" 4
+.
+.nf
+
+ruby \-rubygems \-e "puts Gem\.find_files(\'rubygems_plugin\.rb\')"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+At the very least, you should remove all but the newest version of each gem plugin, and also remove all gem plugins that you aren\'t using (\fBgem uninstall gem_name\fR)\.

data/man/bundle-exec.1.txt

@@ -0,0 +1,178 @@
+BUNDLE-EXEC(1)							BUNDLE-EXEC(1)
+
+
+
+NAME
+       bundle-exec - Execute a command in the context of the bundle
+
+SYNOPSIS
+       bundle exec [--keep-file-descriptors] command
+
+DESCRIPTION
+       This  command  executes	the  command, making all gems specified in the
+       [Gemfile(5)][Gemfile(5)] available to require in Ruby programs.
+
+       Essentially, if you  would  normally  have  run	something  like  rspec
+       spec/my_spec.rb,  and  you  want to use the gems specified in the [Gem-
+       file(5)][Gemfile(5)]  and  installed   via   bundle   install(1)   bun-
+       dle-install.1.html, you should run bundle exec rspec spec/my_spec.rb.
+
+       Note  that bundle exec does not require that an executable is available
+       on your shell's $PATH.
+
+OPTIONS
+       --keep-file-descriptors
+	      Exec in Ruby 2.0 began discarding non-standard file descriptors.
+	      When  this flag is passed, exec will revert to the 1.9 behaviour
+	      of passing all file descriptors to the new process.
+
+BUNDLE INSTALL --BINSTUBS
+       If  you	use  the   --binstubs	flag   in   bundle   install(1)   bun-
+       dle-install.1.html,  Bundler  will  automatically  create  a  directory
+       (which defaults to app_root/bin)  containing  all  of  the  executables
+       available from gems in the bundle.
+
+       After  using --binstubs, bin/rspec spec/my_spec.rb is identical to bun-
+       dle exec rspec spec/my_spec.rb.
+
+ENVIRONMENT MODIFICATIONS
+       bundle exec makes a number of changes to the  shell  environment,  then
+       executes the command you specify in full.
+
+       o   make  sure  that  it's  still  possible to shell out to bundle from
+	   inside a command invoked by bundle exec (using $BUNDLE_BIN_PATH)
+
+       o   put	the  directory	containing  executables  (like	rails,	rspec,
+	   rackup) for your bundle on $PATH
+
+       o   make  sure  that if bundler is invoked in the subshell, it uses the
+	   same Gemfile (by setting BUNDLE_GEMFILE)
+
+       o   add -rbundler/setup to $RUBYOPT, which makes sure  that  Ruby  pro-
+	   grams invoked in the subshell can see the gems in the bundle
+
+
+
+       It also modifies Rubygems:
+
+       o   disallow loading additional gems not in the bundle
+
+       o   modify  the gem method to be a no-op if a gem matching the require-
+	   ments is in the bundle, and to raise a Gem::LoadError if it's not
+
+       o   Define Gem.refresh to be a no-op, since the source index is	always
+	   frozen  when  using	bundler,  and  to prevent gems from the system
+	   leaking into the environment
+
+       o   Override Gem.bin_path to use the gems in the bundle, making	system
+	   executables work
+
+       o   Add all gems in the bundle into Gem.loaded_specs
+
+
+
+       Finally, bundle exec also implicitly modifies Gemfile.lock if the lock-
+       file and the Gemfile do not match. Bundler needs the Gemfile to	deter-
+       mine  things  such as a gem's groups, autorequire, and platforms, etc.,
+       and that information isn't stored in  the  lockfile.  The  Gemfile  and
+       lockfile must be synced in order to bundle exec successfully, so bundle
+       exec updates the lockfile beforehand.
+
+   Loading
+       By default, when attempting to bundle exec to a file with a  ruby  she-
+       bang,  Bundler will Kernel.load that file instead of using Kernel.exec.
+       For the vast majority of cases, this is a performance improvement. In a
+       rare  few  cases,  this	could  cause some subtle side-effects (such as
+       dependence on the exact contents of $0 or __FILE__) and	the  optimiza-
+       tion can be disabled by enabling the disable_exec_load setting.
+
+   Shelling out
+       Any  Ruby  code that opens a subshell (like system, backticks, or %x{})
+       will automatically use the current Bundler environment. If you need  to
+       shell  out  to  a Ruby command that is not part of your current bundle,
+       use the with_clean_env method  with  a  block.  Any  subshells  created
+       inside  the  block will be given the environment present before Bundler
+       was activated. For example, Homebrew commands run Ruby, but don't  work
+       inside a bundle:
+
+
+
+	   Bundler.with_clean_env do
+	     `brew install wget`
+	   end
+
+
+
+       Using  with_clean_env  is  also	necessary if you are shelling out to a
+       different bundle. Any Bundler commands run in a subshell  will  inherit
+       the  current  Gemfile, so commands that need to run in the context of a
+       different bundle also need to use with_clean_env.
+
+
+
+	   Bundler.with_clean_env do
+	     Dir.chdir "/other/bundler/project" do
+	       `bundle exec ./script`
+	     end
+	   end
+
+
+
+       Bundler provides convenience helpers that wrap  system  and  exec,  and
+       they can be used like this:
+
+
+
+	   Bundler.clean_system('brew install wget')
+	   Bundler.clean_exec('brew install wget')
+
+
+
+RUBYGEMS PLUGINS
+       At  present,  the  Rubygems  plugin  system  requires  all  files named
+       rubygems_plugin.rb on the load path of any installed gem when any  Ruby
+       code requires rubygems.rb. This includes executables installed into the
+       system, like rails, rackup, and rspec.
+
+       Since Rubygems plugins can contain arbitrary Ruby code,	they  commonly
+       end up activating themselves or their dependencies.
+
+       For  instance,  the gemcutter 0.5 gem depended on json_pure. If you had
+       that version of gemcutter installed (even if you also had a newer  ver-
+       sion  without  this problem), Rubygems would activate gemcutter 0.5 and
+       json_pure <latest>.
+
+       If your Gemfile(5) also contained json_pure (or a gem with a dependency
+       on  json_pure),	the  latest version on your system might conflict with
+       the version in your Gemfile(5), or the snapshot version	in  your  Gem-
+       file.lock.
+
+       If this happens, bundler will say:
+
+
+
+	   You have already activated json_pure 1.4.6 but your Gemfile
+	   requires json_pure 1.4.3. Consider using bundle exec.
+
+
+
+       In  this  situation, you almost certainly want to remove the underlying
+       gem with the problematic gem plugin. In general, the authors  of  these
+       plugins	(in this case, the gemcutter gem) have released newer versions
+       that are more careful in their plugins.
+
+       You can find a list of all the gems containing gem plugins by running
+
+
+
+	   ruby -rubygems -e "puts Gem.find_files('rubygems_plugin.rb')"
+
+
+
+       At the very least, you should remove all but the newest version of each
+       gem  plugin, and also remove all gem plugins that you aren't using (gem
+       uninstall gem_name).
+
+
+
+				 November 2018			BUNDLE-EXEC(1)

data/man/bundle-exec.ronn

@@ -8,11 +8,11 @@ bundle-exec(1) -- Execute a command in the context of the bundle
 ## DESCRIPTION
 
 This command executes the command, making all gems specified in the
-`Gemfile(5)` available to `require` in Ruby programs.
+[`Gemfile(5)`][Gemfile(5)] available to `require` in Ruby programs.
 
 Essentially, if you would normally have run something like
 `rspec spec/my_spec.rb`, and you want to use the gems specified
-in the `Gemfile(5)` and installed via [bundle install(1)][bundle-install], you
+in the [`Gemfile(5)`][Gemfile(5)] and installed via [bundle install(1)](bundle-install.1.html), you
 should run `bundle exec rspec spec/my_spec.rb`.
 
 Note that `bundle exec` does not require that an executable is
@@ -27,7 +27,7 @@ available on your shell's `$PATH`.
 
 ## BUNDLE INSTALL --BINSTUBS
 
-If you use the `--binstubs` flag in [bundle install(1)][bundle-install], Bundler will
+If you use the `--binstubs` flag in [bundle install(1)](bundle-install.1.html), Bundler will
 automatically create a directory (which defaults to `app_root/bin`)
 containing all of the executables available from gems in the bundle.
 
@@ -63,6 +63,22 @@ It also modifies Rubygems:
   making system executables work
 * Add all gems in the bundle into Gem.loaded_specs
 
+Finally, `bundle exec` also implicitly modifies `Gemfile.lock` if the lockfile
+and the Gemfile do not match. Bundler needs the Gemfile to determine things
+such as a gem's groups, `autorequire`, and platforms, etc., and that
+information isn't stored in the lockfile. The Gemfile and lockfile must be
+synced in order to `bundle exec` successfully, so `bundle exec`
+updates the lockfile beforehand.
+
+### Loading
+
+By default, when attempting to `bundle exec` to a file with a ruby shebang,
+Bundler will `Kernel.load` that file instead of using `Kernel.exec`. For the
+vast majority of cases, this is a performance improvement. In a rare few cases,
+this could cause some subtle side-effects (such as dependence on the exact
+contents of `$0` or `__FILE__`) and the optimization can be disabled by enabling
+the `disable_exec_load` setting.
+
 ### Shelling out
 
 Any Ruby code that opens a subshell (like `system`, backticks, or `%x{}`) will

data/man/bundle-gem.1

@@ -0,0 +1,80 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BUNDLE\-GEM" "1" "November 2018" "" ""
+.
+.SH "NAME"
+\fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem
+.
+.SH "SYNOPSIS"
+\fBbundle gem\fR \fIGEM_NAME\fR \fIOPTIONS\fR
+.
+.SH "DESCRIPTION"
+Generates a directory named \fBGEM_NAME\fR with a \fBRakefile\fR, \fBGEM_NAME\.gemspec\fR, and other supporting files and directories that can be used to develop a rubygem with that name\.
+.
+.P
+Run \fBrake \-T\fR in the resulting project for a list of Rake tasks that can be used to test and publish the gem to rubygems\.org\.
+.
+.P
+The generated project skeleton can be customized with OPTIONS, as explained below\. Note that these options can also be specified via Bundler\'s global configuration file using the following names:
+.
+.IP "\(bu" 4
+\fBgem\.coc\fR
+.
+.IP "\(bu" 4
+\fBgem\.mit\fR
+.
+.IP "\(bu" 4
+\fBgem\.test\fR
+.
+.IP "" 0
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-exe\fR or \fB\-b\fR or \fB\-\-bin\fR
+Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\.
+.
+.TP
+\fB\-\-no\-exe\fR
+Do not create a binary (overrides \fB\-\-exe\fR specified in the global config)\.
+.
+.TP
+\fB\-\-coc\fR
+Add a \fBCODE_OF_CONDUCT\.md\fR file to the root of the generated project\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\.
+.
+.TP
+\fB\-\-no\-coc\fR
+Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\.
+.
+.TP
+\fB\-\-ext\fR
+Add boilerplate for C extension code to the generated project\. This behavior is disabled by default\.
+.
+.TP
+\fB\-\-no\-ext\fR
+Do not add C extension code (overrides \fB\-\-ext\fR specified in the global config)\.
+.
+.TP
+\fB\-\-mit\fR
+Add an MIT license to a \fBLICENSE\.txt\fR file in the root of the generated project\. Your name from the global git config is used for the copyright statement\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\.
+.
+.TP
+\fB\-\-no\-mit\fR
+Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the global config)\.
+.
+.TP
+\fB\-t\fR, \fB\-\-test=minitest\fR, \fB\-\-test=rspec\fR
+Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR and \fBrspec\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\. If no option is specified, the default testing framework is RSpec\.
+.
+.TP
+\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR
+Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+bundle config(1) \fIbundle\-config\.1\.html\fR
+.
+.IP "" 0
+