assert-random 0.2.1 → 0.3.1

data/README.rdoc

@@ -1,16 +1,39 @@
 = assert-random
 
-Adds an assert_random assertion to test/unit
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+Assert random is a simple gem that extends the test/unit assertions to include an assert-random test. Assert random works like any other assertion and accepts a block of code. Assert random checks this block of code records the results of the output. The out put is then checked for the following...
+
+* Identical results
+* Sequences of numbers (eg... 1 2 3 4 or... 10 20 30 etc)
+
+Usage(Will pass):
+
+   def test_something
+      assert_random do
+         rand(1000)
+      end
+   end
+   
+Usage(Will fail):
+
+   def test_something_else
+      assert_random do
+         1000
+      end
+   end
+
+== Tolerance
+
+Random numbers and results are hard to test. If your generating with in a small range of numbers say 1 to 10 then you can't guarantee that the same number will not come up twice. This is despite the generator working correctly. For cases like this assert-random supports the tolerance option. Tolerance allows the test to tolerate more than one instance of a number from a narrow range.
+
+Tolerance Usage:
+
+   def test_tolerance
+      assert_random :tolerance => 5 do
+         rand(10)
+      end
+   end
+
+The above example will pass even if the same number comes up 4 times.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

data/assert-random.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{assert-random}
-  s.version = "0.2.1"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stewart Matheson"]

data/lib/assert-random.rb

@@ -1,26 +1,35 @@
 require 'test/unit'
-
 module AssertRandom
   module AssertionMixins
     
-    def assert_random
+    
+    def assert_random(options = {})
       _wrap_assertion do
+        assert_block("assert needs to be called with a block.") { block_given? }  
+        configuration = { :tolerance => 1 }
+        configuration.update(options) if options.is_a?(Hash)        
+        
         results = Array.new
         10.times do
           results.push yield
         end
-        assert_block("2 or more values match") { !same_values? results } 
+        
+        assert_block("#{configuration[:tolerance]} or more values match") { !same_values? results, configuration[:tolerance] } 
         assert_block("Results are in a sequence") { !in_sequence? results } 
       end
     end
     
     
     private 
-    def same_values?(results)
+    def same_values?(results, tolerance)
+      same_value_counter = 0
       results.each do
         last_result = results.shift
         results.each do |r|
-          return true if(last_result == r)
+          if(last_result == r)
+            same_value_counter += 1
+            return true if same_value_counter > tolerance 
+          end
         end
       end
       false

data/test/test_assert-random.rb

@@ -62,5 +62,42 @@ class TestAssertRandom < Test::Unit::TestCase
       end
     end
   end
+  
+  
+  def test_tolerance_with_random
+    assert_nothing_raised do
+      assert_random :tolerance => 5 do
+        rand(1000)
+      end
+    end
+  end
+  
+  
+  def test_tolerance_with_fixed_number_set
+    numbers = Array.new
+    
+    2.times do
+      numbers.push 10
+    end
+    
+    8.times do
+      numbers.push rand(9)
+    end
+    
+    i = -1
+    assert_raise Test::Unit::AssertionFailedError do
+      assert_random :tolerance => 2 do
+        i =+ 1
+        numbers[i]
+      end
+    end
+  end
 
+  def test_must_pass_block
+    assert_raise Test::Unit::AssertionFailedError do
+      assert_random
+    end
+  end
+  
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: assert-random
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 1
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Stewart Matheson