Add RuboCop plugins and resolve its offenses

Author: AlexWayfer

.rubocop.yml

@@ -1,3 +1,8 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.5
   NewCops: enable
@@ -62,3 +67,6 @@ Style/StringLiterals:
 
 Style/WordArray:
   Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

Gemfile

@@ -11,6 +11,9 @@ group :development do
   gem "pry-byebug", "~> 3.9"
   gem "rake", "~> 13.0"
   gem "rubocop", "~> 1.13.0", require: false
+  gem "rubocop-performance", "~> 1.11", require: false
+  gem "rubocop-rake", "~> 0.5.0", require: false
+  gem "rubocop-rspec", "~> 2.3.0", require: false
 end
 
 group :test do

Rakefile

@@ -6,8 +6,6 @@ Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 
-task "default" => "spec"
-
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = ["--colour", "--format", "documentation"]
@@ -17,4 +15,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task "default" => "rubocop"
+task "default" => ["spec", "rubocop"]

lib/clamp/parameter/definition.rb

@@ -46,7 +46,7 @@ def consume(arguments)
       def infer_attribute_name
         inferred_name = name.downcase.tr("-", "_").sub(ELLIPSIS_SUFFIX, "").sub(OPTIONAL) { Regexp.last_match(1) }
 
-        raise "cannot infer attribute_name from #{name.inspect}" unless inferred_name =~ VALID_ATTRIBUTE_NAME
+        raise "cannot infer attribute_name from #{name.inspect}" unless inferred_name.match? VALID_ATTRIBUTE_NAME
 
         inferred_name += "_list" if multivalued?
         inferred_name

spec/clamp/command_group_spec.rb

@@ -29,17 +29,27 @@ def message
 
     end
 
-    it "delegates to sub-commands" do
+    describe "flip command" do
+      before do
+        command.run(["flip"])
+      end
 
-      command.run(["flip"])
-      expect(stdout).to match(/FLIPPED/)
+      it "delegates to sub-commands" do
+        expect(stdout).to match(/FLIPPED/)
+      end
+    end
 
-      command.run(["flop"])
-      expect(stdout).to match(/FLOPPED/)
+    describe "flop command" do
+      before do
+        command.run(["flop"])
+      end
 
+      it "delegates to sub-commands" do
+        expect(stdout).to match(/FLOPPED/)
+      end
     end
 
-    context "executed with no subcommand" do
+    context "when executed with no subcommand" do
 
       it "triggers help" do
         expect do
@@ -56,10 +66,7 @@ def message
       end
 
       it "lists subcommands" do
-        help = command.help
-        expect(help).to match(/Subcommands:/)
-        expect(help).to match(/flip +flip it/)
-        expect(help).to match(/flop +flop it/)
+        expect(command.help).to match(/Subcommands:\n +flip +flip it\n +flop +flop it/)
       end
 
       it "handles new lines in subcommand descriptions" do
@@ -95,13 +102,27 @@ def execute
 
     end
 
-    it "responds to both aliases" do
+    describe "the first alias" do
 
-      command.run(["say", "boo"])
-      expect(stdout).to match(/boo/)
+      before do
+        command.run(["say", "boo"])
+      end
 
-      command.run(["talk", "jive"])
-      expect(stdout).to match(/jive/)
+      it "responds to it" do
+        expect(stdout).to match(/boo/)
+      end
+
+    end
+
+    describe "the second alias" do
+
+      before do
+        command.run(["talk", "jive"])
+      end
+
+      it "responds to it" do
+        expect(stdout).to match(/jive/)
+      end
 
     end
 
@@ -167,7 +188,7 @@ def execute
 
     end
 
-    context "executed with no subcommand" do
+    context "when executed with no subcommand" do
 
       it "invokes the default subcommand" do
         command.run([])
@@ -192,7 +213,7 @@ def execute
 
     end
 
-    context "executed with no subcommand" do
+    context "when executed with no subcommand" do
 
       it "invokes the default subcommand" do
         command.run([])
@@ -203,24 +224,26 @@ def execute
 
   end
 
-  context "declaring a default subcommand after subcommands" do
+  context "when declaring a default subcommand after subcommands" do
 
-    it "is not supported" do
+    let(:command) do
+      Class.new(Clamp::Command) do
 
-      expect do
-        Class.new(Clamp::Command) do
+        subcommand "status", "Show status" do
 
-          subcommand "status", "Show status" do
+          def execute
+            puts "All good!"
+          end
 
-            def execute
-              puts "All good!"
-            end
+        end
 
-          end
+      end
+    end
 
-          self.default_subcommand = "status"
+    it "is not supported" do
 
-        end
+      expect do
+        command.default_subcommand = "status"
       end.to raise_error(/default_subcommand must be defined before subcommands/)
 
     end
@@ -251,18 +274,18 @@ def execute
 
     it "allows the parameter to be specified first" do
       command.run(["dummy", "spit"])
-      expect(stdout.strip).to eql "spat the dummy"
+      expect(stdout.strip).to eq "spat the dummy"
     end
 
     it "passes the parameter down the stack" do
       command.run(["money", "say", "loud"])
-      expect(stdout.strip).to eql "MONEY"
+      expect(stdout.strip).to eq "MONEY"
     end
 
     it "shows parameter in usage help" do
       command.run(["stuff", "say", "loud", "--help"])
     rescue Clamp::HelpWanted => e
-      expect(e.command.invocation_path).to eql("with THING say loud")
+      expect(e.command.invocation_path).to eq "with THING say loud"
     end
 
   end
@@ -336,7 +359,7 @@ def execute; end
 
     it "only parses options once" do
       command.run(["--json", '{"a":"b"}', "woohoohoo"])
-      expect(stdout).to eql "parsing!"
+      expect(stdout).to eq "parsing!"
     end
 
   end
@@ -376,19 +399,16 @@ def execute; end
       command_class.new("foo")
     end
 
-    it "should signal no such subcommand usage error" do
-      expect { command.run(["foo"]) }.to raise_error(Clamp::UsageError) do |exception|
-        expect(exception.message).to eq "No such sub-command 'foo'"
-      end
+    it "signals no such subcommand usage error" do
+      expect { command.run(["foo"]) }.to raise_error(Clamp::UsageError, "No such sub-command 'foo'")
     end
 
-    it "should execute the subcommand missing method" do
+    it "executes the subcommand missing method" do
       command.extend subcommand_missing
-      expect { command.run(["foo"]) }.to raise_error(SystemExit)
-      expect(stderr).to match(/there is no such thing/)
+      expect { command.run(["foo"]) }.to raise_error(SystemExit, /there is no such thing/)
     end
 
-    it "should use the subcommand class returned from subcommand_missing" do
+    it "uses the subcommand class returned from subcommand_missing" do
       command.extend subcommand_missing_with_return
       command.run(["foo"])
       expect(stdout).to match(/known subcommand/)
@@ -409,7 +429,7 @@ def execute
 
     it "allows options after the subcommand" do
       command.run(%w[hop --direction south])
-      expect(stdout).to eql "Hopping south\n"
+      expect(stdout).to eq "Hopping south\n"
     end
 
   end

spec/clamp/option_module_spec.rb renamed to spec/clamp/command_option_module_spec.rb

@@ -31,7 +31,7 @@ def execute
 
     it "accepts options from included module" do
       command.run(["--size", "42"])
-      expect(stdout).to eql "size = 42\n"
+      expect(stdout).to eq "size = 42\n"
     end
 
   end

spec/clamp/option_reordering_spec.rb renamed to spec/clamp/command_option_reordering_spec.rb

@@ -40,17 +40,17 @@ def execute
 
     it "still works" do
       command.run(%w[say foo])
-      expect(stdout).to eql("foo\n")
+      expect(stdout).to eq "foo\n"
     end
 
     it "honours options after positional arguments" do
       command.run(%w[say blah --verbose])
-      expect(stdout).to eql("blahblahblah\n")
+      expect(stdout).to eq "blahblahblah\n"
     end
 
     it "honours options declared on subcommands" do
       command.run(%w[say --loud blah])
-      expect(stdout).to eql("BLAH\n")
+      expect(stdout).to eq "BLAH\n"
     end
 
   end