Refactor tests to better reflect actual code usage

Author: PatrickMcSweeny

lib/analyze_solution.rb

@@ -6,11 +6,10 @@ class AnalyzeSolution
   def call
     code_to_analyze = File.read(solution_path / FILENAMES[exercise_slug])
 
-    puts "Analysing #{exercise_slug}"
-    classified_exercise = exercise_slug.tr('-', '_').classify
+    classified_exercise = exercise_slug.split('-').map(&:capitalize).join
     results = "#{classified_exercise}::Analyze".constantize.(code_to_analyze)
 
-    File.open(output_path / "analysis.json", "w") do |f|
+    File.open(output_path / ANALYSIS_FILENAME, "w") do |f|
       f.write("#{results.to_json}\n")
     end
   end

lib/analyzer.rb

@@ -12,6 +12,8 @@
   "high-scores" => "high_scores.rb"
 }.freeze
 
+ANALYSIS_FILENAME = "analysis.json".freeze
+
 require 'mandate'
 require 'json'
 require 'rubocop'

test/analyze_solution_test.rb

@@ -1,16 +1,22 @@
 require "test_helper"
 
 class AnalyzerTest < Minitest::Test
-  def test_that_it_converts_to_path_and_runs
-    slug = mock
-    solution_path = mock
-    output_path = mock
-    solution_pathname = mock
-    output_pathname = mock
-    Pathname.expects(:new).with(solution_path).returns(solution_pathname)
-    Pathname.expects(:new).with(output_path).returns(output_pathname)
+  TMP_PATH = Pathname.new('/tmp')
 
-    AnalyzeSolution.expects(:call).with(slug, solution_pathname, output_pathname)
-    Analyzer.analyze(slug, solution_path, output_path)
+  protected
+  attr_reader :exercise_slug
+
+  def analysis_results(code = "")
+    solution_path = "#{TMP_PATH}/#{FILENAMES[exercise_slug]}"
+    analysis_path = "#{TMP_PATH}/analysis.json"
+    File.open(solution_path, "w") do |f|
+      f.write("#{code}\n")
+    end
+    AnalyzeSolution.(exercise_slug, TMP_PATH, TMP_PATH)
+    file = File.open(analysis_path)
+    JSON.load(file)
+  ensure
+    File.delete solution_path if File.exist? solution_path
+    File.delete analysis_path if File.exist? analysis_path
   end
 end

test/analyzer_test.rb

@@ -1,7 +1,11 @@
 require "test_helper"
 require 'pry'
 
-class AcronymTest < Minitest::Test
+class AcronymTest < AnalyzerTest
+  def setup
+    @exercise_slug = "acronym"
+  end
+
   def test_method_chaining_passes
     source = "
       class Acronym
@@ -10,9 +14,9 @@ def self.abbreviate(words)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_lvar_name_not_tightly_coupled
@@ -23,9 +27,9 @@ def self.abbreviate(sentence)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_method_chaining_with_block_syntax_passes_with_comment
@@ -36,9 +40,9 @@ def self.abbreviate(words)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_equal ["ruby.acronym.block_syntax.shorthand"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_equal ["ruby.acronym.block_syntax.shorthand"], results["comments"]
   end
 
   def test_method_chaining_with_block_syntax_with_arbitrary_arg_passes
@@ -49,9 +53,9 @@ def self.abbreviate(words)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_equal ["ruby.acronym.block_syntax.shorthand"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_equal ["ruby.acronym.block_syntax.shorthand"], results["comments"]
   end
 
   def test_module_method_passes
@@ -62,9 +66,9 @@ def self.abbreviate(words)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_refers_to_mentor_with_method_not_matching
@@ -75,8 +79,8 @@ def self.abbreviate(words)
         end
       end
     "
-    results = Acronym::Analyze.(source)
-    assert_equal :refer_to_mentor, results[:status]
+    results = analysis_results(source)
+    assert_equal "refer_to_mentor", results["status"]
   end
 
   def test_refers_to_mentor_with_random_method_body
@@ -87,8 +91,8 @@ def self.abbreviate(words)
         end
       end
     '
-    results = Acronym::Analyze.(source)
-    assert_equal :refer_to_mentor, results[:status]
+    results = analysis_results(source)
+    assert_equal "refer_to_mentor", results["status"]
   end
 
   def test_scan_with_any_regex_passes
@@ -99,9 +103,9 @@ def self.abbreviate(words)
         end
       end
     '
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_split_with_any_regex_passes
@@ -112,8 +116,8 @@ def self.abbreviate(words)
         end
       end
     '
-    results = Acronym::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 end

test/exercises/acronym_test.rb

@@ -1,6 +1,10 @@
 require "test_helper"
 
-class HighScoresTest < Minitest::Test
+class HighScoresTest < AnalyzerTest
+  def setup
+    @exercise_slug = "high-scores"
+  end
+
   def test_accepted_solution_is_approved_without_comment
     source = <<~SOURCE
       class HighScores
@@ -28,9 +32,9 @@ def latest_is_personal_best?
       end
     SOURCE
 
-    results = HighScores::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_solution_without_attr_reader_is_approved_with_comment
@@ -62,9 +66,9 @@ def latest_is_personal_best?
       end
     SOURCE
 
-    results = HighScores::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_equal ["ruby.high-scores.attr_reader"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_equal ["ruby.high-scores.attr_reader"], results["comments"]
   end
 
   def test_reordered_accepted_solution_is_approved_without_comment
@@ -94,9 +98,9 @@ def latest_is_personal_best?
       end
     SOURCE
 
-    results = HighScores::Analyze.(source)
-    assert_equal :approve, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "approve", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_non_accepted_solution_is_referred_to_mentor
@@ -126,9 +130,9 @@ def latest_is_personal_best?
       end
     SOURCE
 
-    results = HighScores::Analyze.(source)
-    assert_equal :refer_to_mentor, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "refer_to_mentor", results["status"]
+    assert_empty results["comments"]
   end
 
   def test_solution_with_incorrect_indentation_is_disapproved
@@ -158,8 +162,8 @@ def latest_is_personal_best?
       end
     SOURCE
 
-    results = HighScores::Analyze.(source)
-    assert_equal :disapprove, results[:status]
-    assert_equal ["ruby.general.incorrect_indentation"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "disapprove", results["status"]
+    assert_equal ["ruby.general.incorrect_indentation"], results["comments"]
   end
 end

test/exercises/high_scores_test.rb

@@ -1,6 +1,10 @@
 require "test_helper"
 
-class LeapTest < Minitest::Test
+class LeapTest < AnalyzerTest
+  def setup
+    @exercise_slug = "leap"
+  end
+
   def test_date_leap_method_is_disapproved
     source = <<~SOURCE
       class Year
@@ -10,9 +14,9 @@ def self.leap?(year)
       end
     SOURCE
 
-    results = Leap::Analyze.(source)
-    assert_equal :disapprove, results[:status]
-    assert_equal ["ruby.leap.std_lib"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "disapprove", results["status"]
+    assert_equal ["ruby.leap.std_lib"], results["comments"]
   end
 
   def test_date_julian_leap_method_is_disapproved
@@ -24,9 +28,9 @@ def self.leap?(year)
       end
     SOURCE
 
-    results = Leap::Analyze.(source)
-    assert_equal :disapprove, results[:status]
-    assert_equal ["ruby.leap.std_lib"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "disapprove", results["status"]
+    assert_equal ["ruby.leap.std_lib"], results["comments"]
   end
 
   def test_date_gregorian_leap_method_is_disapproved
@@ -38,9 +42,9 @@ def self.leap?(year)
       end
     SOURCE
 
-    results = Leap::Analyze.(source)
-    assert_equal :disapprove, results[:status]
-    assert_equal ["ruby.leap.std_lib"], results[:comments]
+    results = analysis_results(source)
+    assert_equal "disapprove", results["status"]
+    assert_equal ["ruby.leap.std_lib"], results["comments"]
   end
 
   def test_custom_implementation_referred_to_mentor
@@ -52,8 +56,8 @@ def self.leap?(year)
       end
     SOURCE
 
-    results = Leap::Analyze.(source)
-    assert_equal :refer_to_mentor, results[:status]
-    assert_empty results[:comments]
+    results = analysis_results(source)
+    assert_equal "refer_to_mentor", results["status"]
+    assert_empty results["comments"]
   end
 end