From f821c754ba7b4048cb37141992a32daee1cd58e7 Mon Sep 17 00:00:00 2001 From: Samuel Giddins Date: Sat, 24 Mar 2018 19:19:00 -0700 Subject: [PATCH] [CLI::Gem] Add a --rubocop option --- lib/bundler/cli.rb | 1 + lib/bundler/cli/gem.rb | 11 +++- lib/bundler/templates/newgem/Gemfile.tt | 3 ++ lib/bundler/templates/newgem/Rakefile.tt | 13 +++-- spec/commands/newgem_spec.rb | 66 +++++++++++++++++++++++- 5 files changed, 88 insertions(+), 6 deletions(-) diff --git a/lib/bundler/cli.rb b/lib/bundler/cli.rb index 0083f7e7de7..c39801e7df9 100644 --- a/lib/bundler/cli.rb +++ b/lib/bundler/cli.rb @@ -542,6 +542,7 @@ def viz method_option :ext, :type => :boolean, :default => false, :desc => "Generate the boilerplate for C extension code" 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", :desc => "Generate a test directory for your library, either rspec or minitest. Set a default with `bundle config set gem.test rspec`." def gem(name) diff --git a/lib/bundler/cli/gem.rb b/lib/bundler/cli/gem.rb index d3e58317598..403005a6bdf 100644 --- a/lib/bundler/cli/gem.rb +++ b/lib/bundler/cli/gem.rb @@ -100,7 +100,7 @@ def run end end - config[:test_task] = config[:test] == "minitest" ? "test" : "spec" + config[:test_task] = config[:test] == "minitest" ? :test : :spec if ask_and_set(:mit, "Do you want to license your code permissively under the MIT license?", "This means that any other developer or company will be legally allowed to use your code " \ @@ -124,6 +124,15 @@ def run templates.merge!("CODE_OF_CONDUCT.md.tt" => "CODE_OF_CONDUCT.md") end + if ask_and_set(:rubocop, "Do you want to add rubocop as a dependency for gems you generate?", + "RuboCop is a static code analyzer that has out-of-the-box rules for many " \ + "of the guidelines in the community style guide. " \ + "For more information, see the RuboCop docs (https://docs.rubocop.org/en/stable/) " \ + "and the Ruby Style Guides (https://github.com/rubocop-hq/ruby-style-guide).") + config[:rubocop] = true + Bundler.ui.info "RuboCop enabled in config" + end + templates.merge!("exe/newgem.tt" => "exe/#{name}") if config[:exe] if options[:ext] diff --git a/lib/bundler/templates/newgem/Gemfile.tt b/lib/bundler/templates/newgem/Gemfile.tt index 83878ec7f8a..7b0296068b5 100644 --- a/lib/bundler/templates/newgem/Gemfile.tt +++ b/lib/bundler/templates/newgem/Gemfile.tt @@ -10,3 +10,6 @@ gem "rake-compiler" <%- if config[:test] -%> gem "<%= config[:test] %>", "~> <%= config[:test_framework_version] %>" <%- end -%> +<%- if config[:rubocop] -%> +gem "rubocop" +<%- end -%> diff --git a/lib/bundler/templates/newgem/Rakefile.tt b/lib/bundler/templates/newgem/Rakefile.tt index 099da6f3ecd..1262457c72c 100644 --- a/lib/bundler/templates/newgem/Rakefile.tt +++ b/lib/bundler/templates/newgem/Rakefile.tt @@ -1,4 +1,5 @@ require "bundler/gem_tasks" +<% default_task_names = [config[:test_task]] -%> <% if config[:test] == "minitest" -%> require "rake/testtask" @@ -13,8 +14,16 @@ require "rspec/core/rake_task" RSpec::Core::RakeTask.new(:spec) +<% end -%> +<% if config[:rubocop] -%> +<% default_task_names << :rubocop -%> +require "rubocop/rake_task" + +RuboCop::RakeTask.new + <% end -%> <% if config[:ext] -%> +<% default_task_names.unshift(:clobber, :compile) -%> require "rake/extensiontask" task :build => :compile @@ -23,7 +32,5 @@ Rake::ExtensionTask.new("<%= config[:underscored_name] %>") do |ext| ext.lib_dir = "lib/<%= config[:namespaced_path] %>" end -task :default => [:clobber, :compile, :<%= config[:test_task] %>] -<% else -%> -task :default => :<%= config[:test_task] %> <% end -%> +task :default => <%= default_task_names.size == 1 ? default_task_names.first.inspect : default_task_names.inspect %> diff --git a/spec/commands/newgem_spec.rb b/spec/commands/newgem_spec.rb index 18a30ca9db3..cda74d3d7f2 100644 --- a/spec/commands/newgem_spec.rb +++ b/spec/commands/newgem_spec.rb @@ -148,6 +148,55 @@ def gem_skeleton_assertions end end + shared_examples_for "--rubocop flag" do + before do + bundle! "gem #{gem_name} --rubocop" + end + + it "generates a gem skeleton with rubocop" do + gem_skeleton_assertions + expect(bundled_app("test-gem/Rakefile")).to read_as( + include('require "rubocop/rake_task"'). + and(include("RuboCop::RakeTask.new"). + and(match(/:default.+:rubocop/))) + ) + end + + it "includes rubocop in generated Gemfile" do + Dir.chdir(bundled_app(gem_name)) do + builder = Bundler::Dsl.new + builder.eval_gemfile(bundled_app("#{gem_name}/Gemfile")) + builder.dependencies + rubocop_dep = builder.dependencies.find {|d| d.name == "rubocop" } + expect(rubocop_dep).not_to be_nil + end + end + end + + shared_examples_for "--no-rubocop flag" do + define_negated_matcher :exclude, :include + + before do + bundle! "gem #{gem_name} --no-rubocop" + end + + it "generates a gem skeleton without rubocop" do + gem_skeleton_assertions + expect(bundled_app("test-gem/Rakefile")).to read_as(exclude("rubocop")) + expect(bundled_app("test-gem/#{gem_name}.gemspec")).to read_as(exclude("rubocop")) + end + + it "does not include rubocop in generated Gemfile" do + Dir.chdir(bundled_app(gem_name)) do + builder = Bundler::Dsl.new + builder.eval_gemfile(bundled_app("#{gem_name}/Gemfile")) + builder.dependencies + rubocop_dep = builder.dependencies.find {|d| d.name == "rubocop" } + expect(rubocop_dep).to be_nil + end + end + end + context "README.md" do context "git config github.user present" do before do @@ -518,7 +567,7 @@ def create_temporary_dir(dir) context "with mit option in bundle config settings set to true" do before do - global_config "BUNDLE_GEM__MIT" => "true", "BUNDLE_GEM__TEST" => "false", "BUNDLE_GEM__COC" => "false" + global_config "BUNDLE_GEM__MIT" => "true", "BUNDLE_GEM__TEST" => "false", "BUNDLE_GEM__RUBOCOP" => "false", "BUNDLE_GEM__COC" => "false" end it_behaves_like "--mit flag" it_behaves_like "--no-mit flag" @@ -531,7 +580,7 @@ def create_temporary_dir(dir) context "with coc option in bundle config settings set to true" do before do - global_config "BUNDLE_GEM__MIT" => "false", "BUNDLE_GEM__TEST" => "false", "BUNDLE_GEM__COC" => "true" + global_config "BUNDLE_GEM__MIT" => "false", "BUNDLE_GEM__TEST" => "false", "BUNDLE_GEM__RUBOCOP" => "false", "BUNDLE_GEM__COC" => "true" end it_behaves_like "--coc flag" it_behaves_like "--no-coc flag" @@ -541,6 +590,19 @@ def create_temporary_dir(dir) it_behaves_like "--coc flag" it_behaves_like "--no-coc flag" end + + context "with rubocop option in bundle config settings set to true" do + before do + global_config "BUNDLE_GEM__MIT" => "false", "BUNDLE_GEM__TEST" => "false", "BUNDLE_GEM__COC" => "false", "BUNDLE_GEM__RUBOCOP" => "true" + end + it_behaves_like "--rubocop flag" + it_behaves_like "--no-rubocop flag" + end + + context "with rubocop option in bundle config settings set to false" do + it_behaves_like "--rubocop flag" + it_behaves_like "--no-rubocop flag" + end end context "gem naming with underscore" do