bundler 2.1.3 → 2.2.1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of bundler might be problematic. Click here for more details.

Files changed (208) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1575 -1423
  3. data/README.md +6 -8
  4. data/bundler.gemspec +3 -3
  5. data/exe/bundle +3 -0
  6. data/lib/bundler.rb +35 -7
  7. data/lib/bundler/build_metadata.rb +3 -11
  8. data/lib/bundler/cli.rb +58 -21
  9. data/lib/bundler/cli/add.rb +1 -1
  10. data/lib/bundler/cli/binstubs.rb +6 -2
  11. data/lib/bundler/cli/cache.rb +1 -7
  12. data/lib/bundler/cli/clean.rb +1 -1
  13. data/lib/bundler/cli/common.rb +14 -0
  14. data/lib/bundler/cli/console.rb +1 -1
  15. data/lib/bundler/cli/doctor.rb +1 -1
  16. data/lib/bundler/cli/exec.rb +4 -4
  17. data/lib/bundler/cli/fund.rb +36 -0
  18. data/lib/bundler/cli/gem.rb +84 -11
  19. data/lib/bundler/cli/info.rb +15 -4
  20. data/lib/bundler/cli/init.rb +2 -2
  21. data/lib/bundler/cli/inject.rb +1 -1
  22. data/lib/bundler/cli/install.rb +9 -16
  23. data/lib/bundler/cli/issue.rb +2 -2
  24. data/lib/bundler/cli/list.rb +12 -10
  25. data/lib/bundler/cli/outdated.rb +87 -66
  26. data/lib/bundler/cli/plugin.rb +10 -0
  27. data/lib/bundler/cli/pristine.rb +5 -0
  28. data/lib/bundler/cli/show.rb +1 -1
  29. data/lib/bundler/cli/update.rb +2 -0
  30. data/lib/bundler/compact_index_client.rb +1 -1
  31. data/lib/bundler/compact_index_client/cache.rb +1 -1
  32. data/lib/bundler/compact_index_client/updater.rb +5 -5
  33. data/lib/bundler/definition.rb +49 -72
  34. data/lib/bundler/dep_proxy.rb +1 -1
  35. data/lib/bundler/dependency.rb +3 -10
  36. data/lib/bundler/dsl.rb +5 -9
  37. data/lib/bundler/endpoint_specification.rb +1 -1
  38. data/lib/bundler/env.rb +1 -1
  39. data/lib/bundler/environment_preserver.rb +26 -2
  40. data/lib/bundler/errors.rb +1 -0
  41. data/lib/bundler/feature_flag.rb +0 -3
  42. data/lib/bundler/fetcher.rb +4 -3
  43. data/lib/bundler/fetcher/base.rb +1 -1
  44. data/lib/bundler/fetcher/compact_index.rb +1 -1
  45. data/lib/bundler/fetcher/downloader.rb +1 -1
  46. data/lib/bundler/fetcher/index.rb +3 -4
  47. data/lib/bundler/friendly_errors.rb +22 -13
  48. data/lib/bundler/gem_helper.rb +32 -17
  49. data/lib/bundler/gem_helpers.rb +6 -1
  50. data/lib/bundler/gem_version_promoter.rb +2 -2
  51. data/lib/bundler/graph.rb +1 -1
  52. data/lib/bundler/index.rb +6 -2
  53. data/lib/bundler/injector.rb +22 -4
  54. data/lib/bundler/inline.rb +2 -2
  55. data/lib/bundler/installer.rb +35 -32
  56. data/lib/bundler/installer/gem_installer.rb +3 -3
  57. data/lib/bundler/installer/parallel_installer.rb +10 -10
  58. data/lib/bundler/installer/standalone.rb +2 -2
  59. data/lib/bundler/lazy_specification.rb +34 -9
  60. data/lib/bundler/lockfile_generator.rb +1 -1
  61. data/lib/bundler/lockfile_parser.rb +1 -1
  62. data/lib/bundler/man/.document +1 -0
  63. data/{man/bundle-add.ronn → lib/bundler/man/bundle-add.1.ronn} +0 -0
  64. data/{man/bundle-binstubs.ronn → lib/bundler/man/bundle-binstubs.1.ronn} +2 -4
  65. data/{man/bundle-cache.ronn → lib/bundler/man/bundle-cache.1.ronn} +0 -0
  66. data/{man/bundle-check.ronn → lib/bundler/man/bundle-check.1.ronn} +0 -0
  67. data/{man/bundle-clean.ronn → lib/bundler/man/bundle-clean.1.ronn} +0 -0
  68. data/{man/bundle-config.ronn → lib/bundler/man/bundle-config.1.ronn} +19 -30
  69. data/{man/bundle-doctor.ronn → lib/bundler/man/bundle-doctor.1.ronn} +0 -0
  70. data/{man/bundle-exec.ronn → lib/bundler/man/bundle-exec.1.ronn} +0 -0
  71. data/{man/bundle-gem.ronn → lib/bundler/man/bundle-gem.1.ronn} +30 -7
  72. data/{man/bundle-info.ronn → lib/bundler/man/bundle-info.1.ronn} +0 -0
  73. data/{man/bundle-init.ronn → lib/bundler/man/bundle-init.1.ronn} +0 -0
  74. data/{man/bundle-inject.ronn → lib/bundler/man/bundle-inject.1.ronn} +0 -0
  75. data/{man/bundle-install.ronn → lib/bundler/man/bundle-install.1.ronn} +25 -3
  76. data/{man/bundle-list.ronn → lib/bundler/man/bundle-list.1.ronn} +6 -6
  77. data/{man/bundle-lock.ronn → lib/bundler/man/bundle-lock.1.ronn} +0 -0
  78. data/{man/bundle-open.ronn → lib/bundler/man/bundle-open.1.ronn} +0 -0
  79. data/{man/bundle-outdated.ronn → lib/bundler/man/bundle-outdated.1.ronn} +0 -0
  80. data/{man/bundle-platform.ronn → lib/bundler/man/bundle-platform.1.ronn} +0 -0
  81. data/{man/bundle-pristine.ronn → lib/bundler/man/bundle-pristine.1.ronn} +0 -0
  82. data/{man/bundle-remove.ronn → lib/bundler/man/bundle-remove.1.ronn} +0 -0
  83. data/{man/bundle-show.ronn → lib/bundler/man/bundle-show.1.ronn} +0 -0
  84. data/{man/bundle-update.ronn → lib/bundler/man/bundle-update.1.ronn} +0 -0
  85. data/{man/bundle-viz.ronn → lib/bundler/man/bundle-viz.1.ronn} +0 -0
  86. data/{man/bundle.ronn → lib/bundler/man/bundle.1.ronn} +0 -0
  87. data/{man → lib/bundler/man}/gemfile.5.ronn +4 -4
  88. data/lib/bundler/mirror.rb +2 -2
  89. data/lib/bundler/plugin.rb +30 -5
  90. data/lib/bundler/plugin/api/source.rb +1 -1
  91. data/lib/bundler/plugin/dsl.rb +1 -1
  92. data/lib/bundler/plugin/index.rb +10 -1
  93. data/lib/bundler/plugin/installer.rb +1 -1
  94. data/lib/bundler/plugin/installer/rubygems.rb +1 -1
  95. data/lib/bundler/plugin/source_list.rb +1 -1
  96. data/lib/bundler/psyched_yaml.rb +0 -15
  97. data/lib/bundler/remote_specification.rb +5 -2
  98. data/lib/bundler/resolver.rb +35 -18
  99. data/lib/bundler/resolver/spec_group.rb +28 -11
  100. data/lib/bundler/retry.rb +1 -1
  101. data/lib/bundler/ruby_version.rb +1 -1
  102. data/lib/bundler/rubygems_ext.rb +53 -9
  103. data/lib/bundler/rubygems_gem_installer.rb +3 -9
  104. data/lib/bundler/rubygems_integration.rb +25 -55
  105. data/lib/bundler/runtime.rb +4 -14
  106. data/lib/bundler/settings.rb +49 -46
  107. data/lib/bundler/shared_helpers.rb +2 -2
  108. data/lib/bundler/similarity_detector.rb +1 -1
  109. data/lib/bundler/source.rb +1 -1
  110. data/lib/bundler/source/git.rb +5 -5
  111. data/lib/bundler/source/git/git_proxy.rb +57 -60
  112. data/lib/bundler/source/path.rb +7 -3
  113. data/lib/bundler/source/path/installer.rb +8 -10
  114. data/lib/bundler/source/rubygems.rb +13 -16
  115. data/lib/bundler/source/rubygems/remote.rb +1 -1
  116. data/lib/bundler/source_list.rb +2 -2
  117. data/lib/bundler/spec_set.rb +2 -1
  118. data/lib/bundler/stub_specification.rb +17 -7
  119. data/lib/bundler/templates/newgem/CODE_OF_CONDUCT.md.tt +57 -47
  120. data/lib/bundler/templates/newgem/Gemfile.tt +9 -1
  121. data/lib/bundler/templates/newgem/README.md.tt +1 -2
  122. data/lib/bundler/templates/newgem/Rakefile.tt +19 -5
  123. data/lib/bundler/templates/newgem/bin/console.tt +1 -0
  124. data/lib/bundler/templates/newgem/circleci/config.yml.tt +13 -0
  125. data/lib/bundler/templates/newgem/ext/newgem/extconf.rb.tt +2 -0
  126. data/lib/bundler/templates/newgem/github/workflows/main.yml.tt +18 -0
  127. data/lib/bundler/templates/newgem/gitlab-ci.yml.tt +9 -0
  128. data/lib/bundler/templates/newgem/lib/newgem.rb.tt +4 -2
  129. data/lib/bundler/templates/newgem/lib/newgem/version.rb.tt +2 -0
  130. data/lib/bundler/templates/newgem/newgem.gemspec.tt +14 -6
  131. data/lib/bundler/templates/newgem/rubocop.yml.tt +10 -0
  132. data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +2 -0
  133. data/lib/bundler/templates/newgem/spec/spec_helper.rb.tt +2 -1
  134. data/lib/bundler/templates/newgem/test/{newgem_test.rb.tt → minitest/newgem_test.rb.tt} +2 -0
  135. data/lib/bundler/templates/newgem/test/{test_helper.rb.tt → minitest/test_helper.rb.tt} +2 -0
  136. data/lib/bundler/templates/newgem/test/test-unit/newgem_test.rb.tt +15 -0
  137. data/lib/bundler/templates/newgem/test/test-unit/test_helper.rb.tt +6 -0
  138. data/lib/bundler/ui/shell.rb +5 -5
  139. data/lib/bundler/uri_credentials_filter.rb +3 -1
  140. data/lib/bundler/vendor/molinillo/lib/molinillo.rb +0 -1
  141. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph.rb +34 -1
  142. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/tag.rb +2 -2
  143. data/lib/bundler/vendor/molinillo/lib/molinillo/errors.rb +1 -1
  144. data/lib/bundler/vendor/molinillo/lib/molinillo/gem_metadata.rb +1 -1
  145. data/lib/bundler/vendor/molinillo/lib/molinillo/resolution.rb +38 -40
  146. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +79 -208
  147. data/lib/bundler/vendor/thor/lib/thor.rb +0 -7
  148. data/lib/bundler/vendor/thor/lib/thor/actions/create_link.rb +2 -1
  149. data/lib/bundler/vendor/thor/lib/thor/base.rb +9 -0
  150. data/lib/bundler/vendor/thor/lib/thor/version.rb +1 -1
  151. data/lib/bundler/vendor/tmpdir/lib/tmpdir.rb +154 -0
  152. data/lib/bundler/vendored_persistent.rb +0 -7
  153. data/lib/bundler/vendored_tmpdir.rb +4 -0
  154. data/lib/bundler/version.rb +1 -1
  155. data/lib/bundler/worker.rb +1 -1
  156. data/lib/bundler/yaml_serializer.rb +1 -1
  157. data/man/bundle-add.1 +1 -1
  158. data/man/bundle-binstubs.1 +5 -3
  159. data/man/bundle-cache.1 +1 -1
  160. data/man/bundle-check.1 +1 -1
  161. data/man/bundle-clean.1 +1 -1
  162. data/man/bundle-config.1 +16 -25
  163. data/man/bundle-doctor.1 +1 -1
  164. data/man/bundle-exec.1 +1 -1
  165. data/man/bundle-gem.1 +25 -3
  166. data/man/bundle-info.1 +1 -1
  167. data/man/bundle-init.1 +1 -1
  168. data/man/bundle-inject.1 +1 -1
  169. data/man/bundle-install.1 +30 -3
  170. data/man/bundle-list.1 +7 -7
  171. data/man/bundle-lock.1 +1 -1
  172. data/man/bundle-open.1 +1 -1
  173. data/man/bundle-outdated.1 +1 -1
  174. data/man/bundle-platform.1 +1 -1
  175. data/man/bundle-pristine.1 +1 -1
  176. data/man/bundle-remove.1 +1 -1
  177. data/man/bundle-show.1 +1 -1
  178. data/man/bundle-update.1 +1 -1
  179. data/man/bundle-viz.1 +1 -1
  180. data/man/bundle.1 +1 -1
  181. data/man/gemfile.5 +4 -4
  182. metadata +43 -59
  183. data/lib/bundler/vendor/molinillo/lib/molinillo/compatibility.rb +0 -26
  184. data/man/bundle-add.1.txt +0 -58
  185. data/man/bundle-binstubs.1.txt +0 -48
  186. data/man/bundle-cache.1.txt +0 -78
  187. data/man/bundle-check.1.txt +0 -33
  188. data/man/bundle-clean.1.txt +0 -26
  189. data/man/bundle-config.1.txt +0 -528
  190. data/man/bundle-doctor.1.txt +0 -44
  191. data/man/bundle-exec.1.txt +0 -178
  192. data/man/bundle-gem.1.txt +0 -91
  193. data/man/bundle-info.1.txt +0 -21
  194. data/man/bundle-init.1.txt +0 -34
  195. data/man/bundle-inject.1.txt +0 -32
  196. data/man/bundle-install.1.txt +0 -401
  197. data/man/bundle-list.1.txt +0 -43
  198. data/man/bundle-lock.1.txt +0 -93
  199. data/man/bundle-open.1.txt +0 -29
  200. data/man/bundle-outdated.1.txt +0 -131
  201. data/man/bundle-platform.1.txt +0 -57
  202. data/man/bundle-pristine.1.txt +0 -44
  203. data/man/bundle-remove.1.txt +0 -34
  204. data/man/bundle-show.1.txt +0 -27
  205. data/man/bundle-update.1.txt +0 -390
  206. data/man/bundle-viz.1.txt +0 -39
  207. data/man/bundle.1.txt +0 -116
  208. data/man/gemfile.5.txt +0 -649
@@ -1,44 +0,0 @@
1
- BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-doctor - Checks the bundle for common problems
7
-
8
- SYNOPSIS
9
- bundle doctor [--quiet] [--gemfile=GEMFILE]
10
-
11
- DESCRIPTION
12
- Checks your Gemfile and gem environment for common problems. If issues
13
- are detected, Bundler prints them and exits status 1. Otherwise,
14
- Bundler prints a success message and exits status 0.
15
-
16
- Examples of common problems caught by bundle-doctor include:
17
-
18
- o Invalid Bundler settings
19
-
20
- o Mismatched Ruby versions
21
-
22
- o Mismatched platforms
23
-
24
- o Uninstalled gems
25
-
26
- o Missing dependencies
27
-
28
-
29
-
30
- OPTIONS
31
- --quiet
32
- Only output warnings and errors.
33
-
34
- --gemfile=<gemfile>
35
- The location of the Gemfile(5) which Bundler should use. This
36
- defaults to a Gemfile(5) in the current working directory. In
37
- general, Bundler will assume that the location of the Gemfile(5)
38
- is also the project's root and will try to find Gemfile.lock and
39
- vendor/cache relative to this location.
40
-
41
-
42
-
43
-
44
- January 2020 BUNDLE-DOCTOR(1)
@@ -1,178 +0,0 @@
1
- BUNDLE-EXEC(1) BUNDLE-EXEC(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-exec - Execute a command in the context of the bundle
7
-
8
- SYNOPSIS
9
- bundle exec [--keep-file-descriptors] command
10
-
11
- DESCRIPTION
12
- This command executes the command, making all gems specified in the
13
- [Gemfile(5)][Gemfile(5)] available to require in Ruby programs.
14
-
15
- Essentially, if you would normally have run something like rspec
16
- spec/my_spec.rb, and you want to use the gems specified in the [Gem-
17
- file(5)][Gemfile(5)] and installed via bundle install(1) bun-
18
- dle-install.1.html, you should run bundle exec rspec spec/my_spec.rb.
19
-
20
- Note that bundle exec does not require that an executable is available
21
- on your shell's $PATH.
22
-
23
- OPTIONS
24
- --keep-file-descriptors
25
- Exec in Ruby 2.0 began discarding non-standard file descriptors.
26
- When this flag is passed, exec will revert to the 1.9 behaviour
27
- of passing all file descriptors to the new process.
28
-
29
- BUNDLE INSTALL --BINSTUBS
30
- If you use the --binstubs flag in bundle install(1) bun-
31
- dle-install.1.html, Bundler will automatically create a directory
32
- (which defaults to app_root/bin) containing all of the executables
33
- available from gems in the bundle.
34
-
35
- After using --binstubs, bin/rspec spec/my_spec.rb is identical to bun-
36
- dle exec rspec spec/my_spec.rb.
37
-
38
- ENVIRONMENT MODIFICATIONS
39
- bundle exec makes a number of changes to the shell environment, then
40
- executes the command you specify in full.
41
-
42
- o make sure that it's still possible to shell out to bundle from
43
- inside a command invoked by bundle exec (using $BUNDLE_BIN_PATH)
44
-
45
- o put the directory containing executables (like rails, rspec,
46
- rackup) for your bundle on $PATH
47
-
48
- o make sure that if bundler is invoked in the subshell, it uses the
49
- same Gemfile (by setting BUNDLE_GEMFILE)
50
-
51
- o add -rbundler/setup to $RUBYOPT, which makes sure that Ruby pro-
52
- grams invoked in the subshell can see the gems in the bundle
53
-
54
-
55
-
56
- It also modifies Rubygems:
57
-
58
- o disallow loading additional gems not in the bundle
59
-
60
- o modify the gem method to be a no-op if a gem matching the require-
61
- ments is in the bundle, and to raise a Gem::LoadError if it's not
62
-
63
- o Define Gem.refresh to be a no-op, since the source index is always
64
- frozen when using bundler, and to prevent gems from the system
65
- leaking into the environment
66
-
67
- o Override Gem.bin_path to use the gems in the bundle, making system
68
- executables work
69
-
70
- o Add all gems in the bundle into Gem.loaded_specs
71
-
72
-
73
-
74
- Finally, bundle exec also implicitly modifies Gemfile.lock if the lock-
75
- file and the Gemfile do not match. Bundler needs the Gemfile to deter-
76
- mine things such as a gem's groups, autorequire, and platforms, etc.,
77
- and that information isn't stored in the lockfile. The Gemfile and
78
- lockfile must be synced in order to bundle exec successfully, so bundle
79
- exec updates the lockfile beforehand.
80
-
81
- Loading
82
- By default, when attempting to bundle exec to a file with a ruby she-
83
- bang, Bundler will Kernel.load that file instead of using Kernel.exec.
84
- For the vast majority of cases, this is a performance improvement. In a
85
- rare few cases, this could cause some subtle side-effects (such as
86
- dependence on the exact contents of $0 or __FILE__) and the optimiza-
87
- tion can be disabled by enabling the disable_exec_load setting.
88
-
89
- Shelling out
90
- Any Ruby code that opens a subshell (like system, backticks, or %x{})
91
- will automatically use the current Bundler environment. If you need to
92
- shell out to a Ruby command that is not part of your current bundle,
93
- use the with_clean_env method with a block. Any subshells created
94
- inside the block will be given the environment present before Bundler
95
- was activated. For example, Homebrew commands run Ruby, but don't work
96
- inside a bundle:
97
-
98
-
99
-
100
- Bundler.with_clean_env do
101
- `brew install wget`
102
- end
103
-
104
-
105
-
106
- Using with_clean_env is also necessary if you are shelling out to a
107
- different bundle. Any Bundler commands run in a subshell will inherit
108
- the current Gemfile, so commands that need to run in the context of a
109
- different bundle also need to use with_clean_env.
110
-
111
-
112
-
113
- Bundler.with_clean_env do
114
- Dir.chdir "/other/bundler/project" do
115
- `bundle exec ./script`
116
- end
117
- end
118
-
119
-
120
-
121
- Bundler provides convenience helpers that wrap system and exec, and
122
- they can be used like this:
123
-
124
-
125
-
126
- Bundler.clean_system('brew install wget')
127
- Bundler.clean_exec('brew install wget')
128
-
129
-
130
-
131
- RUBYGEMS PLUGINS
132
- At present, the Rubygems plugin system requires all files named
133
- rubygems_plugin.rb on the load path of any installed gem when any Ruby
134
- code requires rubygems.rb. This includes executables installed into the
135
- system, like rails, rackup, and rspec.
136
-
137
- Since Rubygems plugins can contain arbitrary Ruby code, they commonly
138
- end up activating themselves or their dependencies.
139
-
140
- For instance, the gemcutter 0.5 gem depended on json_pure. If you had
141
- that version of gemcutter installed (even if you also had a newer ver-
142
- sion without this problem), Rubygems would activate gemcutter 0.5 and
143
- json_pure <latest>.
144
-
145
- If your Gemfile(5) also contained json_pure (or a gem with a dependency
146
- on json_pure), the latest version on your system might conflict with
147
- the version in your Gemfile(5), or the snapshot version in your Gem-
148
- file.lock.
149
-
150
- If this happens, bundler will say:
151
-
152
-
153
-
154
- You have already activated json_pure 1.4.6 but your Gemfile
155
- requires json_pure 1.4.3. Consider using bundle exec.
156
-
157
-
158
-
159
- In this situation, you almost certainly want to remove the underlying
160
- gem with the problematic gem plugin. In general, the authors of these
161
- plugins (in this case, the gemcutter gem) have released newer versions
162
- that are more careful in their plugins.
163
-
164
- You can find a list of all the gems containing gem plugins by running
165
-
166
-
167
-
168
- ruby -rrubygems -e "puts Gem.find_files('rubygems_plugin.rb')"
169
-
170
-
171
-
172
- At the very least, you should remove all but the newest version of each
173
- gem plugin, and also remove all gem plugins that you aren't using (gem
174
- uninstall gem_name).
175
-
176
-
177
-
178
- January 2020 BUNDLE-EXEC(1)
@@ -1,91 +0,0 @@
1
- BUNDLE-GEM(1) BUNDLE-GEM(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-gem - Generate a project skeleton for creating a rubygem
7
-
8
- SYNOPSIS
9
- bundle gem GEM_NAME OPTIONS
10
-
11
- DESCRIPTION
12
- Generates a directory named GEM_NAME with a Rakefile, GEM_NAME.gemspec,
13
- and other supporting files and directories that can be used to develop
14
- a rubygem with that name.
15
-
16
- Run rake -T in the resulting project for a list of Rake tasks that can
17
- be used to test and publish the gem to rubygems.org.
18
-
19
- The generated project skeleton can be customized with OPTIONS, as
20
- explained below. Note that these options can also be specified via
21
- Bundler's global configuration file using the following names:
22
-
23
- o gem.coc
24
-
25
- o gem.mit
26
-
27
- o gem.test
28
-
29
-
30
-
31
- OPTIONS
32
- --exe or -b or --bin
33
- Specify that Bundler should create a binary executable (as
34
- exe/GEM_NAME) in the generated rubygem project. This binary will
35
- also be added to the GEM_NAME.gemspec manifest. This behavior is
36
- disabled by default.
37
-
38
- --no-exe
39
- Do not create a binary (overrides --exe specified in the global
40
- config).
41
-
42
- --coc Add a CODE_OF_CONDUCT.md file to the root of the generated
43
- project. If this option is unspecified, an interactive prompt
44
- will be displayed and the answer will be saved in Bundler's
45
- global config for future bundle gem use.
46
-
47
- --no-coc
48
- Do not create a CODE_OF_CONDUCT.md (overrides --coc specified in
49
- the global config).
50
-
51
- --ext Add boilerplate for C extension code to the generated project.
52
- This behavior is disabled by default.
53
-
54
- --no-ext
55
- Do not add C extension code (overrides --ext specified in the
56
- global config).
57
-
58
- --mit Add an MIT license to a LICENSE.txt file in the root of the gen-
59
- erated project. Your name from the global git config is used for
60
- the copyright statement. If this option is unspecified, an
61
- interactive prompt will be displayed and the answer will be
62
- saved in Bundler's global config for future bundle gem use.
63
-
64
- --no-mit
65
- Do not create a LICENSE.txt (overrides --mit specified in the
66
- global config).
67
-
68
- -t, --test=minitest, --test=rspec
69
- Specify the test framework that Bundler should use when generat-
70
- ing the project. Acceptable values are minitest and rspec. The
71
- GEM_NAME.gemspec will be configured and a skeleton test/spec
72
- directory will be created based on this option. If this option
73
- is unspecified, an interactive prompt will be displayed and the
74
- answer will be saved in Bundler's global config for future bun-
75
- dle gem use. If no option is specified, the default testing
76
- framework is RSpec.
77
-
78
- -e, --edit[=EDITOR]
79
- Open the resulting GEM_NAME.gemspec in EDITOR, or the default
80
- editor if not specified. The default is $BUNDLER_EDITOR, $VIS-
81
- UAL, or $EDITOR.
82
-
83
- SEE ALSO
84
- o bundle config(1) bundle-config.1.html
85
-
86
-
87
-
88
-
89
-
90
-
91
- January 2020 BUNDLE-GEM(1)
@@ -1,21 +0,0 @@
1
- BUNDLE-INFO(1) BUNDLE-INFO(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-info - Show information for the given gem in your bundle
7
-
8
- SYNOPSIS
9
- bundle info [GEM] [--path]
10
-
11
- DESCRIPTION
12
- Print the basic information about the provided GEM such as homepage,
13
- version, path and summary.
14
-
15
- OPTIONS
16
- --path Print the path of the given gem
17
-
18
-
19
-
20
-
21
- January 2020 BUNDLE-INFO(1)
@@ -1,34 +0,0 @@
1
- BUNDLE-INIT(1) BUNDLE-INIT(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-init - Generates a Gemfile into the current working directory
7
-
8
- SYNOPSIS
9
- bundle init [--gemspec=FILE]
10
-
11
- DESCRIPTION
12
- Init generates a default [Gemfile(5)][Gemfile(5)] in the current work-
13
- ing directory. When adding a [Gemfile(5)][Gemfile(5)] to a gem with a
14
- gemspec, the --gemspec option will automatically add each dependency
15
- listed in the gemspec file to the newly created [Gemfile(5)][Gem-
16
- file(5)].
17
-
18
- OPTIONS
19
- --gemspec
20
- Use the specified .gemspec to create the [Gemfile(5)][Gem-
21
- file(5)]
22
-
23
- FILES
24
- Included in the default [Gemfile(5)][Gemfile(5)] generated is the line
25
- # frozen_string_literal: true. This is a magic comment supported for
26
- the first time in Ruby 2.3. The presence of this line results in all
27
- string literals in the file being implicitly frozen.
28
-
29
- SEE ALSO
30
- Gemfile(5) https://bundler.io/man/gemfile.5.html
31
-
32
-
33
-
34
- January 2020 BUNDLE-INIT(1)
@@ -1,32 +0,0 @@
1
- BUNDLE-INJECT(1) BUNDLE-INJECT(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-inject - Add named gem(s) with version requirements to Gemfile
7
-
8
- SYNOPSIS
9
- bundle inject [GEM] [VERSION]
10
-
11
- DESCRIPTION
12
- Adds the named gem(s) with their version requirements to the resolved
13
- [Gemfile(5)][Gemfile(5)].
14
-
15
- This command will add the gem to both your [Gemfile(5)][Gemfile(5)] and
16
- Gemfile.lock if it isn't listed yet.
17
-
18
- Example:
19
-
20
-
21
-
22
- bundle install
23
- bundle inject 'rack' '> 0'
24
-
25
-
26
-
27
- This will inject the 'rack' gem with a version greater than 0 in your
28
- [Gemfile(5)][Gemfile(5)] and Gemfile.lock
29
-
30
-
31
-
32
- January 2020 BUNDLE-INJECT(1)
@@ -1,401 +0,0 @@
1
- BUNDLE-INSTALL(1) BUNDLE-INSTALL(1)
2
-
3
-
4
-
5
- NAME
6
- bundle-install - Install the dependencies specified in your Gemfile
7
-
8
- SYNOPSIS
9
- bundle install [--binstubs[=DIRECTORY]] [--clean] [--deployment]
10
- [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER] [--local]
11
- [--no-cache] [--no-prune] [--path PATH] [--quiet] [--redownload]
12
- [--retry=NUMBER] [--shebang] [--standalone[=GROUP[ GROUP...]]] [--sys-
13
- tem] [--trust-policy=POLICY] [--with=GROUP[ GROUP...]] [--with-
14
- out=GROUP[ GROUP...]]
15
-
16
- DESCRIPTION
17
- Install the gems specified in your Gemfile(5). If this is the first
18
- time you run bundle install (and a Gemfile.lock does not exist),
19
- Bundler will fetch all remote sources, resolve dependencies and install
20
- all needed gems.
21
-
22
- If a Gemfile.lock does exist, and you have not updated your Gemfile(5),
23
- Bundler will fetch all remote sources, but use the dependencies speci-
24
- fied in the Gemfile.lock instead of resolving dependencies.
25
-
26
- If a Gemfile.lock does exist, and you have updated your Gemfile(5),
27
- Bundler will use the dependencies in the Gemfile.lock for all gems that
28
- you did not update, but will re-resolve the dependencies of gems that
29
- you did update. You can find more information about this update process
30
- below under CONSERVATIVE UPDATING.
31
-
32
- OPTIONS
33
- To apply any of --binstubs, --deployment, --path, or --without every
34
- time bundle install is run, use bundle config (see bundle-config(1)).
35
-
36
- --binstubs[=<directory>]
37
- Binstubs are scripts that wrap around executables. Bundler cre-
38
- ates a small Ruby file (a binstub) that loads Bundler, runs the
39
- command, and puts it in bin/. This lets you link the binstub
40
- inside of an application to the exact gem version the applica-
41
- tion needs.
42
-
43
- Creates a directory (defaults to ~/bin) and places any executa-
44
- bles from the gem there. These executables run in Bundler's con-
45
- text. If used, you might add this directory to your environ-
46
- ment's PATH variable. For instance, if the rails gem comes with
47
- a rails executable, this flag will create a bin/rails executable
48
- that ensures that all referred dependencies will be resolved
49
- using the bundled gems.
50
-
51
- --clean
52
- On finishing the installation Bundler is going to remove any
53
- gems not present in the current Gemfile(5). Don't worry, gems
54
- currently in use will not be removed.
55
-
56
- --deployment
57
- In deployment mode, Bundler will 'roll-out' the bundle for pro-
58
- duction or CI use. Please check carefully if you want to have
59
- this option enabled in your development environment.
60
-
61
- --redownload
62
- Force download every gem, even if the required versions are
63
- already available locally.
64
-
65
- --frozen
66
- Do not allow the Gemfile.lock to be updated after this install.
67
- Exits non-zero if there are going to be changes to the Gem-
68
- file.lock.
69
-
70
- --full-index
71
- Bundler will not call Rubygems' API endpoint (default) but down-
72
- load and cache a (currently big) index file of all gems. Perfor-
73
- mance can be improved for large bundles that seldom change by
74
- enabling this option.
75
-
76
- --gemfile=<gemfile>
77
- The location of the Gemfile(5) which Bundler should use. This
78
- defaults to a Gemfile(5) in the current working directory. In
79
- general, Bundler will assume that the location of the Gemfile(5)
80
- is also the project's root and will try to find Gemfile.lock and
81
- vendor/cache relative to this location.
82
-
83
- --jobs=[<number>], -j[<number>]
84
- The maximum number of parallel download and install jobs. The
85
- default is 1.
86
-
87
- --local
88
- Do not attempt to connect to rubygems.org. Instead, Bundler will
89
- use the gems already present in Rubygems' cache or in ven-
90
- dor/cache. Note that if a appropriate platform-specific gem
91
- exists on rubygems.org it will not be found.
92
-
93
- --no-cache
94
- Do not update the cache in vendor/cache with the newly bundled
95
- gems. This does not remove any gems in the cache but keeps the
96
- newly bundled gems from being cached during the install.
97
-
98
- --no-prune
99
- Don't remove stale gems from the cache when the installation
100
- finishes.
101
-
102
- --path=<path>
103
- The location to install the specified gems to. This defaults to
104
- Rubygems' setting. Bundler shares this location with Rubygems,
105
- gem install ... will have gem installed there, too. Therefore,
106
- gems installed without a --path ... setting will show up by
107
- calling gem list. Accordingly, gems installed to other locations
108
- will not get listed.
109
-
110
- --quiet
111
- Do not print progress information to the standard output.
112
- Instead, Bundler will exit using a status code ($?).
113
-
114
- --retry=[<number>]
115
- Retry failed network or git requests for number times.
116
-
117
- --shebang=<ruby-executable>
118
- Uses the specified ruby executable (usually ruby) to execute the
119
- scripts created with --binstubs. In addition, if you use --bin-
120
- stubs together with --shebang jruby these executables will be
121
- changed to execute jruby instead.
122
-
123
- --standalone[=<list>]
124
- Makes a bundle that can work without depending on Rubygems or
125
- Bundler at runtime. A space separated list of groups to install
126
- has to be specified. Bundler creates a directory named bundle
127
- and installs the bundle there. It also generates a bun-
128
- dle/bundler/setup.rb file to replace Bundler's own setup in the
129
- manner required. Using this option implicitly sets path, which
130
- is a [remembered option][REMEMBERED OPTIONS].
131
-
132
- --system
133
- Installs the gems specified in the bundle to the system's
134
- Rubygems location. This overrides any previous configuration of
135
- --path.
136
-
137
- --trust-policy=[<policy>]
138
- Apply the Rubygems security policy policy, where policy is one
139
- of HighSecurity, MediumSecurity, LowSecurity, AlmostNoSecurity,
140
- or NoSecurity. For more details, please see the Rubygems signing
141
- documentation linked below in SEE ALSO.
142
-
143
- --with=<list>
144
- A space-separated list of groups referencing gems to install. If
145
- an optional group is given it is installed. If a group is given
146
- that is in the remembered list of groups given to --without, it
147
- is removed from that list.
148
-
149
- --without=<list>
150
- A space-separated list of groups referencing gems to skip during
151
- installation. If a group is given that is in the remembered list
152
- of groups given to --with, it is removed from that list.
153
-
154
- DEPLOYMENT MODE
155
- Bundler's defaults are optimized for development. To switch to defaults
156
- optimized for deployment and for CI, use the --deployment flag. Do not
157
- activate deployment mode on development machines, as it will cause an
158
- error when the Gemfile(5) is modified.
159
-
160
- 1. A Gemfile.lock is required.
161
-
162
- To ensure that the same versions of the gems you developed with and
163
- tested with are also used in deployments, a Gemfile.lock is
164
- required.
165
-
166
- This is mainly to ensure that you remember to check your Gem-
167
- file.lock into version control.
168
-
169
- 2. The Gemfile.lock must be up to date
170
-
171
- In development, you can modify your Gemfile(5) and re-run bundle
172
- install to conservatively update your Gemfile.lock snapshot.
173
-
174
- In deployment, your Gemfile.lock should be up-to-date with changes
175
- made in your Gemfile(5).
176
-
177
- 3. Gems are installed to vendor/bundle not your default system loca-
178
- tion
179
-
180
- In development, it's convenient to share the gems used in your
181
- application with other applications and other scripts that run on
182
- the system.
183
-
184
- In deployment, isolation is a more important default. In addition,
185
- the user deploying the application may not have permission to
186
- install gems to the system, or the web server may not have permis-
187
- sion to read them.
188
-
189
- As a result, bundle install --deployment installs gems to the ven-
190
- dor/bundle directory in the application. This may be overridden
191
- using the --path option.
192
-
193
-
194
-
195
- SUDO USAGE
196
- By default, Bundler installs gems to the same location as gem install.
197
-
198
- In some cases, that location may not be writable by your Unix user. In
199
- that case, Bundler will stage everything in a temporary directory, then
200
- ask you for your sudo password in order to copy the gems into their
201
- system location.
202
-
203
- From your perspective, this is identical to installing the gems
204
- directly into the system.
205
-
206
- You should never use sudo bundle install. This is because several other
207
- steps in bundle install must be performed as the current user:
208
-
209
- o Updating your Gemfile.lock
210
-
211
- o Updating your vendor/cache, if necessary
212
-
213
- o Checking out private git repositories using your user's SSH keys
214
-
215
-
216
-
217
- Of these three, the first two could theoretically be performed by
218
- chowning the resulting files to $SUDO_USER. The third, however, can
219
- only be performed by invoking the git command as the current user.
220
- Therefore, git gems are downloaded and installed into ~/.bundle rather
221
- than $GEM_HOME or $BUNDLE_PATH.
222
-
223
- As a result, you should run bundle install as the current user, and
224
- Bundler will ask for your password if it is needed to put the gems into
225
- their final location.
226
-
227
- INSTALLING GROUPS
228
- By default, bundle install will install all gems in all groups in your
229
- Gemfile(5), except those declared for a different platform.
230
-
231
- However, you can explicitly tell Bundler to skip installing certain
232
- groups with the --without option. This option takes a space-separated
233
- list of groups.
234
-
235
- While the --without option will skip installing the gems in the speci-
236
- fied groups, it will still download those gems and use them to resolve
237
- the dependencies of every gem in your Gemfile(5).
238
-
239
- This is so that installing a different set of groups on another machine
240
- (such as a production server) will not change the gems and versions
241
- that you have already developed and tested against.
242
-
243
- Bundler offers a rock-solid guarantee that the third-party code you are
244
- running in development and testing is also the third-party code you are
245
- running in production. You can choose to exclude some of that code in
246
- different environments, but you will never be caught flat-footed by
247
- different versions of third-party code being used in different environ-
248
- ments.
249
-
250
- For a simple illustration, consider the following Gemfile(5):
251
-
252
-
253
-
254
- source 'https://rubygems.org'
255
-
256
- gem 'sinatra'
257
-
258
- group :production do
259
- gem 'rack-perftools-profiler'
260
- end
261
-
262
-
263
-
264
- In this case, sinatra depends on any version of Rack (>= 1.0), while
265
- rack-perftools-profiler depends on 1.x (~> 1.0).
266
-
267
- When you run bundle install --without production in development, we
268
- look at the dependencies of rack-perftools-profiler as well. That way,
269
- you do not spend all your time developing against Rack 2.0, using new
270
- APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2
271
- when the production group is used.
272
-
273
- This should not cause any problems in practice, because we do not
274
- attempt to install the gems in the excluded groups, and only evaluate
275
- as part of the dependency resolution process.
276
-
277
- This also means that you cannot include different versions of the same
278
- gem in different groups, because doing so would result in different
279
- sets of dependencies used in development and production. Because of the
280
- vagaries of the dependency resolution process, this usually affects
281
- more than the gems you list in your Gemfile(5), and can (surprisingly)
282
- radically change the gems you are using.
283
-
284
- THE GEMFILE.LOCK
285
- When you run bundle install, Bundler will persist the full names and
286
- versions of all gems that you used (including dependencies of the gems
287
- specified in the Gemfile(5)) into a file called Gemfile.lock.
288
-
289
- Bundler uses this file in all subsequent calls to bundle install, which
290
- guarantees that you always use the same exact code, even as your appli-
291
- cation moves across machines.
292
-
293
- Because of the way dependency resolution works, even a seemingly small
294
- change (for instance, an update to a point-release of a dependency of a
295
- gem in your Gemfile(5)) can result in radically different gems being
296
- needed to satisfy all dependencies.
297
-
298
- As a result, you SHOULD check your Gemfile.lock into version control,
299
- in both applications and gems. If you do not, every machine that checks
300
- out your repository (including your production server) will resolve all
301
- dependencies again, which will result in different versions of
302
- third-party code being used if any of the gems in the Gemfile(5) or any
303
- of their dependencies have been updated.
304
-
305
- When Bundler first shipped, the Gemfile.lock was included in the .git-
306
- ignore file included with generated gems. Over time, however, it became
307
- clear that this practice forces the pain of broken dependencies onto
308
- new contributors, while leaving existing contributors potentially
309
- unaware of the problem. Since bundle install is usually the first step
310
- towards a contribution, the pain of broken dependencies would discour-
311
- age new contributors from contributing. As a result, we have revised
312
- our guidance for gem authors to now recommend checking in the lock for
313
- gems.
314
-
315
- CONSERVATIVE UPDATING
316
- When you make a change to the Gemfile(5) and then run bundle install,
317
- Bundler will update only the gems that you modified.
318
-
319
- In other words, if a gem that you did not modify worked before you
320
- called bundle install, it will continue to use the exact same versions
321
- of all dependencies as it used before the update.
322
-
323
- Let's take a look at an example. Here's your original Gemfile(5):
324
-
325
-
326
-
327
- source 'https://rubygems.org'
328
-
329
- gem 'actionpack', '2.3.8'
330
- gem 'activemerchant'
331
-
332
-
333
-
334
- In this case, both actionpack and activemerchant depend on activesup-
335
- port. The actionpack gem depends on activesupport 2.3.8 and rack ~>
336
- 1.1.0, while the activemerchant gem depends on activesupport >= 2.3.2,
337
- braintree >= 2.0.0, and builder >= 2.0.0.
338
-
339
- When the dependencies are first resolved, Bundler will select
340
- activesupport 2.3.8, which satisfies the requirements of both gems in
341
- your Gemfile(5).
342
-
343
- Next, you modify your Gemfile(5) to:
344
-
345
-
346
-
347
- source 'https://rubygems.org'
348
-
349
- gem 'actionpack', '3.0.0.rc'
350
- gem 'activemerchant'
351
-
352
-
353
-
354
- The actionpack 3.0.0.rc gem has a number of new dependencies, and
355
- updates the activesupport dependency to = 3.0.0.rc and the rack depen-
356
- dency to ~> 1.2.1.
357
-
358
- When you run bundle install, Bundler notices that you changed the
359
- actionpack gem, but not the activemerchant gem. It evaluates the gems
360
- currently being used to satisfy its requirements:
361
-
362
- activesupport 2.3.8
363
- also used to satisfy a dependency in activemerchant, which is
364
- not being updated
365
-
366
- rack ~> 1.1.0
367
- not currently being used to satisfy another dependency
368
-
369
- Because you did not explicitly ask to update activemerchant, you would
370
- not expect it to suddenly stop working after updating actionpack. How-
371
- ever, satisfying the new activesupport 3.0.0.rc dependency of action-
372
- pack requires updating one of its dependencies.
373
-
374
- Even though activemerchant declares a very loose dependency that theo-
375
- retically matches activesupport 3.0.0.rc, Bundler treats gems in your
376
- Gemfile(5) that have not changed as an atomic unit together with their
377
- dependencies. In this case, the activemerchant dependency is treated as
378
- activemerchant 1.7.1 + activesupport 2.3.8, so bundle install will
379
- report that it cannot update actionpack.
380
-
381
- To explicitly update actionpack, including its dependencies which other
382
- gems in the Gemfile(5) still depend on, run bundle update actionpack
383
- (see bundle update(1)).
384
-
385
- Summary: In general, after making a change to the Gemfile(5) , you
386
- should first try to run bundle install, which will guarantee that no
387
- other gem in the Gemfile(5) is impacted by the change. If that does not
388
- work, run bundle update(1) bundle-update.1.html.
389
-
390
- SEE ALSO
391
- o Gem install docs
392
- http://guides.rubygems.org/rubygems-basics/#installing-gems
393
-
394
- o Rubygems signing docs http://guides.rubygems.org/security/
395
-
396
-
397
-
398
-
399
-
400
-
401
- January 2020 BUNDLE-INSTALL(1)