yarjuf 1.0.4 → 1.0.5

data/HISTORY.txt

@@ -10,3 +10,7 @@
 1.0.3
 - Bug fix in RSpec 2.12.1 means we can go back to how it was before 1.0.1
 
+1.0.4
+- No functional changes, just a big refactor to make the code more
+  maintainable.
+

data/lib/yarjuf.rb

@@ -2,6 +2,7 @@ require 'time'
 require 'builder'
 require 'rspec/core/formatters/base_formatter'
 
+#An RSpec formatter for generating results in JUnit format
 class JUnit < RSpec::Core::Formatters::BaseFormatter
 
   #rspec formatter methods we care about
@@ -9,35 +10,46 @@ class JUnit < RSpec::Core::Formatters::BaseFormatter
   def initialize(output)
     super output
     @test_suite_results = {}
+    @builder = Builder::XmlMarkup.new :indent => 2
   end
 
   def example_passed(example)
-    add_to_test_suite_results(example)
+    add_to_test_suite_results example
   end
 
   def example_failed(example)
-    add_to_test_suite_results(example)
+    add_to_test_suite_results example
   end
 
   def example_pending(example)
-    add_to_test_suite_results(example)
+    add_to_test_suite_results example
   end
 
   def dump_summary(duration, example_count, failure_count, pending_count)
-    builder = Builder::XmlMarkup.new :indent => 2
-    build_results builder, duration, example_count, failure_count, pending_count
-    output.puts builder.target!
+    build_results duration, example_count, failure_count, pending_count
+    output.puts @builder.target!
   end
 
   protected
 
   def add_to_test_suite_results(example)
-    suite_name = root_group_name_for(example)
-    @test_suite_results[suite_name] = [] unless @test_suite_results.keys.include?(suite_name)
+    suite_name = JUnit.root_group_name_for example
+    @test_suite_results[suite_name] = [] unless @test_suite_results.keys.include? suite_name
     @test_suite_results[suite_name] << example
   end
 
-  def root_group_name_for(example)
+  def failure_details_for(example)
+    exception = example.metadata[:execution_result][:exception]
+    exception.nil? ? "" : "#{exception.message}\n#{format_backtrace(exception.backtrace, example).join("\n")}"
+  end
+  
+  #utility methods
+
+  def self.count_in_suite_of_type(suite, test_case_result_type)
+    suite.select {|example| example.metadata[:execution_result][:status] == test_case_result_type}.size
+  end
+
+  def self.root_group_name_for(example)
     group_hierarchy = []
     current_example_group = example.metadata[:example_group]
     until current_example_group.nil? do
@@ -47,43 +59,55 @@ class JUnit < RSpec::Core::Formatters::BaseFormatter
     group_hierarchy.first[:description]
   end
 
-  def failure_details_for(example)
-    exception = example.metadata[:execution_result][:exception]
-    exception.nil? ? "" : "#{exception.message}\n#{format_backtrace(exception.backtrace, example).join("\n")}"
-  end
-
-  def count_in_suite_of_type(suite, test_case_result_type)
-    suite.select {|example| example.metadata[:execution_result][:status] == test_case_result_type}.size
-  end
-
   #methods to build the xml for test suites and individual tests
 
-  def build_results(builder, duration, example_count, failure_count, pending_count)
-    builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
-    builder.testsuites :errors => 0, :failures => failure_count, :skipped => pending_count, :tests => example_count, :time => duration, :timestamp => Time.now.iso8601 do
-      @test_suite_results.each {|suite_name, tests| build_test_suite builder, suite_name, tests}
+  def build_results(duration, example_count, failure_count, pending_count)
+    @builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+    @builder.testsuites :errors => 0, :failures => failure_count, :skipped => pending_count, :tests => example_count, :time => duration, :timestamp => Time.now.iso8601 do
+      build_all_suites
+    end
+  end
+  
+  def build_all_suites
+    @test_suite_results.each do |suite_name, tests|
+      build_test_suite suite_name, tests
     end
   end
 
-  def build_test_suite(builder, suite_name, tests)
-    builder.testsuite :name => suite_name, :tests => tests.size, :errors => 0, :failures => count_in_suite_of_type(tests, "failed"), :skipped => count_in_suite_of_type(tests, "pending") do
-      builder.properties
-      tests.each {|test| build_test builder, test}
+  def build_test_suite(suite_name, tests)
+    failure_count = JUnit.count_in_suite_of_type tests, "failed"
+    skipped_count = JUnit.count_in_suite_of_type tests, "pending"
+        
+    @builder.testsuite :name => suite_name, :tests => tests.size, :errors => 0, :failures => failure_count, :skipped => skipped_count do
+      @builder.properties
+      build_all_tests tests
+    end
+  end
+  
+  def build_all_tests(tests)
+    tests.each do |test|
+      build_test test
     end
   end
 
-  def build_test(builder, test)
-    builder.testcase :name => test.metadata[:full_description], :time => test.metadata[:execution_result][:run_time] do
-      case test.metadata[:execution_result][:status]
-      when "pending" then builder.skipped
-      when "failed" then build_failed_test builder, test
+  def build_test(test)
+    test_name = test.metadata[:full_description]
+    execution_time = test.metadata[:execution_result][:run_time]
+    test_status = test.metadata[:execution_result][:status]
+    
+    @builder.testcase :name => test_name, :time => execution_time do
+      case test_status
+      when "pending" then @builder.skipped
+      when "failed" then build_failed_test test
       end
     end
   end
 
-  def build_failed_test(builder, test)
-    builder.failure :message => "failed #{test.metadata[:full_description]}", :type => "failed" do
-      builder.cdata! failure_details_for test
+  def build_failed_test(test)
+    failure_message = "failed #{test.metadata[:full_description]}"
+    
+    @builder.failure :message => failure_message, :type => "failed" do
+      @builder.cdata! failure_details_for test
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarjuf
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec