Add fixtures and conform to interface

Author: iHiD

Rakefile

@@ -3,7 +3,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/*_test.rb"].exclude("test/fixtures/**/*")
 end
 
 task :default => :test

lib/analyzers/exercise_analyzer.rb

@@ -1,16 +1,15 @@
 class ExerciseAnalyzer
 
-  # This is just flow-control for quickly exiting the 
-  # analysis. We probably don't want to do things this 
+  # This is just flow-control for quickly exiting the
+  # analysis. We probably don't want to do things this
   # way eventually, but it helps remove noise for now.
   class FinishedFlowControlException < RuntimeError
   end
 
   def initialize(code_to_analyze)
     @code_to_analyze = code_to_analyze
-    @approve = false
-    @refer_to_mentor = false
-    @messages = []
+    @status = nil
+    @comments = []
   end
 
   def call
@@ -23,17 +22,16 @@ def call
 
   def results
     {
-      approve: approve,
-      refer_to_mentor: refer_to_mentor,
-      messages: messages
+      status: status,
+      comments: comments
     }
   end
 
   private
   attr_reader :code_to_analyze
 
   protected
-  attr_accessor :approve, :refer_to_mentor, :messages
+  attr_accessor :status, :comments
 
   def root_node
     @root_node ||= begin

lib/analyzers/two_fer/analyze.rb

@@ -214,34 +214,32 @@ def default_argument_value
       default_argument.children[0]
     end
 
-
     # ###
     # Flow helpers
     #
     # These are totally generic to all exercises and
     # can probably be extracted to parent
     # ###
     def approve!(msg = nil)
-      self.messages << MESSAGES[msg] if msg
-      self.approve = true
+      if msg
+        self.status = :approve_with_comment
+        self.comments << MESSAGES[msg]
+      else
+        self.status = :approve_as_optimal
+      end
 
       raise FinishedFlowControlException
     end
 
     def refer_to_mentor!
-      self.refer_to_mentor = true
-
-      # Refering to mentor is an explicit
-      # command resulting from weirdness
-      # and should override approving
-      self.approve = false
+      self.status = :refer_to_mentor
 
       raise FinishedFlowControlException
     end
 
     def disapprove!(msg, *msg_args)
-      self.messages << (MESSAGES[msg] % msg_args)
-      self.approve = false
+      self.status = :disapprove_with_comment
+      self.comments << (MESSAGES[msg] % msg_args)
 
       raise FinishedFlowControlException
     end

test/exercises/two_fer_test.rb

@@ -1,7 +1,21 @@
 require "test_helper"
 require 'pry'
 
-class HelloCollectorTest < Minitest::Test
+class TwoFerTest < Minitest::Test
+
+  def test_fixtures
+    dir = File.expand_path("#{__FILE__}/../../fixtures/two-fer/")
+    Dir.foreach(dir).each do |id|
+      next unless File.exist?("#{dir}/#{id}/analysis.json")
+
+      expected = TwoFer::Analyze.(File.read("#{dir}/#{id}/two_fer.rb"))
+      actual = JSON.parse(File.read("#{dir}/#{id}/analysis.json"))
+
+      assert_equal expected[:status].to_s, actual['status']
+      assert_equal expected[:comments], actual['comments']
+    end
+  end
+
   # ###
   # Test the module/class
   # ###
@@ -15,8 +29,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal [], results[:messages]
+    assert_equal :approve_as_optimal, results[:status]
+    assert_equal [], results[:comments]
   end
 
   def test_simple_module_passes
@@ -29,8 +43,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal [], results[:messages]
+    assert_equal :approve_as_optimal, results[:status]
+    assert_equal [], results[:comments]
   end
 
   def test_simple_module_with_bookkeeping_passes
@@ -47,8 +61,8 @@ module Bookkeeping
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal [], results[:messages]
+    assert_equal :approve_as_optimal, results[:status]
+    assert_equal [], results[:comments]
   end
 
   def test_different_module_name_fails
@@ -61,8 +75,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["No module or class called TwoFer"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["No module or class called TwoFer"], results[:comments]
   end
 
   # ###
@@ -79,8 +93,8 @@ def self.foobar(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["No method called two_fer"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["No method called two_fer"], results[:comments]
   end
 
   def test_missing_param
@@ -93,8 +107,8 @@ def self.two_fer
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["There is no correct default param - the tests will fail"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["There is no correct default param - the tests will fail"], results[:comments]
   end
 
   def test_missing_default_value_fails
@@ -107,8 +121,8 @@ def self.two_fer(name)
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["There is no correct default param - the tests will fail"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["There is no correct default param - the tests will fail"], results[:comments]
   end
 
   def test_splat_fails
@@ -121,8 +135,8 @@ def self.two_fer(*foos)
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["Rather than using *foos, how about actually setting a parameter called 'name'?"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["Rather than using *foos, how about actually setting a parameter called 'name'?"], results[:comments]
   end
 
   # ### 
@@ -138,8 +152,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal ["Rather than using string building, use interpolation"], results[:messages]
+    assert_equal :approve_with_comment, results[:status]
+    assert_equal ["Rather than using string building, use interpolation"], results[:comments]
   end
 
   def test_for_kernel_format
@@ -152,8 +166,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal ["Rather than using the format method, use interpolation"], results[:messages]
+    assert_equal :approve_with_comment, results[:status]
+    assert_equal ["Rather than using the format method, use interpolation"], results[:comments]
   end
 
   def test_for_string_format
@@ -166,8 +180,8 @@ def self.two_fer(name="you")
       end
     }
     results = TwoFer::Analyze.(source)
-    assert results[:approve]
-    assert_equal ["Rather than using string's format/percentage method, use interpolation"], results[:messages]
+    assert_equal :approve_with_comment, results[:status]
+    assert_equal ["Rather than using string's format/percentage method, use interpolation"], results[:comments]
   end
 
   def test_conditional_with_nil
@@ -184,8 +198,8 @@ def self.two_fer(name=nil)
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:comments]
   end
 
   def test_conditional_with_nil_reversed
@@ -202,8 +216,8 @@ def self.two_fer(name=nil)
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:comments]
   end
 
   def test_conditional_with_string
@@ -220,8 +234,8 @@ def self.two_fer(name='dog')
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:messages]
+    assert_equal :disapprove_with_comment, results[:status]
+    assert_equal ["You could set the default value to 'you' to avoid conditionals"], results[:comments]
   end
 
   def test_unknown_solution
@@ -234,9 +248,8 @@ def self.two_fer(name=nil)
       end
     }
     results = TwoFer::Analyze.(source)
-    refute results[:approve]
-    assert results[:refer_to_mentor]
-    assert_equal [], results[:messages]
+    assert_equal :refer_to_mentor, results[:status]
+    assert_equal [], results[:comments]
   end
 end