shindo 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shindo (0.1.12)
+    shindo (0.2.0)
       formatador (>= 0.0.16)
 
 GEM

data/README.rdoc

@@ -18,29 +18,72 @@ Returns takes what you expect and checks a block to see if the return value matc
 Raises takes what error you expect and checks to see if the block will raise it:
 
   Shindo.tests do
-    raises(StandardError) { StandardError.new }
+    raises(StandardError) { raise StandardError.new }
   end
 
+For one off simple tests like this you can also chain the calls like this:
+
+  Shindo.tests('raises').raises(StandardError) { raise StandardError.new }
+
 You can also override the default descriptions:
 
   Shindo.tests('foo/bar') do
     returns('foo', 'returns foo when bar') { 'foo' }
-    returns('bar', 'returns bar when qux') { 'bar' }
+    raises(StandardError, 'raises StandardError when baz') { raise StandardError }
+  end
+
+Or nest things inside tests blocks:
+  Shindo.tests do
+    tests('returns') do
+      returns('foo', 'returns foo when bar') { 'foo' }
+      returns('bar', 'returns bar when baz') { 'bar' }
+    end
+    tests('raises') do
+      raises(StandardError, 'raises StandardError when baz') { raise StandardError }
+      raises(StandardError, 'raises StandardError when qux') { raise StandardError }
+    end
   end
 
 Then, if you want to get real fancy you can also tag your tests, to help narrow down which ones to run
 
   Shindo.tests('tests for foo', 'foo') do
-      test('foo') { true }
+    test('foo') { true }
   end
 
   Shindo.tests('tests for bar', 'bar') do
-      test('bar') { true }
-    end
+    test('bar') { true }
   end
 
 Note: you'll have to supply a non-default description first, and then follow up with tags.
 
+== Setup and Teardown
+
+Tests get evaluated in the file just like you see it so you can add setup and teardown easily:
+
+  Shindo.tests do
+    foo = 'bar' # setup
+    tests('foo').returns('bar') { foo }
+
+    foo = 'baz' # cleanup after last
+    tests('foo').returns('baz') { foo }
+
+    foo = nil # teardown
+  end
+
+That can get pretty tedious if it needs to happen before or after every single test though, so there are helpers:
+
+  Shindo.tests do
+    before do
+      @object = Object.new
+    end
+
+    after do
+      @object = nil
+    end
+
+    tests('@object.class').returns(Object) { @object.class }
+  end
+
 == Running tests
 
 Run tests with the shindo command, the easiest is to specify a file name:

data/lib/shindo.rb

@@ -4,7 +4,7 @@ require 'formatador'
 module Shindo
 
   unless const_defined?(:VERSION)
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 
   def self.tests(description = nil, tags = [], &block)
@@ -93,12 +93,12 @@ module Shindo
       self
     end
 
-    def raises(error, &block)
-      assert(:raises, error, "raises #{error.inspect}", &block)
+    def raises(error, description = "raises #{error.inspect}", &block)
+      assert(:raises, error, description, &block)
     end
 
-    def returns(expectation, &block)
-      assert(:returns, expectation, "returns #{expectation.inspect}", &block)
+    def returns(expectation, description = "returns #{expectation.inspect}", &block)
+      assert(:returns, expectation, description, &block)
     end
 
     def test(description = 'returns true', &block)

data/shindo.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'shindo'
-  s.version           = '0.2.0'
-  s.date              = '2011-01-24'
+  s.version           = '0.2.1'
+  s.date              = '2011-01-25'
   s.rubyforge_project = 'shindo'
 
   ## Make sure your summary is short. The description may be as long

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shindo
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 -08:00
+date: 2011-01-25 00:00:00 -08:00
 default_executable: shindo
 dependencies: 
 - !ruby/object:Gem::Dependency