myronmarston-test_benchmarker 1.0.1 → 1.2.0

data/README.rdoc

@@ -1,7 +1,7 @@
 = test_benchmarker
 
-test_benchmarker is a ruby library that benchmarks your Test::Unit test.  It's intended to help you 
-pinpoint which tests take longer so you can improve the speed of your test suite.  
+test_benchmarker is a ruby library that benchmarks your Test::Unit test.  It's intended to help you
+pinpoint which tests take longer so you can improve the speed of your test suite.
 
 == Download
 
@@ -15,22 +15,27 @@ Gem:
 Require it in your ruby project:
   require 'rubygems'
   require 'test_benchmarker'
-  
+
 Or in Rails, with Rails 2.1+ gem support, add to your config/environments/test.rb:
-  config.gem 'myronmarston-test_benchmarker', 
-    :lib => 'test_benchmarker', 
+  config.gem 'myronmarston-test_benchmarker',
+    :lib => 'test_benchmarker',
     :source => 'http://gems.github.com'
 
-Your tests will only be benchmarked when you set a value for the BENCHMARK_TESTS environment variable. 
+Your tests will only be benchmarked when you set the appropriate environment variable.  Use BENCHMARK_TESTS
+to have get the benchmark tests written to stdout.
+
 When running tests from a single ruby file:
   BENCHMARK_TESTS=true ruby path/to/test.rb
 
 Or, when using rake:
   rake test BENCHMARK_TESTS=true
 
+Alternately, if you want the test benchmarks written to a file, you can use TEST_BENCHMARKS_FILE:
+  rake test TEST_BENCHMARKS_FILE=path/to/file
+
 == Example Output
 
-test_benchmarker prints two reports: 
+test_benchmarker prints two reports:
 
 1. Class Benchmark Results: Lists each of the Test::Unit::TestCase subclasses in the test run, from the slowest average test time to the fastest.
 2. Test Benchmark Results: Lists each of the tests that ran, from the slowest to the fastest.
@@ -44,9 +49,9 @@ Example output (taken from benchmarking {will_paginate's}[http://wiki.github.com
   4.    0.000 secs avg time, 0.004 secs total time, 12 tests for: ArrayPaginationTest
   5.    0.000 secs avg time, 0.000 secs total time, 1 tests for: WillPaginate::ViewTestCase
   ===============================================================================
-  
-  
-  
+
+
+
   ============================ Test Benchmark Results ============================
   1.    0.084 secs total time for: test_ability_to_use_with_custom_finders(FinderTest)
   2.    0.071 secs total time for: test_paginate_associations(FinderTest)

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 1

data/lib/test_benchmarker/test_benchmarks.rb

@@ -3,65 +3,66 @@ require 'ostruct'
 module TestBenchmarker
   class TestBenchmark
     attr_reader :test_class, :test_name, :benchmark
-    
+
     def initialize(test_class, test_name, benchmark)
       @test_class, @test_name, @benchmark = test_class, test_name, benchmark
       TestBenchmarks.add(self)
     end
   end
-  
+
   class TestBenchmarks
     def self.clear
       @@classes = {}
       @@tests = []
     end
-    
+
     self.clear
-    
+
     def self.add(benchmark)
       test_class = benchmark.test_class
-      
+
       # ignore some bogus test classes that get passed here when run in the context of a rails app...
       return if test_class =~ /(rake_test_loader|::TestCase|::IntegrationTest)/
-      
+
       begin
         test_class = test_class.constantize
       rescue NameError
         return
       end
       return unless test_class.is_subclass_of?(Test::Unit::TestCase)
-      
+
       @@classes[test_class] ||= OpenStruct.new
       @@classes[test_class].benchmarks ||= []
       @@classes[test_class].benchmarks << benchmark
       @@tests << benchmark
     end
-    
-    def self.print_results
+
+    def self.results
       return if @@classes.nil? || @@classes.size == 0
-      
+      results = StringIO.new
       benchmark_attr = :real
-      
+
       class_benchmarks = []
-      @@classes.each do |test_class, obj| 
+      @@classes.each do |test_class, obj|
         obj.test_count = obj.benchmarks.size
         obj.sum = obj.benchmarks.inject(0) {|sum, bmark| sum + bmark.benchmark.send(benchmark_attr)}
         obj.avg = obj.sum / obj.test_count
         obj.test_class = test_class
         class_benchmarks << obj unless obj.benchmarks.nil? || obj.benchmarks.size == 0
       end
-      
-      puts "\n\n#{'=' * 27} Class Benchmark Results #{'=' * 27}"
+
+      results.puts "\n\n#{'=' * 27} Class Benchmark Results #{'=' * 27}"
       class_benchmarks.sort {|a, b| b.avg <=> a.avg}.each_with_index do |cb, i|
-        puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", cb.avg)} secs avg time, #{format("%.3f", cb.sum)} secs total time, #{cb.test_count} tests for: #{cb.test_class.to_s}"
+        results.puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", cb.avg)} secs avg time, #{format("%.3f", cb.sum)} secs total time, #{cb.test_count} tests for: #{cb.test_class.to_s}"
       end
-      puts "#{'=' * 79}\n\n"
-      
-      puts "\n\n#{'=' * 28} Test Benchmark Results #{'=' * 28}"
+      results.puts "#{'=' * 79}\n\n"
+
+      results.puts "\n\n#{'=' * 28} Test Benchmark Results #{'=' * 28}"
       @@tests.sort {|a, b| b.benchmark.send(benchmark_attr) <=> a.benchmark.send(benchmark_attr)}.each_with_index do |t, i|
-        puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", t.benchmark.real)} secs total time for: #{t.test_name}"
+        results.puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", t.benchmark.real)} secs total time for: #{t.test_name}"
       end
-      puts "#{'=' * 80}\n\n"
+      results.puts "#{'=' * 80}\n\n"
+      results.string
     end
   end
 end

data/lib/test_benchmarker/test_suite.rb

@@ -1,9 +1,9 @@
 require 'benchmark'
 
-if ENV['BENCHMARK_TESTS']
+if ENV['BENCHMARK_TESTS'] || ENV['TEST_BENCHMARKS_FILE']
   class Test::Unit::TestSuite
     @@run_count = 0
-  
+
     def run(result, &progress_block)
       @@run_count += 1
       begin
@@ -15,7 +15,14 @@ if ENV['BENCHMARK_TESTS']
       ensure
         @@run_count -= 1
         # print the results as we're exiting the very last test run...
-        TestBenchmarker::TestBenchmarks.print_results if @@run_count == 0
+        if @@run_count == 0
+          results = TestBenchmarker::TestBenchmarks.results
+          if ENV['TEST_BENCHMARKS_FILE']
+            File.open(ENV['TEST_BENCHMARKS_FILE'], 'w') { |f| f << results }
+          else
+            puts results
+          end
+        end
       end
     end
   end

data/test/test_test_benchmarker.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 class Foo; end
-class Class1 < Test::Unit::TestCase 
+class Class1 < Test::Unit::TestCase
   def test_truth; end
 end
 
@@ -23,33 +23,33 @@ class TestTestBenchmarker < Test::Unit::TestCase
         TestBenchmarker::TestBenchmark.new("Class#{class_speed}", "test_#{test_speed} (Class#{class_speed})", ::Benchmark.measure { sleep speed })
       end
     end
-    
+
     TestBenchmarker::TestBenchmark.new("Class4", "test_1 (Class4)", ::Benchmark.measure { sleep 0.01 })
-    
+
     @benchmarked_classes = TestBenchmarker::TestBenchmarks.send(:class_variable_get, '@@classes')
     @benchmarked_tests = TestBenchmarker::TestBenchmarks.send(:class_variable_get, '@@tests').map{ |t| t.test_name }
-    @out, @err = util_capture { TestBenchmarker::TestBenchmarks.print_results }
+    @out = TestBenchmarker::TestBenchmarks.results
   end
-  
+
   def teardown
     TestBenchmarker::TestBenchmarks.clear
   end
-  
+
   def test_has_expected_benchmarked_classes
     assert_equal 3, @benchmarked_classes.keys.size
-    
+
     assert @benchmarked_classes.keys.include?(Class1)
     assert @benchmarked_classes.keys.include?(Class2)
     assert @benchmarked_classes.keys.include?(Class3)
   end
-  
+
   def test_does_not_have_classes_not_descended_from_test_unit_testcase
     assert !@benchmarked_classes.keys.include?(Class4)
   end
-  
+
   def test_has_expected_benchmarked_tests
     assert_equal 9, @benchmarked_tests.size
-    
+
     assert @benchmarked_tests.include?('test_1 (Class1)')
     assert @benchmarked_tests.include?('test_2 (Class1)')
     assert @benchmarked_tests.include?('test_3 (Class1)')
@@ -60,18 +60,18 @@ class TestTestBenchmarker < Test::Unit::TestCase
     assert @benchmarked_tests.include?('test_2 (Class3)')
     assert @benchmarked_tests.include?('test_3 (Class3)')
   end
-  
+
   def test_does_not_have_tests_not_descended_from_test_unit_testcase
     assert !@benchmarked_tests.include?("test_1 (Class4)")
   end
-  
+
   def test_class_benchmark_results
     # should be in order from slowest to fastest
     assert_match class_benchmark_regex('Class3', 1), @out
     assert_match class_benchmark_regex('Class2', 2), @out
     assert_match class_benchmark_regex('Class1', 3), @out
   end
-  
+
   def test_test_benchmark_results
     # should be in order from slowest to fastest
     assert_match test_benchmark_regex('test_3 (Class3)', 1), @out
@@ -84,9 +84,9 @@ class TestTestBenchmarker < Test::Unit::TestCase
     assert_match test_benchmark_regex('test_2 (Class1)', 8), @out
     assert_match test_benchmark_regex('test_1 (Class1)', 9), @out
   end
-  
+
   private
-  
+
   # borrowed from zentest assertions...
   def util_capture
     require 'stringio'
@@ -104,12 +104,12 @@ class TestTestBenchmarker < Test::Unit::TestCase
     $stdout = orig_stdout
     $stderr = orig_stderr
   end
-  
+
   def class_benchmark_regex(class_name, slowness_ranking)
     # http://rubular.com/regexes/6815
     /^#{slowness_ranking}\.\s+[\d\.]+ secs avg time, [\d\.]+ secs total time, [\d]+ tests for: #{Regexp.escape(class_name)}$/
   end
-  
+
   def test_benchmark_regex(test_name, slowness_ranking)
     # http://rubular.com/regexes/6816
     /^#{slowness_ranking}.\s+[\d\.]+ secs total time for: #{Regexp.escape(test_name)}$/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: myronmarston-test_benchmarker
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - Myron Marston
@@ -9,44 +9,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-27 00:00:00 -07:00
+date: 2009-04-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: 
+description: A tool for benchmarking ruby Test::Unit tests.
 email: myron.marston@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- CHANGELOG
 - README.rdoc
 files: 
-- CHANGELOG
 - Manifest.txt
 - README.rdoc
-- Rakefile
-- lib
+- VERSION.yml
 - lib/test_benchmarker
-- lib/test_benchmarker.rb
 - lib/test_benchmarker/core_ext.rb
 - lib/test_benchmarker/test_benchmarks.rb
 - lib/test_benchmarker/test_suite.rb
-- test
+- lib/test_benchmarker.rb
 - test/test_core_ext.rb
 - test/test_helper.rb
 - test/test_test_benchmarker.rb
 has_rdoc: true
-homepage: http://github.com/myronmarston/test_benchmarker
+homepage: http://github.com/myronmarston/test_benchmarker/
 post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
-- --title
-- TestBenchmarker Documentation
-- --charset
-- utf-8
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -67,8 +59,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A tool for benchmarking ruby Test::Unit tests
-test_files: 
-- test/test_core_ext.rb
-- test/test_helper.rb
-- test/test_test_benchmarker.rb
+summary: A tool for benchmarking ruby Test::Unit tests.
+test_files: []
+

data/CHANGELOG

@@ -1,7 +0,0 @@
-== 1.0.0 2009-03-27
-
-* Initial release
-
-== 1.0.1 2009-03-27
-
-* Changed to ActiveSupport's implementation of constantize so as not to use ObjectSpace.

data/Rakefile

@@ -1,42 +0,0 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/testtask'
-require 'rake/rdoctask'
- 
-task :default => :test
-
-desc "Run All Tests"
-Rake::TestTask.new :test do |test|
-  test.test_files = ["test/**/*.rb"]
-  test.verbose = true
-end
-
-desc %{Update ".manifest" with the latest list of project filenames. Respect\
-.gitignore by excluding everything that git ignores. Update `files` and\
-`test_files` arrays in "*.gemspec" file if it's present.}
-task :manifest do
-  list = Dir['**/*'].sort
-  spec_file = Dir['*.gemspec'].first
-  list -= [spec_file] if spec_file
- 
-  if File.exist?('.gitignore')
-    File.read('.gitignore').each_line do |glob|
-      glob = glob.chomp.sub(/^\//, '')
-      list -= Dir[glob]
-      list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
-      puts "excluding #{glob}"
-    end
-  end
- 
-  if spec_file
-    spec = File.read spec_file
-    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
-      assignment = $1
-      bunch = $2 ? list.grep(/^test\//) : list
-      '%s%%w(%s)' % [assignment, bunch.join(' ')]
-    end
- 
-    File.open(spec_file, 'w') {|f| f << spec }
-  end
-  File.open('manifest.txt', 'w') {|f| f << list.join("\n") }
-end