bundler 2.0.2

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 (303) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +3111 -0
  3. data/LICENSE.md +23 -0
  4. data/README.md +63 -0
  5. data/bundler.gemspec +65 -0
  6. data/exe/bundle +31 -0
  7. data/exe/bundle_ruby +60 -0
  8. data/exe/bundler +4 -0
  9. data/lib/bundler.rb +567 -0
  10. data/lib/bundler/build_metadata.rb +53 -0
  11. data/lib/bundler/capistrano.rb +22 -0
  12. data/lib/bundler/cli.rb +792 -0
  13. data/lib/bundler/cli/add.rb +35 -0
  14. data/lib/bundler/cli/binstubs.rb +49 -0
  15. data/lib/bundler/cli/cache.rb +36 -0
  16. data/lib/bundler/cli/check.rb +38 -0
  17. data/lib/bundler/cli/clean.rb +25 -0
  18. data/lib/bundler/cli/common.rb +102 -0
  19. data/lib/bundler/cli/config.rb +119 -0
  20. data/lib/bundler/cli/console.rb +43 -0
  21. data/lib/bundler/cli/doctor.rb +140 -0
  22. data/lib/bundler/cli/exec.rb +105 -0
  23. data/lib/bundler/cli/gem.rb +252 -0
  24. data/lib/bundler/cli/info.rb +50 -0
  25. data/lib/bundler/cli/init.rb +47 -0
  26. data/lib/bundler/cli/inject.rb +60 -0
  27. data/lib/bundler/cli/install.rb +218 -0
  28. data/lib/bundler/cli/issue.rb +40 -0
  29. data/lib/bundler/cli/list.rb +58 -0
  30. data/lib/bundler/cli/lock.rb +63 -0
  31. data/lib/bundler/cli/open.rb +26 -0
  32. data/lib/bundler/cli/outdated.rb +266 -0
  33. data/lib/bundler/cli/package.rb +49 -0
  34. data/lib/bundler/cli/platform.rb +46 -0
  35. data/lib/bundler/cli/plugin.rb +24 -0
  36. data/lib/bundler/cli/pristine.rb +47 -0
  37. data/lib/bundler/cli/remove.rb +18 -0
  38. data/lib/bundler/cli/show.rb +75 -0
  39. data/lib/bundler/cli/update.rb +91 -0
  40. data/lib/bundler/cli/viz.rb +31 -0
  41. data/lib/bundler/compact_index_client.rb +109 -0
  42. data/lib/bundler/compact_index_client/cache.rb +118 -0
  43. data/lib/bundler/compact_index_client/updater.rb +116 -0
  44. data/lib/bundler/compatibility_guard.rb +13 -0
  45. data/lib/bundler/constants.rb +7 -0
  46. data/lib/bundler/current_ruby.rb +94 -0
  47. data/lib/bundler/definition.rb +995 -0
  48. data/lib/bundler/dep_proxy.rb +48 -0
  49. data/lib/bundler/dependency.rb +139 -0
  50. data/lib/bundler/deployment.rb +69 -0
  51. data/lib/bundler/deprecate.rb +44 -0
  52. data/lib/bundler/dsl.rb +615 -0
  53. data/lib/bundler/endpoint_specification.rb +141 -0
  54. data/lib/bundler/env.rb +149 -0
  55. data/lib/bundler/environment_preserver.rb +59 -0
  56. data/lib/bundler/errors.rb +158 -0
  57. data/lib/bundler/feature_flag.rb +75 -0
  58. data/lib/bundler/fetcher.rb +312 -0
  59. data/lib/bundler/fetcher/base.rb +52 -0
  60. data/lib/bundler/fetcher/compact_index.rb +126 -0
  61. data/lib/bundler/fetcher/dependency.rb +82 -0
  62. data/lib/bundler/fetcher/downloader.rb +84 -0
  63. data/lib/bundler/fetcher/index.rb +52 -0
  64. data/lib/bundler/friendly_errors.rb +131 -0
  65. data/lib/bundler/gem_helper.rb +217 -0
  66. data/lib/bundler/gem_helpers.rb +101 -0
  67. data/lib/bundler/gem_remote_fetcher.rb +43 -0
  68. data/lib/bundler/gem_tasks.rb +7 -0
  69. data/lib/bundler/gem_version_promoter.rb +190 -0
  70. data/lib/bundler/gemdeps.rb +29 -0
  71. data/lib/bundler/graph.rb +152 -0
  72. data/lib/bundler/index.rb +213 -0
  73. data/lib/bundler/injector.rb +253 -0
  74. data/lib/bundler/inline.rb +74 -0
  75. data/lib/bundler/installer.rb +318 -0
  76. data/lib/bundler/installer/gem_installer.rb +85 -0
  77. data/lib/bundler/installer/parallel_installer.rb +229 -0
  78. data/lib/bundler/installer/standalone.rb +53 -0
  79. data/lib/bundler/lazy_specification.rb +123 -0
  80. data/lib/bundler/lockfile_generator.rb +95 -0
  81. data/lib/bundler/lockfile_parser.rb +256 -0
  82. data/lib/bundler/match_platform.rb +24 -0
  83. data/lib/bundler/mirror.rb +223 -0
  84. data/lib/bundler/plugin.rb +294 -0
  85. data/lib/bundler/plugin/api.rb +81 -0
  86. data/lib/bundler/plugin/api/source.rb +306 -0
  87. data/lib/bundler/plugin/dsl.rb +53 -0
  88. data/lib/bundler/plugin/events.rb +61 -0
  89. data/lib/bundler/plugin/index.rb +165 -0
  90. data/lib/bundler/plugin/installer.rb +96 -0
  91. data/lib/bundler/plugin/installer/git.rb +38 -0
  92. data/lib/bundler/plugin/installer/rubygems.rb +27 -0
  93. data/lib/bundler/plugin/source_list.rb +27 -0
  94. data/lib/bundler/process_lock.rb +24 -0
  95. data/lib/bundler/psyched_yaml.rb +37 -0
  96. data/lib/bundler/remote_specification.rb +114 -0
  97. data/lib/bundler/resolver.rb +373 -0
  98. data/lib/bundler/resolver/spec_group.rb +106 -0
  99. data/lib/bundler/retry.rb +66 -0
  100. data/lib/bundler/ruby_dsl.rb +18 -0
  101. data/lib/bundler/ruby_version.rb +152 -0
  102. data/lib/bundler/rubygems_ext.rb +209 -0
  103. data/lib/bundler/rubygems_gem_installer.rb +99 -0
  104. data/lib/bundler/rubygems_integration.rb +915 -0
  105. data/lib/bundler/runtime.rb +322 -0
  106. data/lib/bundler/settings.rb +464 -0
  107. data/lib/bundler/settings/validator.rb +102 -0
  108. data/lib/bundler/setup.rb +28 -0
  109. data/lib/bundler/shared_helpers.rb +386 -0
  110. data/lib/bundler/similarity_detector.rb +63 -0
  111. data/lib/bundler/source.rb +94 -0
  112. data/lib/bundler/source/gemspec.rb +18 -0
  113. data/lib/bundler/source/git.rb +329 -0
  114. data/lib/bundler/source/git/git_proxy.rb +262 -0
  115. data/lib/bundler/source/metadata.rb +62 -0
  116. data/lib/bundler/source/path.rb +249 -0
  117. data/lib/bundler/source/path/installer.rb +74 -0
  118. data/lib/bundler/source/rubygems.rb +539 -0
  119. data/lib/bundler/source/rubygems/remote.rb +69 -0
  120. data/lib/bundler/source_list.rb +186 -0
  121. data/lib/bundler/spec_set.rb +208 -0
  122. data/lib/bundler/ssl_certs/.document +1 -0
  123. data/lib/bundler/ssl_certs/certificate_manager.rb +66 -0
  124. data/lib/bundler/ssl_certs/index.rubygems.org/GlobalSignRootCA.pem +21 -0
  125. data/lib/bundler/ssl_certs/rubygems.global.ssl.fastly.net/DigiCertHighAssuranceEVRootCA.pem +23 -0
  126. data/lib/bundler/ssl_certs/rubygems.org/AddTrustExternalCARoot.pem +25 -0
  127. data/lib/bundler/stub_specification.rb +108 -0
  128. data/lib/bundler/templates/.document +1 -0
  129. data/lib/bundler/templates/Executable +29 -0
  130. data/lib/bundler/templates/Executable.bundler +105 -0
  131. data/lib/bundler/templates/Executable.standalone +14 -0
  132. data/lib/bundler/templates/Gemfile +7 -0
  133. data/lib/bundler/templates/gems.rb +8 -0
  134. data/lib/bundler/templates/newgem/CODE_OF_CONDUCT.md.tt +74 -0
  135. data/lib/bundler/templates/newgem/Gemfile.tt +4 -0
  136. data/lib/bundler/templates/newgem/LICENSE.txt.tt +21 -0
  137. data/lib/bundler/templates/newgem/README.md.tt +47 -0
  138. data/lib/bundler/templates/newgem/Rakefile.tt +29 -0
  139. data/lib/bundler/templates/newgem/bin/console.tt +14 -0
  140. data/lib/bundler/templates/newgem/bin/setup.tt +8 -0
  141. data/lib/bundler/templates/newgem/exe/newgem.tt +3 -0
  142. data/lib/bundler/templates/newgem/ext/newgem/extconf.rb.tt +3 -0
  143. data/lib/bundler/templates/newgem/ext/newgem/newgem.c.tt +9 -0
  144. data/lib/bundler/templates/newgem/ext/newgem/newgem.h.tt +6 -0
  145. data/lib/bundler/templates/newgem/gitignore.tt +20 -0
  146. data/lib/bundler/templates/newgem/lib/newgem.rb.tt +13 -0
  147. data/lib/bundler/templates/newgem/lib/newgem/version.rb.tt +7 -0
  148. data/lib/bundler/templates/newgem/newgem.gemspec.tt +50 -0
  149. data/lib/bundler/templates/newgem/rspec.tt +3 -0
  150. data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +9 -0
  151. data/lib/bundler/templates/newgem/spec/spec_helper.rb.tt +14 -0
  152. data/lib/bundler/templates/newgem/test/newgem_test.rb.tt +11 -0
  153. data/lib/bundler/templates/newgem/test/test_helper.rb.tt +8 -0
  154. data/lib/bundler/templates/newgem/travis.yml.tt +7 -0
  155. data/lib/bundler/ui.rb +9 -0
  156. data/lib/bundler/ui/rg_proxy.rb +19 -0
  157. data/lib/bundler/ui/shell.rb +146 -0
  158. data/lib/bundler/ui/silent.rb +69 -0
  159. data/lib/bundler/uri_credentials_filter.rb +37 -0
  160. data/lib/bundler/vendor/fileutils/lib/fileutils.rb +1741 -0
  161. data/lib/bundler/vendor/fileutils/lib/fileutils/version.rb +5 -0
  162. data/lib/bundler/vendor/molinillo/lib/molinillo.rb +12 -0
  163. data/lib/bundler/vendor/molinillo/lib/molinillo/compatibility.rb +26 -0
  164. data/lib/bundler/vendor/molinillo/lib/molinillo/delegates/resolution_state.rb +57 -0
  165. data/lib/bundler/vendor/molinillo/lib/molinillo/delegates/specification_provider.rb +81 -0
  166. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph.rb +223 -0
  167. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/action.rb +36 -0
  168. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_edge_no_circular.rb +66 -0
  169. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/add_vertex.rb +62 -0
  170. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/delete_edge.rb +63 -0
  171. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/detach_vertex_named.rb +61 -0
  172. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/log.rb +126 -0
  173. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/set_payload.rb +46 -0
  174. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/tag.rb +36 -0
  175. data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/vertex.rb +136 -0
  176. data/lib/bundler/vendor/molinillo/lib/molinillo/errors.rb +143 -0
  177. data/lib/bundler/vendor/molinillo/lib/molinillo/gem_metadata.rb +6 -0
  178. data/lib/bundler/vendor/molinillo/lib/molinillo/modules/specification_provider.rb +101 -0
  179. data/lib/bundler/vendor/molinillo/lib/molinillo/modules/ui.rb +67 -0
  180. data/lib/bundler/vendor/molinillo/lib/molinillo/resolution.rb +837 -0
  181. data/lib/bundler/vendor/molinillo/lib/molinillo/resolver.rb +46 -0
  182. data/lib/bundler/vendor/molinillo/lib/molinillo/state.rb +58 -0
  183. data/lib/bundler/vendor/net-http-persistent/lib/net/http/faster.rb +27 -0
  184. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +1233 -0
  185. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/ssl_reuse.rb +129 -0
  186. data/lib/bundler/vendor/thor/lib/thor.rb +509 -0
  187. data/lib/bundler/vendor/thor/lib/thor/actions.rb +331 -0
  188. data/lib/bundler/vendor/thor/lib/thor/actions/create_file.rb +104 -0
  189. data/lib/bundler/vendor/thor/lib/thor/actions/create_link.rb +60 -0
  190. data/lib/bundler/vendor/thor/lib/thor/actions/directory.rb +118 -0
  191. data/lib/bundler/vendor/thor/lib/thor/actions/empty_directory.rb +143 -0
  192. data/lib/bundler/vendor/thor/lib/thor/actions/file_manipulation.rb +373 -0
  193. data/lib/bundler/vendor/thor/lib/thor/actions/inject_into_file.rb +109 -0
  194. data/lib/bundler/vendor/thor/lib/thor/base.rb +678 -0
  195. data/lib/bundler/vendor/thor/lib/thor/command.rb +135 -0
  196. data/lib/bundler/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +97 -0
  197. data/lib/bundler/vendor/thor/lib/thor/core_ext/io_binary_read.rb +12 -0
  198. data/lib/bundler/vendor/thor/lib/thor/core_ext/ordered_hash.rb +129 -0
  199. data/lib/bundler/vendor/thor/lib/thor/error.rb +114 -0
  200. data/lib/bundler/vendor/thor/lib/thor/group.rb +281 -0
  201. data/lib/bundler/vendor/thor/lib/thor/invocation.rb +177 -0
  202. data/lib/bundler/vendor/thor/lib/thor/line_editor.rb +17 -0
  203. data/lib/bundler/vendor/thor/lib/thor/line_editor/basic.rb +37 -0
  204. data/lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb +88 -0
  205. data/lib/bundler/vendor/thor/lib/thor/parser.rb +4 -0
  206. data/lib/bundler/vendor/thor/lib/thor/parser/argument.rb +70 -0
  207. data/lib/bundler/vendor/thor/lib/thor/parser/arguments.rb +175 -0
  208. data/lib/bundler/vendor/thor/lib/thor/parser/option.rb +146 -0
  209. data/lib/bundler/vendor/thor/lib/thor/parser/options.rb +226 -0
  210. data/lib/bundler/vendor/thor/lib/thor/rake_compat.rb +71 -0
  211. data/lib/bundler/vendor/thor/lib/thor/runner.rb +324 -0
  212. data/lib/bundler/vendor/thor/lib/thor/shell.rb +81 -0
  213. data/lib/bundler/vendor/thor/lib/thor/shell/basic.rb +482 -0
  214. data/lib/bundler/vendor/thor/lib/thor/shell/color.rb +149 -0
  215. data/lib/bundler/vendor/thor/lib/thor/shell/html.rb +126 -0
  216. data/lib/bundler/vendor/thor/lib/thor/util.rb +268 -0
  217. data/lib/bundler/vendor/thor/lib/thor/version.rb +3 -0
  218. data/lib/bundler/vendored_fileutils.rb +9 -0
  219. data/lib/bundler/vendored_molinillo.rb +4 -0
  220. data/lib/bundler/vendored_persistent.rb +52 -0
  221. data/lib/bundler/vendored_thor.rb +8 -0
  222. data/lib/bundler/version.rb +28 -0
  223. data/lib/bundler/version_ranges.rb +76 -0
  224. data/lib/bundler/vlad.rb +17 -0
  225. data/lib/bundler/worker.rb +106 -0
  226. data/lib/bundler/yaml_serializer.rb +90 -0
  227. data/man/bundle-add.1 +58 -0
  228. data/man/bundle-add.1.txt +52 -0
  229. data/man/bundle-add.ronn +40 -0
  230. data/man/bundle-binstubs.1 +40 -0
  231. data/man/bundle-binstubs.1.txt +48 -0
  232. data/man/bundle-binstubs.ronn +43 -0
  233. data/man/bundle-check.1 +31 -0
  234. data/man/bundle-check.1.txt +33 -0
  235. data/man/bundle-check.ronn +26 -0
  236. data/man/bundle-clean.1 +24 -0
  237. data/man/bundle-clean.1.txt +26 -0
  238. data/man/bundle-clean.ronn +18 -0
  239. data/man/bundle-config.1 +497 -0
  240. data/man/bundle-config.1.txt +529 -0
  241. data/man/bundle-config.ronn +397 -0
  242. data/man/bundle-doctor.1 +44 -0
  243. data/man/bundle-doctor.1.txt +44 -0
  244. data/man/bundle-doctor.ronn +33 -0
  245. data/man/bundle-exec.1 +165 -0
  246. data/man/bundle-exec.1.txt +178 -0
  247. data/man/bundle-exec.ronn +152 -0
  248. data/man/bundle-gem.1 +80 -0
  249. data/man/bundle-gem.1.txt +91 -0
  250. data/man/bundle-gem.ronn +78 -0
  251. data/man/bundle-info.1 +20 -0
  252. data/man/bundle-info.1.txt +21 -0
  253. data/man/bundle-info.ronn +17 -0
  254. data/man/bundle-init.1 +25 -0
  255. data/man/bundle-init.1.txt +34 -0
  256. data/man/bundle-init.ronn +29 -0
  257. data/man/bundle-inject.1 +33 -0
  258. data/man/bundle-inject.1.txt +32 -0
  259. data/man/bundle-inject.ronn +22 -0
  260. data/man/bundle-install.1 +308 -0
  261. data/man/bundle-install.1.txt +396 -0
  262. data/man/bundle-install.ronn +378 -0
  263. data/man/bundle-list.1 +50 -0
  264. data/man/bundle-list.1.txt +43 -0
  265. data/man/bundle-list.ronn +33 -0
  266. data/man/bundle-lock.1 +84 -0
  267. data/man/bundle-lock.1.txt +93 -0
  268. data/man/bundle-lock.ronn +94 -0
  269. data/man/bundle-open.1 +32 -0
  270. data/man/bundle-open.1.txt +29 -0
  271. data/man/bundle-open.ronn +19 -0
  272. data/man/bundle-outdated.1 +155 -0
  273. data/man/bundle-outdated.1.txt +131 -0
  274. data/man/bundle-outdated.ronn +111 -0
  275. data/man/bundle-package.1 +55 -0
  276. data/man/bundle-package.1.txt +79 -0
  277. data/man/bundle-package.ronn +72 -0
  278. data/man/bundle-platform.1 +61 -0
  279. data/man/bundle-platform.1.txt +57 -0
  280. data/man/bundle-platform.ronn +42 -0
  281. data/man/bundle-pristine.1 +34 -0
  282. data/man/bundle-pristine.1.txt +44 -0
  283. data/man/bundle-pristine.ronn +34 -0
  284. data/man/bundle-remove.1 +31 -0
  285. data/man/bundle-remove.1.txt +34 -0
  286. data/man/bundle-remove.ronn +23 -0
  287. data/man/bundle-show.1 +23 -0
  288. data/man/bundle-show.1.txt +27 -0
  289. data/man/bundle-show.ronn +21 -0
  290. data/man/bundle-update.1 +394 -0
  291. data/man/bundle-update.1.txt +391 -0
  292. data/man/bundle-update.ronn +350 -0
  293. data/man/bundle-viz.1 +39 -0
  294. data/man/bundle-viz.1.txt +39 -0
  295. data/man/bundle-viz.ronn +30 -0
  296. data/man/bundle.1 +136 -0
  297. data/man/bundle.1.txt +116 -0
  298. data/man/bundle.ronn +111 -0
  299. data/man/gemfile.5 +689 -0
  300. data/man/gemfile.5.ronn +521 -0
  301. data/man/gemfile.5.txt +653 -0
  302. data/man/index.txt +25 -0
  303. metadata +463 -0
@@ -0,0 +1,22 @@
1
+ bundle-inject(1) -- Add named gem(s) with version requirements to Gemfile
2
+ =========================================================================
3
+
4
+ ## SYNOPSIS
5
+
6
+ `bundle inject` [GEM] [VERSION]
7
+
8
+ ## DESCRIPTION
9
+
10
+ Adds the named gem(s) with their version requirements to the resolved
11
+ [`Gemfile(5)`][Gemfile(5)].
12
+
13
+ This command will add the gem to both your [`Gemfile(5)`][Gemfile(5)] and Gemfile.lock if it
14
+ isn't listed yet.
15
+
16
+ Example:
17
+
18
+ bundle install
19
+ bundle inject 'rack' '> 0'
20
+
21
+ This will inject the 'rack' gem with a version greater than 0 in your
22
+ [`Gemfile(5)`][Gemfile(5)] and Gemfile.lock
@@ -0,0 +1,308 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "BUNDLE\-INSTALL" "1" "June 2019" "" ""
5
+ .
6
+ .SH "NAME"
7
+ \fBbundle\-install\fR \- Install the dependencies specified in your Gemfile
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-force] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-quiet] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\.\.\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\.\.\.]] [\-\-without=GROUP[ GROUP\.\.\.]]
11
+ .
12
+ .SH "DESCRIPTION"
13
+ Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\.
14
+ .
15
+ .P
16
+ If a \fBGemfile\.lock\fR does exist, and you have not updated your Gemfile(5), Bundler will fetch all remote sources, but use the dependencies specified in the \fBGemfile\.lock\fR instead of resolving dependencies\.
17
+ .
18
+ .P
19
+ If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundler will use the dependencies in the \fBGemfile\.lock\fR for all gems that you did not update, but will re\-resolve the dependencies of gems that you did update\. You can find more information about this update process below under \fICONSERVATIVE UPDATING\fR\.
20
+ .
21
+ .SH "OPTIONS"
22
+ To apply any of \fB\-\-binstubs\fR, \fB\-\-deployment\fR, \fB\-\-path\fR, or \fB\-\-without\fR every time \fBbundle install\fR is run, use \fBbundle config\fR (see bundle\-config(1))\.
23
+ .
24
+ .TP
25
+ \fB\-\-binstubs[=<directory>]\fR
26
+ Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler\'s context\. If used, you might add this directory to your environment\'s \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
27
+ .
28
+ .TP
29
+ \fB\-\-clean\fR
30
+ On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don\'t worry, gems currently in use will not be removed\.
31
+ .
32
+ .TP
33
+ \fB\-\-deployment\fR
34
+ In \fIdeployment mode\fR, Bundler will \'roll\-out\' the bundle for production or CI use\. Please check carefully if you want to have this option enabled in your development environment\.
35
+ .
36
+ .TP
37
+ \fB\-\-force\fR
38
+ Force download every gem, even if the required versions are already available locally\. \fB\-\-redownload\fR is an alias of this option\.
39
+ .
40
+ .TP
41
+ \fB\-\-frozen\fR
42
+ Do not allow the Gemfile\.lock to be updated after this install\. Exits non\-zero if there are going to be changes to the Gemfile\.lock\.
43
+ .
44
+ .TP
45
+ \fB\-\-full\-index\fR
46
+ Bundler will not call Rubygems\' API endpoint (default) but download and cache a (currently big) index file of all gems\. Performance can be improved for large bundles that seldom change by enabling this option\.
47
+ .
48
+ .TP
49
+ \fB\-\-gemfile=<gemfile>\fR
50
+ The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project\'s root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
51
+ .
52
+ .TP
53
+ \fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
54
+ The maximum number of parallel download and install jobs\. The default is \fB1\fR\.
55
+ .
56
+ .TP
57
+ \fB\-\-local\fR
58
+ Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems\' cache or in \fBvendor/cache\fR\. Note that if a appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\.
59
+ .
60
+ .TP
61
+ \fB\-\-no\-cache\fR
62
+ Do not update the cache in \fBvendor/cache\fR with the newly bundled gems\. This does not remove any gems in the cache but keeps the newly bundled gems from being cached during the install\.
63
+ .
64
+ .TP
65
+ \fB\-\-no\-prune\fR
66
+ Don\'t remove stale gems from the cache when the installation finishes\.
67
+ .
68
+ .TP
69
+ \fB\-\-path=<path>\fR
70
+ The location to install the specified gems to\. This defaults to Rubygems\' setting\. Bundler shares this location with Rubygems, \fBgem install \.\.\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \.\.\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
71
+ .
72
+ .TP
73
+ \fB\-\-quiet\fR
74
+ Do not print progress information to the standard output\. Instead, Bundler will exit using a status code (\fB$?\fR)\.
75
+ .
76
+ .TP
77
+ \fB\-\-retry=[<number>]\fR
78
+ Retry failed network or git requests for \fInumber\fR times\.
79
+ .
80
+ .TP
81
+ \fB\-\-shebang=<ruby\-executable>\fR
82
+ Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\.
83
+ .
84
+ .TP
85
+ \fB\-\-standalone[=<list>]\fR
86
+ Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install has to be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler\'s own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
87
+ .
88
+ .TP
89
+ \fB\-\-system\fR
90
+ Installs the gems specified in the bundle to the system\'s Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\.
91
+ .
92
+ .TP
93
+ \fB\-\-trust\-policy=[<policy>]\fR
94
+ Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\.
95
+ .
96
+ .TP
97
+ \fB\-\-with=<list>\fR
98
+ A space\-separated list of groups referencing gems to install\. If an optional group is given it is installed\. If a group is given that is in the remembered list of groups given to \-\-without, it is removed from that list\.
99
+ .
100
+ .TP
101
+ \fB\-\-without=<list>\fR
102
+ A space\-separated list of groups referencing gems to skip during installation\. If a group is given that is in the remembered list of groups given to \-\-with, it is removed from that list\.
103
+ .
104
+ .SH "DEPLOYMENT MODE"
105
+ Bundler\'s defaults are optimized for development\. To switch to defaults optimized for deployment and for CI, use the \fB\-\-deployment\fR flag\. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified\.
106
+ .
107
+ .IP "1." 4
108
+ A \fBGemfile\.lock\fR is required\.
109
+ .
110
+ .IP
111
+ To ensure that the same versions of the gems you developed with and tested with are also used in deployments, a \fBGemfile\.lock\fR is required\.
112
+ .
113
+ .IP
114
+ This is mainly to ensure that you remember to check your \fBGemfile\.lock\fR into version control\.
115
+ .
116
+ .IP "2." 4
117
+ The \fBGemfile\.lock\fR must be up to date
118
+ .
119
+ .IP
120
+ In development, you can modify your Gemfile(5) and re\-run \fBbundle install\fR to \fIconservatively update\fR your \fBGemfile\.lock\fR snapshot\.
121
+ .
122
+ .IP
123
+ In deployment, your \fBGemfile\.lock\fR should be up\-to\-date with changes made in your Gemfile(5)\.
124
+ .
125
+ .IP "3." 4
126
+ Gems are installed to \fBvendor/bundle\fR not your default system location
127
+ .
128
+ .IP
129
+ In development, it\'s convenient to share the gems used in your application with other applications and other scripts that run on the system\.
130
+ .
131
+ .IP
132
+ In deployment, isolation is a more important default\. In addition, the user deploying the application may not have permission to install gems to the system, or the web server may not have permission to read them\.
133
+ .
134
+ .IP
135
+ As a result, \fBbundle install \-\-deployment\fR installs gems to the \fBvendor/bundle\fR directory in the application\. This may be overridden using the \fB\-\-path\fR option\.
136
+ .
137
+ .IP "" 0
138
+ .
139
+ .SH "SUDO USAGE"
140
+ By default, Bundler installs gems to the same location as \fBgem install\fR\.
141
+ .
142
+ .P
143
+ In some cases, that location may not be writable by your Unix user\. In that case, Bundler will stage everything in a temporary directory, then ask you for your \fBsudo\fR password in order to copy the gems into their system location\.
144
+ .
145
+ .P
146
+ From your perspective, this is identical to installing the gems directly into the system\.
147
+ .
148
+ .P
149
+ You should never use \fBsudo bundle install\fR\. This is because several other steps in \fBbundle install\fR must be performed as the current user:
150
+ .
151
+ .IP "\(bu" 4
152
+ Updating your \fBGemfile\.lock\fR
153
+ .
154
+ .IP "\(bu" 4
155
+ Updating your \fBvendor/cache\fR, if necessary
156
+ .
157
+ .IP "\(bu" 4
158
+ Checking out private git repositories using your user\'s SSH keys
159
+ .
160
+ .IP "" 0
161
+ .
162
+ .P
163
+ Of these three, the first two could theoretically be performed by \fBchown\fRing the resulting files to \fB$SUDO_USER\fR\. The third, however, can only be performed by invoking the \fBgit\fR command as the current user\. Therefore, git gems are downloaded and installed into \fB~/\.bundle\fR rather than $GEM_HOME or $BUNDLE_PATH\.
164
+ .
165
+ .P
166
+ As a result, you should run \fBbundle install\fR as the current user, and Bundler will ask for your password if it is needed to put the gems into their final location\.
167
+ .
168
+ .SH "INSTALLING GROUPS"
169
+ By default, \fBbundle install\fR will install all gems in all groups in your Gemfile(5), except those declared for a different platform\.
170
+ .
171
+ .P
172
+ However, you can explicitly tell Bundler to skip installing certain groups with the \fB\-\-without\fR option\. This option takes a space\-separated list of groups\.
173
+ .
174
+ .P
175
+ While the \fB\-\-without\fR option will skip \fIinstalling\fR the gems in the specified groups, it will still \fIdownload\fR those gems and use them to resolve the dependencies of every gem in your Gemfile(5)\.
176
+ .
177
+ .P
178
+ This is so that installing a different set of groups on another machine (such as a production server) will not change the gems and versions that you have already developed and tested against\.
179
+ .
180
+ .P
181
+ \fBBundler offers a rock\-solid guarantee that the third\-party code you are running in development and testing is also the third\-party code you are running in production\. You can choose to exclude some of that code in different environments, but you will never be caught flat\-footed by different versions of third\-party code being used in different environments\.\fR
182
+ .
183
+ .P
184
+ For a simple illustration, consider the following Gemfile(5):
185
+ .
186
+ .IP "" 4
187
+ .
188
+ .nf
189
+
190
+ source \'https://rubygems\.org\'
191
+
192
+ gem \'sinatra\'
193
+
194
+ group :production do
195
+ gem \'rack\-perftools\-profiler\'
196
+ end
197
+ .
198
+ .fi
199
+ .
200
+ .IP "" 0
201
+ .
202
+ .P
203
+ In this case, \fBsinatra\fR depends on any version of Rack (\fB>= 1\.0\fR), while \fBrack\-perftools\-profiler\fR depends on 1\.x (\fB~> 1\.0\fR)\.
204
+ .
205
+ .P
206
+ When you run \fBbundle install \-\-without production\fR in development, we look at the dependencies of \fBrack\-perftools\-profiler\fR as well\. That way, you do not spend all your time developing against Rack 2\.0, using new APIs unavailable in Rack 1\.x, only to have Bundler switch to Rack 1\.2 when the \fBproduction\fR group \fIis\fR used\.
207
+ .
208
+ .P
209
+ This should not cause any problems in practice, because we do not attempt to \fBinstall\fR the gems in the excluded groups, and only evaluate as part of the dependency resolution process\.
210
+ .
211
+ .P
212
+ This also means that you cannot include different versions of the same gem in different groups, because doing so would result in different sets of dependencies used in development and production\. Because of the vagaries of the dependency resolution process, this usually affects more than the gems you list in your Gemfile(5), and can (surprisingly) radically change the gems you are using\.
213
+ .
214
+ .SH "THE GEMFILE\.LOCK"
215
+ When you run \fBbundle install\fR, Bundler will persist the full names and versions of all gems that you used (including dependencies of the gems specified in the Gemfile(5)) into a file called \fBGemfile\.lock\fR\.
216
+ .
217
+ .P
218
+ Bundler uses this file in all subsequent calls to \fBbundle install\fR, which guarantees that you always use the same exact code, even as your application moves across machines\.
219
+ .
220
+ .P
221
+ Because of the way dependency resolution works, even a seemingly small change (for instance, an update to a point\-release of a dependency of a gem in your Gemfile(5)) can result in radically different gems being needed to satisfy all dependencies\.
222
+ .
223
+ .P
224
+ As a result, you \fBSHOULD\fR check your \fBGemfile\.lock\fR into version control, in both applications and gems\. If you do not, every machine that checks out your repository (including your production server) will resolve all dependencies again, which will result in different versions of third\-party code being used if \fBany\fR of the gems in the Gemfile(5) or any of their dependencies have been updated\.
225
+ .
226
+ .P
227
+ When Bundler first shipped, the \fBGemfile\.lock\fR was included in the \fB\.gitignore\fR file included with generated gems\. Over time, however, it became clear that this practice forces the pain of broken dependencies onto new contributors, while leaving existing contributors potentially unaware of the problem\. Since \fBbundle install\fR is usually the first step towards a contribution, the pain of broken dependencies would discourage new contributors from contributing\. As a result, we have revised our guidance for gem authors to now recommend checking in the lock for gems\.
228
+ .
229
+ .SH "CONSERVATIVE UPDATING"
230
+ When you make a change to the Gemfile(5) and then run \fBbundle install\fR, Bundler will update only the gems that you modified\.
231
+ .
232
+ .P
233
+ In other words, if a gem that you \fBdid not modify\fR worked before you called \fBbundle install\fR, it will continue to use the exact same versions of all dependencies as it used before the update\.
234
+ .
235
+ .P
236
+ Let\'s take a look at an example\. Here\'s your original Gemfile(5):
237
+ .
238
+ .IP "" 4
239
+ .
240
+ .nf
241
+
242
+ source \'https://rubygems\.org\'
243
+
244
+ gem \'actionpack\', \'2\.3\.8\'
245
+ gem \'activemerchant\'
246
+ .
247
+ .fi
248
+ .
249
+ .IP "" 0
250
+ .
251
+ .P
252
+ In this case, both \fBactionpack\fR and \fBactivemerchant\fR depend on \fBactivesupport\fR\. The \fBactionpack\fR gem depends on \fBactivesupport 2\.3\.8\fR and \fBrack ~> 1\.1\.0\fR, while the \fBactivemerchant\fR gem depends on \fBactivesupport >= 2\.3\.2\fR, \fBbraintree >= 2\.0\.0\fR, and \fBbuilder >= 2\.0\.0\fR\.
253
+ .
254
+ .P
255
+ When the dependencies are first resolved, Bundler will select \fBactivesupport 2\.3\.8\fR, which satisfies the requirements of both gems in your Gemfile(5)\.
256
+ .
257
+ .P
258
+ Next, you modify your Gemfile(5) to:
259
+ .
260
+ .IP "" 4
261
+ .
262
+ .nf
263
+
264
+ source \'https://rubygems\.org\'
265
+
266
+ gem \'actionpack\', \'3\.0\.0\.rc\'
267
+ gem \'activemerchant\'
268
+ .
269
+ .fi
270
+ .
271
+ .IP "" 0
272
+ .
273
+ .P
274
+ The \fBactionpack 3\.0\.0\.rc\fR gem has a number of new dependencies, and updates the \fBactivesupport\fR dependency to \fB= 3\.0\.0\.rc\fR and the \fBrack\fR dependency to \fB~> 1\.2\.1\fR\.
275
+ .
276
+ .P
277
+ When you run \fBbundle install\fR, Bundler notices that you changed the \fBactionpack\fR gem, but not the \fBactivemerchant\fR gem\. It evaluates the gems currently being used to satisfy its requirements:
278
+ .
279
+ .TP
280
+ \fBactivesupport 2\.3\.8\fR
281
+ also used to satisfy a dependency in \fBactivemerchant\fR, which is not being updated
282
+ .
283
+ .TP
284
+ \fBrack ~> 1\.1\.0\fR
285
+ not currently being used to satisfy another dependency
286
+ .
287
+ .P
288
+ Because you did not explicitly ask to update \fBactivemerchant\fR, you would not expect it to suddenly stop working after updating \fBactionpack\fR\. However, satisfying the new \fBactivesupport 3\.0\.0\.rc\fR dependency of actionpack requires updating one of its dependencies\.
289
+ .
290
+ .P
291
+ Even though \fBactivemerchant\fR declares a very loose dependency that theoretically matches \fBactivesupport 3\.0\.0\.rc\fR, Bundler treats gems in your Gemfile(5) that have not changed as an atomic unit together with their dependencies\. In this case, the \fBactivemerchant\fR dependency is treated as \fBactivemerchant 1\.7\.1 + activesupport 2\.3\.8\fR, so \fBbundle install\fR will report that it cannot update \fBactionpack\fR\.
292
+ .
293
+ .P
294
+ To explicitly update \fBactionpack\fR, including its dependencies which other gems in the Gemfile(5) still depend on, run \fBbundle update actionpack\fR (see \fBbundle update(1)\fR)\.
295
+ .
296
+ .P
297
+ \fBSummary\fR: In general, after making a change to the Gemfile(5) , you should first try to run \fBbundle install\fR, which will guarantee that no other gem in the Gemfile(5) is impacted by the change\. If that does not work, run bundle update(1) \fIbundle\-update\.1\.html\fR\.
298
+ .
299
+ .SH "SEE ALSO"
300
+ .
301
+ .IP "\(bu" 4
302
+ Gem install docs \fIhttp://guides\.rubygems\.org/rubygems\-basics/#installing\-gems\fR
303
+ .
304
+ .IP "\(bu" 4
305
+ Rubygems signing docs \fIhttp://guides\.rubygems\.org/security/\fR
306
+ .
307
+ .IP "" 0
308
+
@@ -0,0 +1,396 @@
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
+ [--force] [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER]
11
+ [--local] [--no-cache] [--no-prune] [--path PATH] [--quiet]
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
+ Creates a directory (defaults to ~/bin) and place any executa-
38
+ bles from the gem there. These executables run in Bundler's con-
39
+ text. If used, you might add this directory to your environ-
40
+ ment's PATH variable. For instance, if the rails gem comes with
41
+ a rails executable, this flag will create a bin/rails executable
42
+ that ensures that all referred dependencies will be resolved
43
+ using the bundled gems.
44
+
45
+ --clean
46
+ On finishing the installation Bundler is going to remove any
47
+ gems not present in the current Gemfile(5). Don't worry, gems
48
+ currently in use will not be removed.
49
+
50
+ --deployment
51
+ In deployment mode, Bundler will 'roll-out' the bundle for pro-
52
+ duction or CI use. Please check carefully if you want to have
53
+ this option enabled in your development environment.
54
+
55
+ --force
56
+ Force download every gem, even if the required versions are
57
+ already available locally. --redownload is an alias of this
58
+ option.
59
+
60
+ --frozen
61
+ Do not allow the Gemfile.lock to be updated after this install.
62
+ Exits non-zero if there are going to be changes to the Gem-
63
+ file.lock.
64
+
65
+ --full-index
66
+ Bundler will not call Rubygems' API endpoint (default) but down-
67
+ load and cache a (currently big) index file of all gems. Perfor-
68
+ mance can be improved for large bundles that seldom change by
69
+ enabling this option.
70
+
71
+ --gemfile=<gemfile>
72
+ The location of the Gemfile(5) which Bundler should use. This
73
+ defaults to a Gemfile(5) in the current working directory. In
74
+ general, Bundler will assume that the location of the Gemfile(5)
75
+ is also the project's root and will try to find Gemfile.lock and
76
+ vendor/cache relative to this location.
77
+
78
+ --jobs=[<number>], -j[<number>]
79
+ The maximum number of parallel download and install jobs. The
80
+ default is 1.
81
+
82
+ --local
83
+ Do not attempt to connect to rubygems.org. Instead, Bundler will
84
+ use the gems already present in Rubygems' cache or in ven-
85
+ dor/cache. Note that if a appropriate platform-specific gem
86
+ exists on rubygems.org it will not be found.
87
+
88
+ --no-cache
89
+ Do not update the cache in vendor/cache with the newly bundled
90
+ gems. This does not remove any gems in the cache but keeps the
91
+ newly bundled gems from being cached during the install.
92
+
93
+ --no-prune
94
+ Don't remove stale gems from the cache when the installation
95
+ finishes.
96
+
97
+ --path=<path>
98
+ The location to install the specified gems to. This defaults to
99
+ Rubygems' setting. Bundler shares this location with Rubygems,
100
+ gem install ... will have gem installed there, too. Therefore,
101
+ gems installed without a --path ... setting will show up by
102
+ calling gem list. Accordingly, gems installed to other locations
103
+ will not get listed.
104
+
105
+ --quiet
106
+ Do not print progress information to the standard output.
107
+ Instead, Bundler will exit using a status code ($?).
108
+
109
+ --retry=[<number>]
110
+ Retry failed network or git requests for number times.
111
+
112
+ --shebang=<ruby-executable>
113
+ Uses the specified ruby executable (usually ruby) to execute the
114
+ scripts created with --binstubs. In addition, if you use --bin-
115
+ stubs together with --shebang jruby these executables will be
116
+ changed to execute jruby instead.
117
+
118
+ --standalone[=<list>]
119
+ Makes a bundle that can work without depending on Rubygems or
120
+ Bundler at runtime. A space separated list of groups to install
121
+ has to be specified. Bundler creates a directory named bundle
122
+ and installs the bundle there. It also generates a bun-
123
+ dle/bundler/setup.rb file to replace Bundler's own setup in the
124
+ manner required. Using this option implicitly sets path, which
125
+ is a [remembered option][REMEMBERED OPTIONS].
126
+
127
+ --system
128
+ Installs the gems specified in the bundle to the system's
129
+ Rubygems location. This overrides any previous configuration of
130
+ --path.
131
+
132
+ --trust-policy=[<policy>]
133
+ Apply the Rubygems security policy policy, where policy is one
134
+ of HighSecurity, MediumSecurity, LowSecurity, AlmostNoSecurity,
135
+ or NoSecurity. For more details, please see the Rubygems signing
136
+ documentation linked below in SEE ALSO.
137
+
138
+ --with=<list>
139
+ A space-separated list of groups referencing gems to install. If
140
+ an optional group is given it is installed. If a group is given
141
+ that is in the remembered list of groups given to --without, it
142
+ is removed from that list.
143
+
144
+ --without=<list>
145
+ A space-separated list of groups referencing gems to skip during
146
+ installation. If a group is given that is in the remembered list
147
+ of groups given to --with, it is removed from that list.
148
+
149
+ DEPLOYMENT MODE
150
+ Bundler's defaults are optimized for development. To switch to defaults
151
+ optimized for deployment and for CI, use the --deployment flag. Do not
152
+ activate deployment mode on development machines, as it will cause an
153
+ error when the Gemfile(5) is modified.
154
+
155
+ 1. A Gemfile.lock is required.
156
+
157
+ To ensure that the same versions of the gems you developed with and
158
+ tested with are also used in deployments, a Gemfile.lock is
159
+ required.
160
+
161
+ This is mainly to ensure that you remember to check your Gem-
162
+ file.lock into version control.
163
+
164
+ 2. The Gemfile.lock must be up to date
165
+
166
+ In development, you can modify your Gemfile(5) and re-run bundle
167
+ install to conservatively update your Gemfile.lock snapshot.
168
+
169
+ In deployment, your Gemfile.lock should be up-to-date with changes
170
+ made in your Gemfile(5).
171
+
172
+ 3. Gems are installed to vendor/bundle not your default system loca-
173
+ tion
174
+
175
+ In development, it's convenient to share the gems used in your
176
+ application with other applications and other scripts that run on
177
+ the system.
178
+
179
+ In deployment, isolation is a more important default. In addition,
180
+ the user deploying the application may not have permission to
181
+ install gems to the system, or the web server may not have permis-
182
+ sion to read them.
183
+
184
+ As a result, bundle install --deployment installs gems to the ven-
185
+ dor/bundle directory in the application. This may be overridden
186
+ using the --path option.
187
+
188
+
189
+
190
+ SUDO USAGE
191
+ By default, Bundler installs gems to the same location as gem install.
192
+
193
+ In some cases, that location may not be writable by your Unix user. In
194
+ that case, Bundler will stage everything in a temporary directory, then
195
+ ask you for your sudo password in order to copy the gems into their
196
+ system location.
197
+
198
+ From your perspective, this is identical to installing the gems
199
+ directly into the system.
200
+
201
+ You should never use sudo bundle install. This is because several other
202
+ steps in bundle install must be performed as the current user:
203
+
204
+ o Updating your Gemfile.lock
205
+
206
+ o Updating your vendor/cache, if necessary
207
+
208
+ o Checking out private git repositories using your user's SSH keys
209
+
210
+
211
+
212
+ Of these three, the first two could theoretically be performed by
213
+ chowning the resulting files to $SUDO_USER. The third, however, can
214
+ only be performed by invoking the git command as the current user.
215
+ Therefore, git gems are downloaded and installed into ~/.bundle rather
216
+ than $GEM_HOME or $BUNDLE_PATH.
217
+
218
+ As a result, you should run bundle install as the current user, and
219
+ Bundler will ask for your password if it is needed to put the gems into
220
+ their final location.
221
+
222
+ INSTALLING GROUPS
223
+ By default, bundle install will install all gems in all groups in your
224
+ Gemfile(5), except those declared for a different platform.
225
+
226
+ However, you can explicitly tell Bundler to skip installing certain
227
+ groups with the --without option. This option takes a space-separated
228
+ list of groups.
229
+
230
+ While the --without option will skip installing the gems in the speci-
231
+ fied groups, it will still download those gems and use them to resolve
232
+ the dependencies of every gem in your Gemfile(5).
233
+
234
+ This is so that installing a different set of groups on another machine
235
+ (such as a production server) will not change the gems and versions
236
+ that you have already developed and tested against.
237
+
238
+ Bundler offers a rock-solid guarantee that the third-party code you are
239
+ running in development and testing is also the third-party code you are
240
+ running in production. You can choose to exclude some of that code in
241
+ different environments, but you will never be caught flat-footed by
242
+ different versions of third-party code being used in different environ-
243
+ ments.
244
+
245
+ For a simple illustration, consider the following Gemfile(5):
246
+
247
+
248
+
249
+ source 'https://rubygems.org'
250
+
251
+ gem 'sinatra'
252
+
253
+ group :production do
254
+ gem 'rack-perftools-profiler'
255
+ end
256
+
257
+
258
+
259
+ In this case, sinatra depends on any version of Rack (>= 1.0), while
260
+ rack-perftools-profiler depends on 1.x (~> 1.0).
261
+
262
+ When you run bundle install --without production in development, we
263
+ look at the dependencies of rack-perftools-profiler as well. That way,
264
+ you do not spend all your time developing against Rack 2.0, using new
265
+ APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2
266
+ when the production group is used.
267
+
268
+ This should not cause any problems in practice, because we do not
269
+ attempt to install the gems in the excluded groups, and only evaluate
270
+ as part of the dependency resolution process.
271
+
272
+ This also means that you cannot include different versions of the same
273
+ gem in different groups, because doing so would result in different
274
+ sets of dependencies used in development and production. Because of the
275
+ vagaries of the dependency resolution process, this usually affects
276
+ more than the gems you list in your Gemfile(5), and can (surprisingly)
277
+ radically change the gems you are using.
278
+
279
+ THE GEMFILE.LOCK
280
+ When you run bundle install, Bundler will persist the full names and
281
+ versions of all gems that you used (including dependencies of the gems
282
+ specified in the Gemfile(5)) into a file called Gemfile.lock.
283
+
284
+ Bundler uses this file in all subsequent calls to bundle install, which
285
+ guarantees that you always use the same exact code, even as your appli-
286
+ cation moves across machines.
287
+
288
+ Because of the way dependency resolution works, even a seemingly small
289
+ change (for instance, an update to a point-release of a dependency of a
290
+ gem in your Gemfile(5)) can result in radically different gems being
291
+ needed to satisfy all dependencies.
292
+
293
+ As a result, you SHOULD check your Gemfile.lock into version control,
294
+ in both applications and gems. If you do not, every machine that checks
295
+ out your repository (including your production server) will resolve all
296
+ dependencies again, which will result in different versions of
297
+ third-party code being used if any of the gems in the Gemfile(5) or any
298
+ of their dependencies have been updated.
299
+
300
+ When Bundler first shipped, the Gemfile.lock was included in the .git-
301
+ ignore file included with generated gems. Over time, however, it became
302
+ clear that this practice forces the pain of broken dependencies onto
303
+ new contributors, while leaving existing contributors potentially
304
+ unaware of the problem. Since bundle install is usually the first step
305
+ towards a contribution, the pain of broken dependencies would discour-
306
+ age new contributors from contributing. As a result, we have revised
307
+ our guidance for gem authors to now recommend checking in the lock for
308
+ gems.
309
+
310
+ CONSERVATIVE UPDATING
311
+ When you make a change to the Gemfile(5) and then run bundle install,
312
+ Bundler will update only the gems that you modified.
313
+
314
+ In other words, if a gem that you did not modify worked before you
315
+ called bundle install, it will continue to use the exact same versions
316
+ of all dependencies as it used before the update.
317
+
318
+ Let's take a look at an example. Here's your original Gemfile(5):
319
+
320
+
321
+
322
+ source 'https://rubygems.org'
323
+
324
+ gem 'actionpack', '2.3.8'
325
+ gem 'activemerchant'
326
+
327
+
328
+
329
+ In this case, both actionpack and activemerchant depend on activesup-
330
+ port. The actionpack gem depends on activesupport 2.3.8 and rack ~>
331
+ 1.1.0, while the activemerchant gem depends on activesupport >= 2.3.2,
332
+ braintree >= 2.0.0, and builder >= 2.0.0.
333
+
334
+ When the dependencies are first resolved, Bundler will select
335
+ activesupport 2.3.8, which satisfies the requirements of both gems in
336
+ your Gemfile(5).
337
+
338
+ Next, you modify your Gemfile(5) to:
339
+
340
+
341
+
342
+ source 'https://rubygems.org'
343
+
344
+ gem 'actionpack', '3.0.0.rc'
345
+ gem 'activemerchant'
346
+
347
+
348
+
349
+ The actionpack 3.0.0.rc gem has a number of new dependencies, and
350
+ updates the activesupport dependency to = 3.0.0.rc and the rack depen-
351
+ dency to ~> 1.2.1.
352
+
353
+ When you run bundle install, Bundler notices that you changed the
354
+ actionpack gem, but not the activemerchant gem. It evaluates the gems
355
+ currently being used to satisfy its requirements:
356
+
357
+ activesupport 2.3.8
358
+ also used to satisfy a dependency in activemerchant, which is
359
+ not being updated
360
+
361
+ rack ~> 1.1.0
362
+ not currently being used to satisfy another dependency
363
+
364
+ Because you did not explicitly ask to update activemerchant, you would
365
+ not expect it to suddenly stop working after updating actionpack. How-
366
+ ever, satisfying the new activesupport 3.0.0.rc dependency of action-
367
+ pack requires updating one of its dependencies.
368
+
369
+ Even though activemerchant declares a very loose dependency that theo-
370
+ retically matches activesupport 3.0.0.rc, Bundler treats gems in your
371
+ Gemfile(5) that have not changed as an atomic unit together with their
372
+ dependencies. In this case, the activemerchant dependency is treated as
373
+ activemerchant 1.7.1 + activesupport 2.3.8, so bundle install will
374
+ report that it cannot update actionpack.
375
+
376
+ To explicitly update actionpack, including its dependencies which other
377
+ gems in the Gemfile(5) still depend on, run bundle update actionpack
378
+ (see bundle update(1)).
379
+
380
+ Summary: In general, after making a change to the Gemfile(5) , you
381
+ should first try to run bundle install, which will guarantee that no
382
+ other gem in the Gemfile(5) is impacted by the change. If that does not
383
+ work, run bundle update(1) bundle-update.1.html.
384
+
385
+ SEE ALSO
386
+ o Gem install docs
387
+ http://guides.rubygems.org/rubygems-basics/#installing-gems
388
+
389
+ o Rubygems signing docs http://guides.rubygems.org/security/
390
+
391
+
392
+
393
+
394
+
395
+
396
+ June 2019 BUNDLE-INSTALL(1)