Skip to content

Commit

Permalink
Fix bundle gem ignoring global gem.test config
Browse files Browse the repository at this point in the history 
* bundle gem previously ignored gem.test when passed empty -t flag,
defaulting to RSpec
* bundle gem will now ask user for test framework when passed empty -t
flag and gem.test is set to false, but will not overwrite gem.test
* thor option parsing for String types falls back to human name for nil,
so setting lazy_default to nil won't work
* https://github.com/erikhuda/thor/blob/c5161501e0cfac7a8c5b838a9c6084c275f03c0d/lib/thor/parser/options.rb#L224

Default to Bundler.settings["gem.test"] for empty --test

Add shared examples for test framework to newgem spec

Add examples for empty --test flag to newgem spec

Simplify conditional for prompting test framework

Follow naming conventions for bundler settings

Add more descriptive test framework help text for bundle gem

Update man pages for bundler
  • Loading branch information
@FTLam11
FTLam11 committed May 24, 2020
1 parent 54a4cdb commit ab0785a
Show file tree
Hide file tree
Showing 13 changed files with 361 additions and 288 deletions.
2 changes: 1 addition & 1 deletion bundler/lib/bundler/cli.rb
View file
Expand Up @@ -571,7 +571,7 @@ def viz
method_option :git, :type => :boolean, :default => true, :desc => "Initialize a git repo inside your library."
method_option :mit, :type => :boolean, :desc => "Generate an MIT license file. Set a default with `bundle config set gem.mit true`."
method_option :rubocop, :type => :boolean, :desc => "Add rubocop to the generated Rakefile and gemspec. Set a default with `bundle config set gem.rubocop true`."
method_option :test, :type => :string, :lazy_default => "rspec", :aliases => "-t", :banner => "rspec",
method_option :test, :type => :string, :lazy_default => Bundler.settings["gem.test"] || "", :aliases => "-t", :banner => "Use the specified test framework for your library",
:desc => "Generate a test directory for your library, either rspec, minitest or test-unit. Set a default with `bundle config set gem.test rspec`."
def gem(name)
end
Expand Down
8 changes: 5 additions & 3 deletions bundler/lib/bundler/cli/gem.rb
View file
Expand Up @@ -213,10 +213,12 @@ def validate_ext_name
def ask_and_set_test_framework
test_framework = options[:test] || Bundler.settings["gem.test"]

if test_framework.nil?
if test_framework.to_s.empty?
Bundler.ui.confirm "Do you want to generate tests with your gem?"
result = Bundler.ui.ask "Type 'rspec', 'minitest' or 'test-unit' to generate those test files now and " \
"in the future. rspec/minitest/test-unit/(none):"
result = Bundler.ui.ask "Type 'rspec', 'minitest' or 'test-unit' to generate those test files now. \n" \
"If Bundler is configured to not generate test files, your choice will only be applied to this instance. \n" \
"Otherwise, future bundle gem calls will use your choice, so -t is not needed if your choice will be the same. \n" \
"This setting can be changed anytime with bundle config gem.test <value>. rspec/minitest/test-unit/(none):"
if result =~ /rspec|minitest|test-unit/
test_framework = result
else
Expand Down
8 changes: 4 additions & 4 deletions bundler/man/bundle-check.1.txt
View file
Expand Up @@ -9,8 +9,8 @@ SYNOPSIS
bundle check [--dry-run] [--gemfile=FILE] [--path=PATH]

DESCRIPTION
check searches the local machine for each of the gems requested in the
Gemfile. If all gems are found, Bundler prints a success message and
check searches the local machine for each of the gems requested in the
Gemfile. If all gems are found, Bundler prints a success message and
exits with a status of 0.

If not, the first missing gem is listed and Bundler exits status 1.
Expand All @@ -23,8 +23,8 @@ OPTIONS
Use the specified gemfile instead of the
[Gemfile(5)][Gemfile(5)].

--path Specify a different path than the system default ($BUNDLE_PATH
or $GEM_HOME). Bundler will remember this value for future
--path Specify a different path than the system default ($BUNDLE_PATH
or $GEM_HOME). Bundler will remember this value for future
installs on this machine.


Expand Down
108 changes: 54 additions & 54 deletions bundler/man/bundle-config.1.txt
View file
Expand Up @@ -68,45 +68,45 @@ REMEMBERING OPTIONS
foo or --without production, are remembered between commands and saved
to your local application's configuration (normally, ./.bundle/config).

However, this will be changed in bundler 3, so it's better not to rely
on this behavior. If these options must be remembered, it's better to
However, this will be changed in bundler 3, so it's better not to rely
on this behavior. If these options must be remembered, it's better to
set them using bundle config (e.g., bundle config set path foo).

The options that can be configured are:

bin Creates a directory (defaults to ~/bin) and place any
bin Creates a directory (defaults to ~/bin) 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 PATH variable. For instance, if the rails gem
environment's PATH variable. For instance, if the rails gem
comes with a rails executable, this flag will create a bin/rails
executable that ensures that all referred dependencies will be
executable that ensures that all referred dependencies will be
resolved using the bundled gems.

deployment
In deployment mode, Bundler will 'roll-out' the bundle for
production use. Please check carefully if you want to have this
In deployment mode, Bundler will 'roll-out' the bundle for
production use. Please check carefully if you want to have this
option enabled in development or test environments.

path The location to install the specified gems to. This defaults to
Rubygems' setting. Bundler shares this location with Rubygems,
gem install ... will have gem installed there, too. Therefore,
gems installed without a --path ... setting will show up by
path The location to install the specified gems to. This defaults to
Rubygems' setting. Bundler shares this location with Rubygems,
gem install ... will have gem installed there, too. Therefore,
gems installed without a --path ... setting will show up by
calling gem list. Accordingly, gems installed to other locations
will not get listed.

without
A space-separated list of groups referencing gems to skip during
installation.

with A space-separated list of groups referencing gems to include
with A space-separated list of groups referencing gems to include
during installation.

BUILD OPTIONS
You can use bundle config to give Bundler the flags to pass to the gem
You can use bundle config to give Bundler the flags to pass to the gem
installer every time bundler tries to install a particular gem.

A very common example, the mysql gem, requires Snow Leopard users to
pass configuration flags to gem install to specify where to find the
A very common example, the mysql gem, requires Snow Leopard users to
pass configuration flags to gem install to specify where to find the
mysql_config executable.


Expand All @@ -115,7 +115,7 @@ BUILD OPTIONS



Since the specific location of that executable can change from machine
Since the specific location of that executable can change from machine
to machine, you can specify these flags on a per-machine basis.


Expand All @@ -124,109 +124,109 @@ BUILD OPTIONS



After running this command, every time bundler needs to install the
After running this command, every time bundler needs to install the
mysql gem, it will pass along the flags you specified.

CONFIGURATION KEYS
Configuration keys in bundler have two forms: the canonical form and
Configuration keys in bundler have two forms: the canonical form and
the environment variable form.

For instance, passing the --without flag to bundle install(1)
bundle-install.1.html prevents Bundler from installing certain groups
specified in the Gemfile(5). Bundler persists this value in
app/.bundle/config so that calls to Bundler.setup do not try to find
For instance, passing the --without flag to bundle install(1)
bundle-install.1.html prevents Bundler from installing certain groups
specified in the Gemfile(5). Bundler persists this value in
app/.bundle/config so that calls to Bundler.setup do not try to find
gems from the Gemfile that you didn't install. Additionally, subsequent
calls to bundle install(1) bundle-install.1.html remember this setting
calls to bundle install(1) bundle-install.1.html remember this setting
and skip those groups.

The canonical form of this configuration is "without". To convert the
canonical form to the environment variable form, capitalize it, and
prepend BUNDLE_. The environment variable form of "without" is
The canonical form of this configuration is "without". To convert the
canonical form to the environment variable form, capitalize it, and
prepend BUNDLE_. The environment variable form of "without" is
BUNDLE_WITHOUT.

Any periods in the configuration keys must be replaced with two
underscores when setting it via environment variables. The
configuration key local.rack becomes the environment variable
Any periods in the configuration keys must be replaced with two
underscores when setting it via environment variables. The
configuration key local.rack becomes the environment variable
BUNDLE_LOCAL__RACK.

LIST OF AVAILABLE KEYS
The following is a list of all configuration keys and their purpose.
You can learn more about their operation in bundle install(1)
The following is a list of all configuration keys and their purpose.
You can learn more about their operation in bundle install(1)
bundle-install.1.html.

o allow_bundler_dependency_conflicts
(BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS): Allow resolving to
specifications that have dependencies on bundler that are
(BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS): Allow resolving to
specifications that have dependencies on bundler that are
incompatible with the running Bundler version.

o allow_deployment_source_credential_changes
(BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES): When in
deployment mode, allow changing the credentials to a gem's source.
(BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES): When in
deployment mode, allow changing the credentials to a gem's source.
Ex: https://some.host.com/gems/path/ ->
https://user_name:password@some.host.com/gems/path

o allow_offline_install (BUNDLE_ALLOW_OFFLINE_INSTALL): Allow Bundler
to use cached data when installing without network access.

o auto_clean_without_path (BUNDLE_AUTO_CLEAN_WITHOUT_PATH):
Automatically run bundle clean after installing when an explicit
Automatically run bundle clean after installing when an explicit
path has not been set and Bundler is not installing into the system
gems.

o auto_install (BUNDLE_AUTO_INSTALL): Automatically run bundle
o auto_install (BUNDLE_AUTO_INSTALL): Automatically run bundle
install when gems are missing.

o bin (BUNDLE_BIN): Install executables from gems in the bundle to
o bin (BUNDLE_BIN): Install executables from gems in the bundle to
the specified directory. Defaults to false.

o cache_all (BUNDLE_CACHE_ALL): Cache all gems, including path and
o cache_all (BUNDLE_CACHE_ALL): Cache all gems, including path and
git gems.

o cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS): Cache gems for
o cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS): Cache gems for
all platforms.

o cache_path (BUNDLE_CACHE_PATH): The directory that bundler will
place cached gems in when running bundle package, and that bundler
o cache_path (BUNDLE_CACHE_PATH): The directory that bundler will
place cached gems in when running bundle package, and that bundler
will look in when installing gems. Defaults to vendor/cache.

o clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean
o clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean
automatically after bundle install.

o console (BUNDLE_CONSOLE): The console that bundle console starts.
o console (BUNDLE_CONSOLE): The console that bundle console starts.
Defaults to irb.

o default_install_uses_path (BUNDLE_DEFAULT_INSTALL_USES_PATH):
Whether a bundle install without an explicit --path argument
Whether a bundle install without an explicit --path argument
defaults to installing gems in .bundle.

o deployment (BUNDLE_DEPLOYMENT): Disallow changes to the Gemfile.
When the Gemfile is changed and the lockfile has not been updated,
o deployment (BUNDLE_DEPLOYMENT): Disallow changes to the Gemfile.
When the Gemfile is changed and the lockfile has not been updated,
running Bundler commands will be blocked.

o disable_checksum_validation (BUNDLE_DISABLE_CHECKSUM_VALIDATION):
Allow installing gems even if they do not match the checksum
Allow installing gems even if they do not match the checksum
provided by RubyGems.

o disable_exec_load (BUNDLE_DISABLE_EXEC_LOAD): Stop Bundler from
using load to launch an executable in-process in bundle exec.

o disable_local_branch_check (BUNDLE_DISABLE_LOCAL_BRANCH_CHECK):
Allow Bundler to use a local git override without a branch
Allow Bundler to use a local git override without a branch
specified in the Gemfile.

o disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set,
o disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set,
Gemfiles containing multiple sources will produce errors instead of
warnings. Use bundle config unset disable_multisource to unset.

o disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from
accessing gems installed to RubyGems' normal location.

o disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler
from checking if a newer Bundler version is available on
o disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler
from checking if a newer Bundler version is available on
rubygems.org.

o force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore the
current machine's platform and install only ruby platform gems. As
o force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore the
current machine's platform and install only ruby platform gems. As
a result, gems with native extensions will be compiled from source.

o frozen (BUNDLE_FROZEN): Disallow changes to the Gemfile. When the
Expand Down
11 changes: 10 additions & 1 deletion bundler/man/bundle-gem.1
View file
Expand Up @@ -65,7 +65,16 @@ Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the glo
.
.TP
\fB\-t\fR, \fB\-\-test=minitest\fR, \fB\-\-test=rspec\fR, \fB\-\-test=test\-unit\fR
Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR, \fBrspec\fR and \fBtest\-unit\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\. If no option is specified, the default testing framework is RSpec\.
Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR, \fBrspec\fR and \fBtest\-unit\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. Given no option is specified:
.
.IP
When Bundler is configured to generate tests, this defaults to Bundler\'s global config setting \fBgem\.test\fR\.
.
.IP
When Bundler is configured to not generate tests, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler\'s global config for future \fBbundle gem\fR use\.
.
.TP
\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR
Expand Down
16 changes: 12 additions & 4 deletions bundler/man/bundle-gem.1.txt
View file
Expand Up @@ -70,10 +70,18 @@ OPTIONS
generating the project. Acceptable values are minitest, rspec
and test-unit. The GEM_NAME.gemspec will be configured and a
skeleton test/spec directory will be created based on this
option. If this option is unspecified, an interactive prompt
will be displayed and the answer will be saved in Bundler's
global config for future bundle gem use. If no option is
specified, the default testing framework is RSpec.
option. Given no option is specified:

When Bundler is configured to generate tests, this defaults to
Bundler's global config setting gem.test.

When Bundler is configured to not generate tests, an interactive
prompt will be displayed and the answer will be used for the
current rubygem project.

When Bundler is unconfigured, an interactive prompt will be
displayed and the answer will be saved in Bundler's global
config for future bundle gem use.

-e, --edit[=EDITOR]
Open the resulting GEM_NAME.gemspec in EDITOR, or the default
Expand Down
15 changes: 11 additions & 4 deletions bundler/man/bundle-gem.ronn
View file
Expand Up @@ -64,10 +64,17 @@ configuration file using the following names:
Specify the test framework that Bundler should use when generating the
project. Acceptable values are `minitest`, `rspec` and `test-unit`. The
`GEM_NAME.gemspec` will be configured and a skeleton test/spec directory will
be created based on this option. If this option is unspecified, an interactive
prompt will be displayed and the answer will be saved in Bundler's global
config for future `bundle gem` use.
If no option is specified, the default testing framework is RSpec.
be created based on this option. Given no option is specified:

When Bundler is configured to generate tests, this defaults to Bundler's
global config setting `gem.test`.

When Bundler is configured to not generate tests, an interactive prompt will
be displayed and the answer will be used for the current rubygem project.

When Bundler is unconfigured, an interactive prompt will be displayed and
the answer will be saved in Bundler's global config for future `bundle gem`
use.

* `-e`, `--edit[=EDITOR]`:
Open the resulting GEM_NAME.gemspec in EDITOR, or the default editor if not
Expand Down

0 comments on commit ab0785a

Please sign in to comment.