Skip to content

Commit

Permalink
Turn --ext option into string. Deprecate usage without explicit value.
Browse files Browse the repository at this point in the history
- this is preparation for onboarding Rust based extension gem generator
  • Loading branch information
simi committed Dec 18, 2022
1 parent d4d6e7d commit d32801b
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 13 deletions.
37 changes: 36 additions & 1 deletion bundler/lib/bundler/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ class CLI < Thor

AUTO_INSTALL_CMDS = %w[show binstubs outdated exec open console licenses clean].freeze
PARSEABLE_COMMANDS = %w[check config help exec platform show version].freeze
EXTENSIONS = ["c"].freeze

COMMAND_ALIASES = {
"check" => "c",
Expand All @@ -22,6 +23,8 @@ class CLI < Thor
}.freeze

def self.start(*)
check_deprecated_ext_option(ARGV) if ARGV.include?("--ext")

super
ensure
Bundler::SharedHelpers.print_major_deprecations!
Expand Down Expand Up @@ -576,7 +579,7 @@ def viz
method_option :edit, :type => :string, :aliases => "-e", :required => false, :banner => "EDITOR",
:lazy_default => [ENV["BUNDLER_EDITOR"], ENV["VISUAL"], ENV["EDITOR"]].find {|e| !e.nil? && !e.empty? },
:desc => "Open generated gemspec in the specified editor (defaults to $EDITOR or $BUNDLER_EDITOR)"
method_option :ext, :type => :boolean, :default => false, :desc => "Generate the boilerplate for C extension code"
method_option :ext, :type => :string, :desc => "Generate the boilerplate for C extension code.", :enum => EXTENSIONS
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 --global gem.mit true`."
method_option :rubocop, :type => :boolean, :desc => "Add rubocop to the generated Rakefile and gemspec. Set a default with `bundle config set --global gem.rubocop true`."
Expand Down Expand Up @@ -753,6 +756,38 @@ def self.reformatted_help_args(args)
end
end

def self.check_deprecated_ext_option(arguments)
# when deprecated version of `--ext` is called
# print out deprecation warning and pretend `--ext=c` was provided
if deprecated_ext_value?(arguments)
SharedHelpers.major_deprecation 2, "Option `--ext` without explicit value is deprecated. Please pass value like `--ext=c` for C extension. Pretending `--ext=c` was used for now."
arguments[arguments.index("--ext")] = "--ext=c"
end
end

def self.deprecated_ext_value?(arguments)
index = arguments.index("--ext")
next_argument = arguments[index+1]

# it is ok when --ext is followed with valid extension value
# for example `bundle gem hello --ext c`
return false if EXTENSIONS.include?(next_argument)

# deprecated call when --ext is called with no value in last position
# for example `bundle gem hello_gem --ext`
return true if next_argument.nil?

# deprecated call when --ext is followed by other parameter
# for example `bundle gem --ext --no-ci hello_gem`
return true if next_argument.start_with?("-")

# deprecated call when --ext is followed by gem name
# for example `bundle gem --ext hello_gem`
return true if next_argument

false
end

private

# Automatically invoke `bundle install` and resume if
Expand Down
10 changes: 6 additions & 4 deletions bundler/lib/bundler/cli/gem.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class CLI::Gem
"test-unit" => "3.0",
}.freeze

attr_reader :options, :gem_name, :thor, :name, :target
attr_reader :options, :gem_name, :thor, :name, :target, :extension

def initialize(options, gem_name, thor)
@options = options
Expand All @@ -28,7 +28,9 @@ def initialize(options, gem_name, thor)
@name = @gem_name
@target = SharedHelpers.pwd.join(gem_name)

validate_ext_name if options[:ext]
@extension = options[:ext]

validate_ext_name if @extension
end

def run
Expand Down Expand Up @@ -64,7 +66,7 @@ def run
:author => git_author_name.empty? ? "TODO: Write your name" : git_author_name,
:email => git_user_email.empty? ? "TODO: Write your email address" : git_user_email,
:test => options[:test],
:ext => options[:ext],
:ext => extension,
:exe => options[:exe],
:bundler_version => bundler_dependency_version,
:git => use_git,
Expand Down Expand Up @@ -188,7 +190,7 @@ def run

templates.merge!("exe/newgem.tt" => "exe/#{name}") if config[:exe]

if options[:ext]
if extension
templates.merge!(
"ext/newgem/extconf.rb.tt" => "ext/#{name}/extconf.rb",
"ext/newgem/newgem.h.tt" => "ext/#{name}/#{underscored_name}.h",
Expand Down
2 changes: 1 addition & 1 deletion bundler/lib/bundler/man/bundle-gem.1
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Add a \fBCODE_OF_CONDUCT\.md\fR file to the root of the generated project\. If t
Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\.
.
.TP
\fB\-\-ext\fR
\fB\-\-ext=c\fR
Add boilerplate for C extension code to the generated project\. This behavior is disabled by default\.
.
.TP
Expand Down
2 changes: 1 addition & 1 deletion bundler/lib/bundler/man/bundle-gem.1.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ configuration file using the following names:
Do not create a `CODE_OF_CONDUCT.md` (overrides `--coc` specified in the
global config).

* `--ext`:
* `--ext=c`:
Add boilerplate for C extension code to the generated project. This behavior
is disabled by default.

Expand Down
31 changes: 25 additions & 6 deletions bundler/spec/commands/newgem_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -312,28 +312,28 @@ def bundle_exec_standardrb

it "has no rubocop offenses when using --ext and --linter=rubocop flag", :readline do
skip "ruby_core has an 'ast.rb' file that gets in the middle and breaks this spec" if ruby_core?
bundle "gem #{gem_name} --ext --linter=rubocop"
bundle "gem #{gem_name} --ext=c --linter=rubocop"
bundle_exec_rubocop
expect(last_command).to be_success
end

it "has no rubocop offenses when using --ext, --test=minitest, and --linter=rubocop flag", :readline do
skip "ruby_core has an 'ast.rb' file that gets in the middle and breaks this spec" if ruby_core?
bundle "gem #{gem_name} --ext --test=minitest --linter=rubocop"
bundle "gem #{gem_name} --ext=c --test=minitest --linter=rubocop"
bundle_exec_rubocop
expect(last_command).to be_success
end

it "has no rubocop offenses when using --ext, --test=rspec, and --linter=rubocop flag", :readline do
skip "ruby_core has an 'ast.rb' file that gets in the middle and breaks this spec" if ruby_core?
bundle "gem #{gem_name} --ext --test=rspec --linter=rubocop"
bundle "gem #{gem_name} --ext=c --test=rspec --linter=rubocop"
bundle_exec_rubocop
expect(last_command).to be_success
end

it "has no rubocop offenses when using --ext, --ext=test-unit, and --linter=rubocop flag", :readline do
skip "ruby_core has an 'ast.rb' file that gets in the middle and breaks this spec" if ruby_core?
bundle "gem #{gem_name} --ext --test=test-unit --linter=rubocop"
bundle "gem #{gem_name} --ext=c --test=test-unit --linter=rubocop"
bundle_exec_rubocop
expect(last_command).to be_success
end
Expand Down Expand Up @@ -1322,13 +1322,32 @@ def create_temporary_dir(dir)

include_examples "generating a gem"

context "--ext parameter set" do
let(:flags) { "--ext" }
context "--ext parameter with no value" do
context "is deprecated", :bundler => "< 3" do
it "prints deprecation when used after gem name" do
bundle ["gem", "--ext", gem_name].compact.join(" ")
expect(err).to include "[DEPRECATED] Option `--ext` without explicit value is deprecated."
expect(bundled_app("#{gem_name}/ext/#{gem_name}/#{gem_name}.c")).to exist
end

it "prints deprecation when used before gem name" do
bundle ["gem", gem_name, "--ext"].compact.join(" ")
expect(bundled_app("#{gem_name}/ext/#{gem_name}/#{gem_name}.c")).to exist
end
end
end

context "--ext parameter set with C" do
let(:flags) { "--ext=c" }

before do
bundle ["gem", gem_name, flags].compact.join(" ")
end

it "is not deprecated" do
expect(err).not_to include "[DEPRECATED] Option `--ext` without explicit value is deprecated."
end

it "builds ext skeleton" do
expect(bundled_app("#{gem_name}/ext/#{gem_name}/extconf.rb")).to exist
expect(bundled_app("#{gem_name}/ext/#{gem_name}/#{gem_name}.h")).to exist
Expand Down

0 comments on commit d32801b

Please sign in to comment.