Convert suite to rspec

Author: jpignata

Gemfile

@@ -7,8 +7,6 @@ gem "safe_yaml"
 gem "pry", require: false
 
 group :test do
-  gem "mocha"
   gem "rake"
-  gem "minitest"
-  gem "minitest-reporters"
+  gem "rspec"
 end

Gemfile.lock

@@ -7,22 +7,13 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ansi (1.5.0)
     ast (2.2.0)
-    builder (3.2.2)
     coderay (1.1.0)
+    diff-lcs (1.2.5)
     i18n (0.7.0)
     json (1.8.3)
-    metaclass (0.0.4)
     method_source (0.8.2)
     minitest (5.8.4)
-    minitest-reporters (1.1.7)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
     parser (2.3.0.2)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -32,6 +23,19 @@ GEM
       slop (~> 3.4)
     rainbow (2.1.0)
     rake (10.5.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
     rubocop (0.36.0)
       parser (>= 2.3.0.0, < 3.0)
       powerpack (~> 0.1)
@@ -50,11 +54,9 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
-  minitest
-  minitest-reporters
-  mocha
   pry
   rake
+  rspec
   rubocop (~> 0.36.0)
   rubocop-rspec
   safe_yaml

Rakefile

@@ -1,10 +1,5 @@
-require 'rake/testtask'
+require "rspec/core/rake_task"
 
-Rake.add_rakelib 'lib/tasks'
-
-Rake::TestTask.new do |t|
-  t.test_files = Dir.glob('spec/**/*_spec.rb')
-  t.libs = %w[lib spec]
-end
-
-task(default: :test)
+Rake.add_rakelib "lib/tasks"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

spec/cc/engine/category_parser_spec.rb

@@ -3,16 +3,22 @@
 
 module CC::Engine
   describe CategoryParser do
-    it "returns a category for the cop name" do
-      CategoryParser.new("Rails/Delegate").category.must_equal("Clarity")
+    it "returns the category mapped to the full cop name if present" do
+      category_parser = CategoryParser.new("Rails/Delegate")
+
+      expect(category_parser.category).to eq("Clarity")
     end
 
-    it "returns a category for the cop" do
-      CategoryParser.new("Performance/Sup").category.must_equal("BugRisk")
+    it "returns the category mapped to the cop category if present" do
+      category_parser = CategoryParser.new("Rails/ScopeArgs")
+
+      expect(category_parser.category).to eq("BugRisk")
     end
 
-    it "returns a default" do
-      CategoryParser.new("Sup").category.must_equal("Style")
+    it "returns Style as the default" do
+      category_parser = CategoryParser.new("Pretend")
+
+      expect(category_parser.category).to eq("Style")
     end
   end
 end

spec/cc/engine/issue_spec.rb

@@ -15,10 +15,9 @@ module CC::Engine
             offense = OpenStruct.new
             offense.cop_name = "Metrics/BlockNesting"
             offense.message = "This has no multiplier"
-
             issue = Issue.new(offense, "/code/file", cop_list: cop_list)
 
-            issue.remediation_points.must_equal(300_000)
+            expect(issue.remediation_points).to eq(300_000)
           end
         end
 
@@ -33,13 +32,11 @@ module CC::Engine
             offense = OpenStruct.new
             offense.cop_name = "Metrics/AbcSize"
             offense.message = "This has a [32/20] multiplier"
-
             issue = Issue.new(offense, "/code/file", cop_list: cop_list)
-
             base_points = 5_000_000
             overage_points = 100_000 * 12
 
-            issue.remediation_points.must_equal(base_points + overage_points)
+            expect(issue.remediation_points).to eq(base_points + overage_points)
           end
         end
       end
@@ -50,12 +47,9 @@ module CC::Engine
             offense = OpenStruct.new
             offense.cop_name = "Some/UnconfiguredCop"
             offense.message = "This has no multiplier"
-
             issue = Issue.new(offense, "/code/file.rb")
 
-            issue.remediation_points.must_equal(
-              Issue::DEFAULT_REMEDIATION_POINTS
-            )
+            expect(issue.remediation_points).to eq(Issue::DEFAULT_REMEDIATION_POINTS)
           end
         end
 
@@ -64,13 +58,11 @@ module CC::Engine
             offense = OpenStruct.new
             offense.cop_name = "Some/UnconfiguredCop"
             offense.message = "This has a [22/20] multiplier"
-
             issue = Issue.new(offense, "/code/file")
-
             base_points = Issue::DEFAULT_BASE_POINTS
             overage_points = Issue::DEFAULT_OVERAGE_POINTS * 2
 
-            issue.remediation_points.must_equal(base_points + overage_points)
+            expect(issue.remediation_points).to eq(base_points + overage_points)
           end
         end
       end

spec/cc/engine/rubocop_spec.rb

@@ -18,7 +18,7 @@ def method
 
         output = run_engine
 
-        assert includes_check?(output, "Lint/UselessAssignment")
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be true
       end
 
       it "reads the configured ruby_style file" do
@@ -38,8 +38,8 @@ def method
         config = { "config" => "rubocop.yml" }
         output = run_engine(config)
 
-        assert includes_check?(output, "Style/AndOr")
-        assert !includes_check?(output, "Lint/UselessAssignment")
+        expect(includes_check?(output, "Style/AndOr")).to be true
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "respects the default .rubocop.yml file" do
@@ -58,8 +58,8 @@ def method
 
         output = run_engine
 
-        assert includes_check?(output, "Style/AndOr")
-        assert !includes_check?(output, "Lint/UselessAssignment")
+        expect(includes_check?(output, "Style/AndOr")).to be true
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "reads a file with a #!.*ruby declaration at the top" do
@@ -73,7 +73,8 @@ def method
           end
         EORUBY
         output = run_engine
-        assert includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be true
       end
 
       it "uses excludes from the specified YAML config" do
@@ -92,7 +93,8 @@ def method
         )
         config = { "config" => "rubocop.yml" }
         output = run_engine(config)
-        assert !includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "uses exclusions passed in via the config hash" do
@@ -107,7 +109,8 @@ def method
         EORUBY
         config = { "exclude_paths" => ["my_script"] }
         output = run_engine(config)
-        assert !includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "layers config exclusions on top of the YAML config" do
@@ -129,11 +132,12 @@ def method
         )
         config = { "config" => "rubocop.yml", "exclude_paths" => ["bar.rb"] }
         output = run_engine(config)
-        assert !includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "handles different locations properly" do
-        RuboCop::Cop::Team.any_instance.expects(:inspect_file).returns(
+        allow_any_instance_of(RuboCop::Cop::Team).to receive(:inspect_file).and_return(
           [
             OpenStruct.new(
               location: RuboCop::Cop::Lint::Syntax::PseudoSourceRange.new(
@@ -164,7 +168,8 @@ def method
             "end" => { "column" => 1, "line" => 1 }
           }
         }
-        assert_equal location, result["location"]
+
+        expect(result["location"]).to eq(location)
       end
 
       it "includes complete method body for cyclomatic complexity issue" do
@@ -192,7 +197,7 @@ def method(a,b,c,d,e,f,g)
           end
         EORUBY
         output = run_engine
-        assert includes_check?(output, "Metrics/CyclomaticComplexity")
+        expect(includes_check?(output, "Metrics/CyclomaticComplexity")).to be true
 
         json = JSON.parse('[' + output.split("\u0000").join(',') + ']')
 
@@ -206,7 +211,8 @@ def method(a,b,c,d,e,f,g)
             "end" => { "column" => 14, "line" => 21 }
           }
         }
-        assert_equal location, result["location"]
+
+        expect(result["location"]).to eq(location)
       end
 
       it "includes issue content when available" do
@@ -215,7 +221,7 @@ def method(a,b,c,d,e,f,g)
 
         output = run_engine
 
-        assert includes_content_for?(output, "Metrics/ClassLength")
+        expect(includes_content_for?(output, "Metrics/ClassLength")).to be true
       end
 
       it "uses only include_paths when they're passed in via the config hash" do
@@ -243,8 +249,9 @@ def method
         output = run_engine(
           "include_paths" => %w[included_root_file.rb subdir/]
         )
-        assert !includes_check?(output, "Lint/UselessAssignment")
-        assert !includes_check?(output, "Style/AndOr")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
+        expect(includes_check?(output, "Style/AndOr")).to be false
       end
 
       it "ignores non-Ruby files even when passed in as include_paths" do
@@ -253,9 +260,11 @@ def method
         output = run_engine(
           "include_paths" => %w[config.yml]
         )
-        refute(issues(output).detect do |i|
+        issue = issues(output).detect do |i|
           i["description"] == "unexpected token tCOLON"
-        end)
+        end
+
+        expect(issue).to be nil
       end
 
       it "includes Ruby files even if they don't end with .rb" do
@@ -267,7 +276,8 @@ def method
           end
         EORUBY
         output = run_engine("include_paths" => %w[Rakefile])
-        assert includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be true
       end
 
       it "skips local disables" do
@@ -280,7 +290,8 @@ def method
           end
         EORUBY
         output = run_engine
-        refute includes_check?(output, "Lint/UselessAssignment")
+
+        expect(includes_check?(output, "Lint/UselessAssignment")).to be false
       end
 
       it "shows full source of long methods" do
@@ -296,8 +307,8 @@ def method
           i["check_name"] == "Rubocop/Metrics/MethodLength"
         end
 
-        assert_equal 1, issue["location"]["positions"]["begin"]["line"]
-        assert_equal 14, issue["location"]["positions"]["end"]["line"]
+        expect(issue["location"]["positions"]["begin"]["line"]).to eq(1)
+        expect(issue["location"]["positions"]["end"]["line"]).to eq(14)
       end
 
       it "shows full source of long classes" do
@@ -312,8 +323,8 @@ class Awesome
           i["check_name"] == "Rubocop/Metrics/ClassLength"
         end
 
-        assert_equal 1, issue["location"]["positions"]["begin"]["line"]
-        assert_equal 105, issue["location"]["positions"]["end"]["line"]
+        expect(issue["location"]["positions"]["begin"]["line"]).to eq(1)
+        expect(issue["location"]["positions"]["end"]["line"]).to eq(105)
       end
 
       def includes_check?(output, cop_name)

spec/spec_helper.rb

@@ -1,5 +1 @@
-require 'minitest/spec'
-require 'minitest/autorun'
-require "minitest/reporters"
-require "mocha/mini_test"
-Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new
+require "rspec"