huh 1.0.6 → 1.0.8

data/README.md

@@ -13,7 +13,7 @@ or from source
     git clone git://github.com/justinbaker/huh.git
     cd huh
     rake
-    gem install huh-1.0.6.gem
+    gem install huh-1.0.8.gem
 
 Usage
 =========
@@ -31,6 +31,14 @@ Usage
 
 Don't forget the finish!; it prints out number of tests, assertions, failures, as well as percentage of passing tests.
 
+Running tests from `irb` or `rails console`
+=============================================
+
+Just require huh, and call Huh#run with all test files as an argument.
+
+    require "huh"
+    Huh.run(Dir.glob("examples/*.rb"))
+
 Assertions
 ============
 

data/examples/all_assertions.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + "/../lib/huh"
 
 class Test < Huh
-  
+
   test "the truth" do
     assert true
   end

data/lib/huh.rb

@@ -1,18 +1,16 @@
 class Huh
-  V = "1.0.6"
+  V = "1.0.8" unless defined?(V)
   class Failure < StandardError; end
   def self.test(name, &block)
     @t = oz(@t) + 1
-    begin
-      yield
-    rescue Failure => e
-      print "Testing #{name} [\033[1;49;31mFAILED\033[0m]\n"
-    else 
-      print "Testing #{name} [\033[1;49;32mPASSED\033[0m]\n"
-    end
+    print begin; yield; "Testing #{name} [\033[1;49;32mPASSED\033[0m]\n"; rescue Failure => e; "Testing #{name} [\033[1;49;31mFAILED\033[0m]\n" ;end
   end
+  def self.setup(&block); @setup = block; end
+  def self.teardown(&block); @teardown = block; end
   def self.assert(truth)
+    @setup.call if @setup
     !!truth ? (@a = oz(@a) + 1) : (@f = oz(@f) + 1; raise Failure)
+    @teardown.call if @teardown
   end
   def self.oz(v); v or 0; end
   def self.flunk; assert(false); end 
@@ -34,6 +32,7 @@ class Huh
   def self.assert_in_delta(e,a,d); assert((e.to_f - a.to_f).abs <= d.to_f); end
   def self.assert_nothing_thrown(&block); assert(begin; yield; true; rescue; false;end); end
   def self.assert_nothing_raised(&block); assert(begin; yield;true; rescue; false;end) end
-  def self.finish!;puts "\n#{oz(@t)} tests, #{oz(@a)} assertions, #{oz(@f)} failures. #{(((oz(@t)-oz(@f)).to_f/@t.to_f)*100).to_i}% passing tests"; end # spit out info
+  def self.finish!;puts "\n#{oz(@t)} tests, #{oz(@a)} assertions, #{oz(@f)} failures. #{(((oz(@t)-oz(@f)).to_f/@t.to_f)*100).to_i}% passing tests"; end
+  def self.run(f);f.each{|t|puts "\nrunning tests from #{t}\n"; require t}; end
 end
 

data/lib/huh/task.rb

@@ -0,0 +1,9 @@
+class Huh
+  class Task
+    def initialize(name = :test, files = [])
+      task name do
+        Huh.run(files)
+      end
+    end
+  end
+end

data/lib/huh_expanded.rb

@@ -1,9 +1,40 @@
+# Huh is a small unit testing library
+# It supports many assertions commonly used, and has no external dependencies.
+#
+# Author:: Justin Baker (mailto:bakermoto@gmail.com)       
+# Copyright:: Copyright (c) 2010 Justin Baker
+# License::   MIT license
+
+# This class creates a new test case. Your test classes should inherit from this class.
+# 
+# Example
+#   class MyTest < Huh
+#     test "the truth" do
+#       assert true
+#     end
+#   end
+#
+# You can do almost anything you do with Test::Unit included in the standard library, or MiniTest.
+# For all of the assertions, see README.md or examples/all_assertions for usage.
+#
+#
 class Huh
 
-  VERSION = "1.0.5"
+  VERSION = "1.0.8" unless defined?(VERSION) #:nodoc:
 
+  # The error thrown from a failing test
+  #
   class Failure < StandardError; end
 
+  # The method used for creating a new test
+  #  
+  # Example
+  #   class PostTest < Huh
+  #     test "create_new_post_and_save" do
+  #       assert Post.new.save
+  #     end
+  #   end
+  #
   def self.test(name, &block)
     @tests = oz(@tests) + 1
     begin
@@ -15,95 +46,191 @@ class Huh
     end
   end
 
+  # runs a block before every test
+  #  
+  # Example
+  #   class PostTest < Huh
+  #     setup do
+  #       @post = Post.new
+  #     end
+  #     test "create_new_post_and_save" do
+  #       assert @post.save
+  #     end
+  #   end
+  #
+  def self.setup(&block)
+    @setup = block
+  end
+
+  # runs a block after every test
+  #  
+  # Example
+  #   class PostTest < Huh
+  #     teardown do
+  #       @post = nil
+  #     end
+  #     test "create_new_post_and_save" do
+  #       @post = Post.new
+  #       assert @post.save
+  #     end
+  #   end
+  #
+  def self.teardown(&block)
+    @teardown = block
+  end
+  
+  # validates that a condition is true
+  #
+  # Example
+  #   class PostTest < Huh
+  #     test "create_new_post_and_save" do
+  #       @post = Post.new
+  #       assert @post.save
+  #     end
+  #   end
+  #
   def self.assert(truth)
+    @setup.call if @setup
     !!truth ? (@assertions = oz(@assertions) + 1) : (@failures = oz(@failures) + 1; raise Failure)
+    @teardown.call if @teardown
   end
-
+  
+  # return value if it isn't zero
+  #
   def self.oz(value)
     value or 0
   end 
 
+  # assertion that ALWAYS fails
+  #
   def self.flunk
     assert false
   end 
 
+  # validate that actual == expected
+  #
   def self.assert_equal(expected, actual)
     assert expected == actual
   end 
 
+  # validate that actual != expected
+  #
   def self.assert_not_equal(expected, actual)
     assert expected != actual
   end
 
+  # validate that expected.equal?(actual)
+  #
   def self.assert_same(expected, actual)
     assert expected.equal?(actual)
   end 
 
+  # validate that !expected.equal?(actual)
+  #
   def self.assert_not_same(expected, actual)
     assert !expected.equal?(actual)
   end
 
+  # validate that value.nil?
+  #
   def self.assert_nil(value)
     assert value.nil?
   end
 
+  # validate that !value.nil?
+  #
   def self.assert_not_nil(value)
     assert !value.nil? 
   end 
 
+  # validate that object.instance_of?(type)
+  #
   def self.assert_instance_of(type, object)
    assert object.instance_of?(type)
   end 
 
+  # validate that object.kind_of?(type)
+  #
   def self.assert_kind_of(kind, object)
     assert object.kind_of?(kind)
   end 
 
+  # validate that pattern.match(string)
+  #
   def self.assert_match(pattern, string)
     assert pattern.match(string)
   end
 
+  # validate that !pattern.match(string)
+  #
   def self.assert_no_match(pattern, string)
     assert !pattern.match(string)
   end 
 
+  # validate that object.respond_to?(meth)
+  #
   def self.assert_respond_to(meth, object)
     assert object.respond_to?(meth)
   end 
-
+  
+  # validate that the block raises an error
+  #
   def self.assert_raises(&block)
     assert(begin; yield; rescue; true; end)
   end
-
+  
+  # validate that the block returns true
+  #
   def self.assert_block(&block)
     assert(begin;yield; rescue; false; end)
   end
-
-  def self.assert_operator(a,b,operator)
-    assert a.send(operator, b) 
+  
+  # validate that the block returns true when operator is called on it with value
+  #
+  def self.assert_operator(object, value,operator)
+    assert object.send(operator, value) 
   end
 
-  def self.assert_send(a)
-    assert(a[0].send(a[1], *a[2..-1]))
+  # validate that send_array[0] returns true when send_array[1] is called on it with the rest of send_array as args  
+  #
+  def self.assert_send(send_array)
+    assert send_array[0].send(send_array[1], *send_array[2..-1])
   end
 
-  def self.assert_in_delta(e,a,d)
-    assert((e.to_f - a.to_f).abs <= d.to_f)
+  # validate that actual is less than delta away from expected
+  #
+  def self.assert_in_delta(expected, actual, delta)
+    assert (expected.to_f - actual.to_f).abs <= delta.to_f
   end
-
+ 
+  # validate that nothing is thrown by the block
+  #
   def self.assert_nothing_thrown(&block)
     assert(begin; yield; true; rescue; false;end)
   end
 
+  # validate that no errors are raised by the block
+  #
   def self.assert_nothing_raised(&block)
     assert(begin; yield;true; rescue; false;end)
   end
 
+  # print out statistics of test 
+  #
   def self.finish!
-    percentage = (((oz(@tests)-oz(@failures)).to_f/@tests.to_f)*100).to_i
+    percentage = ((( oz(@tests) - oz(@failures) ).to_f / @tests.to_f) * 100 ).to_i
     print "\n#{oz(@tests)} tests, #{oz(@assertions)} assertions, #{oz(@failures)} failures."
     print "#{percentage}% passing tests}\n"
   end
 
+  # use in irb/rails console to run tests
+  #
+  def self.run(files)
+    puts "\nrunning tests from #{t}\n"
+    files.each do |file|
+      require file 
+    end
+  end
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: huh
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - Justin Baker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-24 00:00:00 -05:00
+date: 2011-03-08 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -30,11 +30,10 @@ extra_rdoc_files: []
 
 files: 
 - lib/huh_expanded.rb
+- lib/huh/task.rb
 - lib/huh.rb
-- examples/all_assertions.rb
-- examples/flunk.rb
-- examples/post_test.rb
 - examples/basic.rb
+- examples/all_assertions.rb
 - LICENSE
 - README.md
 has_rdoc: true
@@ -69,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: huh
-rubygems_version: 1.3.7
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: 40 line ruby unit testing library

data/examples/flunk.rb

@@ -1,11 +0,0 @@
-require File.dirname(__FILE__) + "/../lib/huh"
-
-class Test < Huh
-  
-  test "flunk should always fail" do
-    flunk 
-  end
- 
-  finish!
-
-end

data/examples/post_test.rb

@@ -1,32 +0,0 @@
-require File.dirname(__FILE__) + "/../lib/huh"
-
-class PostTest < Huh
-  
-  test "post_should_not_save" do
-    @post = Post.new
-    assert !@post.save
-  end
-
-  test "post_should_not_save_without_title" do
-    @post = Post.new(:content = "Lorem blah blah..")
-    assert !@post.save
-  end
-
-  test "post_should_save" do
-    @post = Post.new(:content = "Lorem blah blah..", :title => "My First Post")
-    assert @post.save
-  end  
- 
-  test "post_should_be_published" do
-    @post = Post.first
-    assert @post.published?
-  end  
-
-  test "post_should_not_be_published" do
-    @post = Post.last
-    assert @post.published?
-  end
- 
-  finish!
-
-end