minitest 2.0.1 → 2.0.2

data/History.txt

@@ -1,3 +1,13 @@
+=== 2.0.2 / 2010-12-24
+
+* 1 minor enhancement:
+
+  * Completed doco on minitest/benchmark for specs.
+
+* 1 bug fix:
+
+  * Benchmarks in specs that didn't call bench_range would die. (zzak).
+
 === 2.0.1 / 2010-12-15
 
 * 4 minor enhancements:

data/lib/minitest/benchmark.rb

@@ -4,11 +4,11 @@ require 'minitest/spec'
 class MiniTest::Unit
   attr_accessor :runner
 
-  def run_benchmarks
+  def run_benchmarks # :nodoc:
     _run_anything :benchmark
   end
 
-  def benchmark_suite_header suite
+  def benchmark_suite_header suite # :nodoc:
     "\n#{suite}\t#{suite.bench_range.join("\t")}"
   end
 
@@ -295,27 +295,63 @@ class MiniTest::Unit
 end
 
 class MiniTest::Spec
+  ##
+  # This is used to define a new benchmark method. You usually don't
+  # use this directly and is intended for those needing to write new
+  # performance curve fits (eg: you need a specific polynomial fit).
+  #
+  # See ::bench_performance_linear for an example of how to use this.
+
   def self.bench name, &block
     define_method "bench_#{name.gsub(/\W+/, '_')}", &block
   end
 
   def self.bench_range &block
+    return super unless block
+
     meta = (class << self; self; end)
     meta.send :define_method, "bench_range", &block
   end
 
+  ##
+  # Create a benchmark that verifies that the performance is linear.
+  #
+  #   describe "my class" do
+  #     bench_performance_linear "fast_algorithm", 0.9999 do
+  #       @obj.fast_algorithm
+  #     end
+  #   end
+
   def self.bench_performance_linear name, threshold = 0.9, &work
     bench name do
       assert_performance_linear threshold, &work
     end
   end
 
+  ##
+  # Create a benchmark that verifies that the performance is constant.
+  #
+  #   describe "my class" do
+  #     bench_performance_constant "zoom_algorithm!" do
+  #       @obj.zoom_algorithm!
+  #     end
+  #   end
+
   def self.bench_performance_constant name, threshold = 0.99, &work
     bench name do
       assert_performance_constant threshold, &work
     end
   end
 
+  ##
+  # Create a benchmark that verifies that the performance is exponential.
+  #
+  #   describe "my class" do
+  #     bench_performance_exponential "algorithm" do
+  #       @obj.algorithm
+  #     end
+  #   end
+
   def self.bench_performance_exponential name, threshold = 0.99, &work
     bench name do
       assert_performance_exponential threshold, &work

data/lib/minitest/mock.rb

@@ -1,17 +1,39 @@
 class MockExpectationError < StandardError; end
 
+##
+# A simple and clean mock object framework.
+
 module MiniTest
+
+  ##
+  # All mock objects are an instance of Mock
+
   class Mock
-    def initialize
+    def initialize # :nodoc:
       @expected_calls = {}
       @actual_calls = Hash.new {|h,k| h[k] = [] }
     end
 
+    ##
+    # Expect that method +name+ is called, optionally with +args+, and
+    # returns +retval+.
+    #
+    #   @mock.expect(:meaning_of_life, 42)
+    #   @mock.meaning_of_life # => 42
+    #
+    #   @mock.expect(:do_something_with, true, [some_obj, true])
+    #   @mock.do_something_with(some_obj, true) # => true
+
     def expect(name, retval, args=[])
       @expected_calls[name] = { :retval => retval, :args => args }
       self
     end
 
+    ##
+    # Verify that all methods were called as expected. Raises
+    # +MockExpectationError+ if the mock object was not called as
+    # expected.
+
     def verify
       @expected_calls.each_key do |name|
         expected = @expected_calls[name]
@@ -22,7 +44,7 @@ module MiniTest
       true
     end
 
-    def method_missing(sym, *args)
+    def method_missing(sym, *args) # :nodoc:
       raise NoMethodError unless @expected_calls.has_key?(sym)
       raise ArgumentError unless @expected_calls[sym][:args].size == args.size
       retval = @expected_calls[sym][:retval]
@@ -31,7 +53,7 @@ module MiniTest
     end
 
     alias :original_respond_to? :respond_to?
-    def respond_to?(sym)
+    def respond_to?(sym) # :nodoc:
       return true if @expected_calls.has_key?(sym)
       return original_respond_to?(sym)
     end

data/lib/minitest/unit.rb

@@ -514,7 +514,7 @@ module MiniTest
   end
 
   class Unit
-    VERSION = "2.0.1" # :nodoc:
+    VERSION = "2.0.2" # :nodoc:
 
     attr_accessor :report, :failures, :errors, :skips # :nodoc:
     attr_accessor :test_count, :assertion_count       # :nodoc:

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 0
-  - 1
-  version: 2.0.1
+  - 2
+  version: 2.0.2
 platform: ruby
 authors: 
 - Ryan Davis
@@ -35,7 +35,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2010-12-15 00:00:00 -08:00
+date: 2010-12-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

metadata.gz.sig

@@ -1,2 +1,3 @@
-~p�{��l��<=D%�S ��b��6�*�g�i��u!�
&�i�!�Xv
����Fv���
-fU.���m?^:0�#G������/�zM��Pw�s��{����.�n�?Zv�
C/���b�����H�/.�9�PM`�$���9�
p]�ÔpC�d	5,牭]��].A�o��r2�Q�4�Q�� �Jqd��8�+µƔ&�9�ȟhQ�
P&/I�C[y`�� g��·������DS� M�o�q��
+aJ�s�{t����Ä׵�[���%�R�Ɲ?B�MEE 骍R5
m>c�i�^����ƨP��hd�f� ΤΫ�>��v��1�(�#hă
+Mf�z�%8�3l��`)Og���ћ��+ɐ��p.���$�cg�![3��φ������cd��-�g$_��h@N|��۱�~�8g��N�_�O�V�_/	9��p
+6#�ĥ�O��*�{RG ���@x�.�{ej2���x����v�nXHc,�F�c