riot 0.10.4 → 0.10.5

data/README.markdown

@@ -93,6 +93,7 @@ For instance, given a test file named `foo_test.rb`, you might have the followin
     context "a new user" do
       setup { User.new }
       asserts("that it is not yet created") { topic.new_record? }
+      teardown { #cleanup here }
     end
 
 Notice that you do not define a class anywhere. That would be the entire contents of that test file. If you wanted to use a `should` instead, you could say this:
@@ -348,7 +349,13 @@ I should say that I love Shoulda in theory and in practice. It changed the way I
 
 Riot differs primarily in that it does not rerun setup for each test in a context. I know this is going to shock a lot of folks. However, over the past several years of my doing TDD in some capacity or another, there are certain habits I have tried to pick up on any many others I have tried to drop.
 
-For instance, I believe that no assertion should mangle the context of the test data it is running in. Following this allows me to require setup be run only once for a collection of related assertions. Even in a nested context where setups are inherited, the setup's are called only once per the specific context.
+For instance, I believe that no assertion should mangle the context of
+the test data it is running in. Following this allows me to require
+setup be run only once for a collection of related assertions. Even in
+a nested context where setups are inherited, the setup's are called
+only once per the specific context. Furthermore, teardowns are also
+called only once per the specific context, after all the setups and
+assertions have run.
 
 Following all of this allows me to have very fast tests (so far).
 

data/VERSION

@@ -1 +1 @@
-0.10.4
+0.10.5

data/lib/riot/assertion_macros.rb

@@ -108,6 +108,22 @@ module Riot
       actual.length == 0 ? pass : fail("expected #{actual.inspect} to be empty")
     end
 
+    # Asserts the result has items
+    #   asserts("an array") { [1] }.any
+    #   asserts("a hash") { {:name => 'washington'} }.any
+    assertion(:any) do |actual|
+      actual.any? ? pass : fail("expected #{actual.inspect} to have items")
+    end
+
+    # Asserts that result's size is as expected. Expected size can be specified as
+    # a number or a range.
+    #   asserts("a string") { 'washington' }.size(9..12)
+    #   asserts("an array") { [1, 2, 3] }.size(3)
+    #   asserts("a hash") { {:name => 'washington'} }.size(1)
+    assertion(:size) do |actual, expected|
+      expected === actual.size ? pass : fail("size of #{actual.inspect} expected to be #{expected} but is #{actual.size}")
+    end
+
     # Asserts the result contains the expected element
     #   asserts("a string") { "world" }.includes('o')
     #   asserts("an array") { [1,2,3] }.includes(2)

data/lib/riot/context.rb

@@ -1,24 +1,22 @@
 module Riot
-  RootContext = Struct.new(:setups)
+  RootContext = Struct.new(:setups, :teardowns)
   class Context
-    def initialize(description, parent=RootContext.new([]), &definition)
+    attr_reader :description
+    def initialize(description, parent=RootContext.new([],[]), &definition)
       @parent = parent
       @description = description
-      @contexts, @setups, @assertions = [], [], []
+      @contexts, @setups, @assertions, @teardowns = [], [], [], []
       self.instance_eval(&definition)
     end
-    
-    def setup(&definition)
-      @setups << Setup.new(&definition)
-    end
 
-    def setups
-      @parent.setups + @setups
-    end
+    def setups; @parent.setups + @setups; end
+    def teardowns; @parent.teardowns + @teardowns; end
+    
+    def setup(&definition) (@setups << Setup.new(&definition)).last; end
+    def teardown(&definition) (@teardowns << Setup.new(&definition)).last; end
 
     def asserts(what, &definition) new_assertion("asserts", what, &definition); end
     def should(what, &definition) new_assertion("should", what, &definition); end
-
     def asserts_topic; asserts("topic") { topic }; end
 
     def context(description, &definition)
@@ -26,16 +24,20 @@ module Riot
     end
     
     def run(reporter)
-      runnables = setups + @assertions
-      reporter.describe_context(@description) unless @assertions.empty?
-      situation = Situation.new
-      runnables.each do |runnable|
-        reporter.report(runnable.to_s, runnable.run(situation))
-      end
-      @contexts.each { |ctx| ctx.run(reporter) }
+      reporter.describe_context(self) unless @assertions.empty?
+      local_run(reporter, Situation.new)
+      run_sub_contexts(reporter)
       reporter
     end
   private
+    def local_run(reporter, situation)
+      (setups + @assertions + teardowns).each do |runnable|
+        reporter.report(runnable.to_s, runnable.run(situation))
+      end
+    end
+
+    def run_sub_contexts(reporter) @contexts.each { |ctx| ctx.run(reporter) }; end
+
     def new_assertion(scope, what, &definition)
       (@assertions << Assertion.new("#{scope} #{what}", &definition)).last
     end

data/lib/riot/reporter.rb

@@ -1,8 +1,9 @@
 module Riot
   class Reporter
-    attr_accessor :passes, :failures, :errors
+    attr_accessor :passes, :failures, :errors, :current_context
     def initialize
       @passes = @failures = @errors = 0
+      @current_context = ""
     end
 
     def summarize(&block)
@@ -12,7 +13,7 @@ module Riot
       results(Time.now - started)
     end
 
-    def describe_context(msg); end
+    def describe_context(context); @current_context = context; end
 
     def report(description, response)
       code, result = *response
@@ -36,9 +37,9 @@ module Riot
 
   class IOReporter < Reporter
     attr_reader :writer
-    def initialize(writer=nil)
+    def initialize(writer=STDOUT)
       super()
-      @writer = writer || STDOUT
+      @writer = writer
     end
     def say(message) writer.puts(message); end
 
@@ -47,6 +48,14 @@ module Riot
       say "\n%d passes, %d failures, %d errors in %s seconds" % values
     end
 
+    def format_error(e)
+      format = "    #{e.class.name} occured"
+      format += "\n#{e.to_s}\n"
+      e.backtrace.each { |line| format += "\n      at #{line}" }
+
+      format
+    end
+
     begin
       raise LoadError if ENV["TM_MODE"]
       require 'rubygems'
@@ -60,7 +69,10 @@ module Riot
   end
 
   class StoryReporter < IOReporter
-    def describe_context(description) say description; end
+    def describe_context(context)
+      super
+      say context.description
+    end
     def pass(description) say "  + " + green(description); end
     def fail(description, message) say "  - " + yellow("#{description}: #{message}"); end
     def error(description, e) say "  ! " + red("#{description}: #{e.message}"); end
@@ -69,16 +81,32 @@ module Riot
   class VerboseStoryReporter < StoryReporter
     def error(description, e)
       super(description, e)
-      say red("    #{e.class.name} occured")
-      e.backtrace.each { |line| say red("      at #{line}") }
+      say red(format_error(e))
     end
   end
 
   class DotMatrixReporter < IOReporter
     def pass(description); writer.write green("."); end
-    def fail(description, message); writer.write yellow("F"); end
-    def error(description, e); writer.write red("E"); end
-    # TODO: Print the failures and errors at the end. Sorry :|
+
+    def initialize(writer=STDOUT)
+      super
+      @details = []
+    end
+    def fail(description, message)
+      writer.write yellow("F")
+      @details << "FAILURE - #{current_context.description} #{description} => #{message}"
+    end
+
+    def error(description, e)
+      writer.write red("E")
+      @details << "ERROR - #{current_context.description} #{description} => #{format_error(e)}"
+    end
+
+    def results(time_taken)
+      say "\n"
+      @details.each { |detail| say detail }
+      super
+    end
   end
 
   class SilentReporter < Reporter

data/riot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{riot}
-  s.version = "0.10.4"
+  s.version = "0.10.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin 'Gus' Knowlden"]
-  s.date = %q{2009-12-03}
+  s.date = %q{2009-12-14}
   s.description = %q{An extremely fast, expressive, and context-driven unit-testing framework. A replacement for all other testing frameworks. Protest the slow test.}
   s.email = %q{gus@gusg.us}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/riot/runnable.rb",
      "lib/riot/situation.rb",
      "riot.gemspec",
+     "test/assertion_macros/any_test.rb",
      "test/assertion_macros/assigns_test.rb",
      "test/assertion_macros/empty_test.rb",
      "test/assertion_macros/equals_test.rb",
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
      "test/assertion_macros/raises_test.rb",
      "test/assertion_macros/respond_to_test.rb",
      "test/assertion_macros/same_elements_test.rb",
+     "test/assertion_macros/size_test.rb",
      "test/assertion_test.rb",
      "test/benchmark/colorize.rb",
      "test/benchmark/riot_vs_minitest.rb",
@@ -50,6 +52,7 @@ Gem::Specification.new do |s|
      "test/report_test.rb",
      "test/setup_test.rb",
      "test/situation_test.rb",
+     "test/teardown_test.rb",
      "test/teststrap.rb"
   ]
   s.homepage = %q{http://github.com/thumblemonks/riot}
@@ -58,7 +61,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{An extremely fast, expressive, and context-driven unit-testing framework. Protest the slow test.}
   s.test_files = [
-    "test/assertion_macros/assigns_test.rb",
+    "test/assertion_macros/any_test.rb",
+     "test/assertion_macros/assigns_test.rb",
      "test/assertion_macros/empty_test.rb",
      "test/assertion_macros/equals_test.rb",
      "test/assertion_macros/exists_test.rb",
@@ -69,6 +73,7 @@ Gem::Specification.new do |s|
      "test/assertion_macros/raises_test.rb",
      "test/assertion_macros/respond_to_test.rb",
      "test/assertion_macros/same_elements_test.rb",
+     "test/assertion_macros/size_test.rb",
      "test/assertion_test.rb",
      "test/benchmark/colorize.rb",
      "test/benchmark/riot_vs_minitest.rb",
@@ -78,6 +83,7 @@ Gem::Specification.new do |s|
      "test/report_test.rb",
      "test/setup_test.rb",
      "test/situation_test.rb",
+     "test/teardown_test.rb",
      "test/teststrap.rb"
   ]
 

data/test/assertion_macros/any_test.rb

@@ -0,0 +1,19 @@
+require 'teststrap'
+
+context "An any assertion macro" do
+  setup do
+    def assert_any(string)
+      Riot::Assertion.new("test") { string }.any
+    end
+  end
+
+  assertion_test_passes("when an array has items") { assert_any([1]) }
+  assertion_test_fails("when an array is empty", "expected [] to have items") do
+    assert_any([])
+  end
+
+  assertion_test_passes("when a hash has items") { assert_any({:name => 'washington'}) }
+  assertion_test_fails("when a hash is empty", "expected {} to have items") do
+    assert_any({})
+  end
+end

data/test/assertion_macros/size_test.rb

@@ -0,0 +1,36 @@
+require 'teststrap'
+
+context "A size assertion macro" do
+  setup do
+    def assert_size(sizable, expected_size)
+      Riot::Assertion.new("test") { sizable }.size(expected_size)
+    end
+  end
+
+  assertion_test_passes("when string's size is as expected") { assert_size("washington", 10) }
+  assertion_test_passes("when string's size is in given range") { assert_size("washington", 9..12) }
+  assertion_test_fails("when string's size is not as expected", "size of \"washington\" expected to be 11 but is 10") do
+    assert_size("washington", 11)
+  end
+  assertion_test_fails("when string's size is out of range", "size of \"washington\" expected to be 11..13 but is 10") do
+    assert_size("washington", 11..13)
+  end
+
+  assertion_test_passes("when an array's size is as expected") { assert_size([1, 2, 3], 3) }
+  assertion_test_passes("when an array's size is in given range") { assert_size([1, 2, 3], 3..4) }
+  assertion_test_fails("when an array's size is not as expected", "size of [1, 2, 3] expected to be 2 but is 3") do
+    assert_size([1, 2, 3], 2)
+  end
+  assertion_test_fails("when an array's size is out of range", "size of [1, 2, 3] expected to be 4..6 but is 3") do
+    assert_size([1, 2, 3], 4..6)
+  end
+
+  assertion_test_passes("when a hash size is as expected") { assert_size({:name => 'washington'}, 1) }
+  assertion_test_passes("when a hash size is in range") { assert_size({:name => 'washington'}, 1...3) }
+  assertion_test_fails("when a hash size is not as expected", "size of {} expected to be 2 but is 0") do
+    assert_size({}, 2)
+  end
+  assertion_test_fails("when a hash size is out of range", "size of {} expected to be 2...4 but is 0") do
+    assert_size({}, 2...4)
+  end
+end

data/test/report_test.rb

@@ -51,22 +51,21 @@ end # A reporter
 
 require 'stringio'
 context "StoryReporter" do
-  setup {
+  setup do
     @out = StringIO.new
     Riot::StoryReporter.new(@out)
-  }
+  emd
 
   context 'reporting on an empty context' do
     setup do
       context = Riot::Context.new('empty context') do
-        context "a nested empty context" do
-        end
+        context("a nested empty context") {}
       end
       context.run(topic)
     end
     should("not output context name") { @out.string }.empty
   end
-  
+
   context "reporting on a non-empty context" do
     setup do
       context = Riot::Context.new('supercontext') do
@@ -74,9 +73,55 @@ context "StoryReporter" do
       end
       context.run(topic)
     end
-    
+
     should('output context name') { @out.string }.matches(/supercontext/)
     should('output name of passed assertion') { @out.string }.matches(/truth/)
   end
+end
 
+context "DotMatrixReporter" do
+  setup do
+    @out = StringIO.new
+    Riot::DotMatrixReporter.new(@out)
+  end
+
+  context "with a passing test" do
+    setup do
+      context = Riot::Context.new('whatever') do
+        asserts('true') { true }
+      end
+      context.run(topic)
+      @out.string
+    end
+    asserts('puts a dot').matches('.')
+  end
+  
+  context 'with a failing test' do
+    setup do
+      Riot::Context.new('whatever') do
+        asserts('nope!') { false }
+      end.run(topic)
+      topic.results(100)
+      @out.string
+    end
+    
+    asserts('puts an F').matches('F')
+    asserts("puts the full context + assertion name").matches('whatever asserts nope!')
+    asserts("puts the failure reason").matches(/Expected .* but got false instead/)
+  end
+  
+  context 'with an error test' do
+    setup do
+      Riot::Context.new('whatever') do
+        asserts('bang') { raise "BOOM" }
+      end.run(topic)
+      topic.results(100)
+      @out.string
+    end
+    
+    asserts('puts an E').matches('E')
+    asserts('puts the full context + assertion name').matches('whatever asserts bang')
+    asserts('puts the exception message').matches('BOOM')
+    asserts('puts the exception backtrace').matches(__FILE__)
+  end
 end

data/test/teardown_test.rb

@@ -0,0 +1,42 @@
+require 'teststrap'
+
+global_thang = Struct.new(:count).new(0)
+
+context "A context with a teardown" do
+  setup do
+    @a_context = Riot::Context.new("me") do
+      setup { global_thang.count += 1 }
+      asserts("teardown run") { global_thang.count }.equals(1)
+      teardown { global_thang.count += 1 }
+    end
+    @a_context.run(MockReporter.new)
+  end
+
+  asserts("test passed") { topic.passes }.equals(1)
+  asserts("teardown run") { global_thang.count }.equals(2)
+  
+  context "that has a nested context with teardowns" do
+    setup do
+      @a_context.context "nested" do
+        setup { global_thang.count = 0 }
+        asserts("no teardowns run") { global_thang.count }.equals(0)
+        teardown { global_thang.count += 2 }
+      end
+      @a_context.run(MockReporter.new)
+    end
+    asserts("tests passed") { topic.passes }.equals(1)
+    asserts("teardowns ran in local and parent context") { global_thang.count }.equals(3)
+  end # that has a nested context with teardowns
+
+  context "that has multiple teardowns in nested context" do
+    setup do
+      @a_context.context "nested" do
+        setup { global_thang.count = 0 }
+        teardown { global_thang.count += 2 }
+        teardown { global_thang.count += 2 }
+      end
+      @a_context.run(MockReporter.new)
+    end
+    asserts("teardowns ran in local and parent context") { global_thang.count }.equals(5)
+  end # that has multiple teardowns in nested context
+end # A context with a teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riot
 version: !ruby/object:Gem::Version 
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors: 
 - Justin 'Gus' Knowlden
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 -06:00
+date: 2009-12-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - lib/riot/runnable.rb
 - lib/riot/situation.rb
 - riot.gemspec
+- test/assertion_macros/any_test.rb
 - test/assertion_macros/assigns_test.rb
 - test/assertion_macros/empty_test.rb
 - test/assertion_macros/equals_test.rb
@@ -56,6 +57,7 @@ files:
 - test/assertion_macros/raises_test.rb
 - test/assertion_macros/respond_to_test.rb
 - test/assertion_macros/same_elements_test.rb
+- test/assertion_macros/size_test.rb
 - test/assertion_test.rb
 - test/benchmark/colorize.rb
 - test/benchmark/riot_vs_minitest.rb
@@ -65,6 +67,7 @@ files:
 - test/report_test.rb
 - test/setup_test.rb
 - test/situation_test.rb
+- test/teardown_test.rb
 - test/teststrap.rb
 has_rdoc: true
 homepage: http://github.com/thumblemonks/riot
@@ -95,6 +98,7 @@ signing_key:
 specification_version: 3
 summary: An extremely fast, expressive, and context-driven unit-testing framework. Protest the slow test.
 test_files: 
+- test/assertion_macros/any_test.rb
 - test/assertion_macros/assigns_test.rb
 - test/assertion_macros/empty_test.rb
 - test/assertion_macros/equals_test.rb
@@ -106,6 +110,7 @@ test_files:
 - test/assertion_macros/raises_test.rb
 - test/assertion_macros/respond_to_test.rb
 - test/assertion_macros/same_elements_test.rb
+- test/assertion_macros/size_test.rb
 - test/assertion_test.rb
 - test/benchmark/colorize.rb
 - test/benchmark/riot_vs_minitest.rb
@@ -115,4 +120,5 @@ test_files:
 - test/report_test.rb
 - test/setup_test.rb
 - test/situation_test.rb
+- test/teardown_test.rb
 - test/teststrap.rb