riot 0.9.3 → 0.9.4

data/README.markdown

@@ -4,20 +4,20 @@ An extremely fast, expressive, and context-driven unit-testing framework. Protes
 
 ### Note on speed
 
-I have done a really simple benchmarking, but right now, Riot is running about **10-times** faster than Test::unit and thusly Shoulda:
+I have done a really simple benchmarking (10,000 runs), but right now, Riot is running about **2 times** faster than Test::unit and thusly Shoulda:
 
     $ ruby test/benchmark/simple_context_and_assertions.rb
 
     Rehearsal ----------------------------------------------
-    Riot         0.140000   0.010000   0.150000 (  0.156170)
-    Test::Unit   1.460000   0.000000   1.460000 (  1.495990)
-    Shoulda      1.490000   0.010000   1.500000 (  1.514745)
-    ------------------------------------- total: 3.110000sec
+    Riot         0.670000   0.010000   0.680000 (  0.688571)
+    Test::Unit   1.380000   0.010000   1.390000 (  1.395437)
+    Shoulda      1.380000   0.000000   1.380000 (  1.391839)
+    ------------------------------------- total: 3.450000sec
 
                      user     system      total        real
-    Riot         0.130000   0.000000   0.130000 (  0.139770)
-    Test::Unit   1.600000   0.010000   1.610000 (  1.627493)
-    Shoulda      1.610000   0.010000   1.620000 (  1.655394)
+    Riot         0.650000   0.010000   0.660000 (  0.657817)
+    Test::Unit   1.350000   0.000000   1.350000 (  1.362907)
+    Shoulda      1.380000   0.010000   1.390000 (  1.388928)
 
     Loaded suite test/benchmark/simple_context_and_assertions
 
@@ -239,10 +239,8 @@ Create or modify your existing Rakefile to define a test task like so:
     
     desc "Run all tests"
     task :test do
-      require 'riot'
       $:.concat ['./lib', './test']
-      Dir.glob("./test/*_test.rb").each { |test| require test }
-      Riot.report
+      Dir.glob("./test/**/*_test.rb").each { |test| require test }
     end
 
 Then, from the command line, you only need to run `rake` or `rake test`. Please make sure to remove all references to any other testing frameworks before running tests. For instance, do not require `test/unit`, `shoulda`, `minitest`, or anything else like it.

data/Rakefile

@@ -6,7 +6,7 @@ task :default => [:test]
 desc "Run tests"
 task :test do
   $:.concat ['./test', './lib']
-  Dir.glob("./test/*_test.rb").each { |test| require test }
+  Dir.glob("./test/**/*_test.rb").each { |test| require test }
 end
 
 desc "Run Flog against library (except tests)"

data/lib/riot.rb

@@ -4,57 +4,42 @@ require 'riot/assertion'
 require 'riot/macros'
 
 module Riot
-  #
-  # Initializing logic
-  def self.contexts
-    @contexts ||= []
-  end
 
   def self.context(description, reporter = nil, parent = nil, &block)
     reporter ||= self.reporter
     context = Context.new(description, reporter, parent)
-    reporter.time { context.instance_eval(&block) }
-    context.report # Results get buffered this way, not necessarily the best
-    (contexts << context).last
-  end
-
-  def self.dequeue_context(context)
-    contexts.delete(context)
-  end
-
-  def self.report
-    reporter.results
-    at_exit { exit false unless reporter.passed? }
+    if block_given?
+      reporter.time { context.instance_eval(&block) }
+      context.report # Results get buffered this way, not necessarily the best
+    end
+    context
   end
 
   #
   # Reporter
 
-  def self.reporter; @reporter ||= TextReport.new; end
+  def self.reporter; @reporter ||= (Riot.silently? ? NilReport.new : TextReport.new); end
   def self.reporter=(report); @reporter = report; end
   def self.silently!; @silently = true; end
   def self.silently?; @silently || false; end
 
+  def self.report
+    reporter.results
+    at_exit { exit false unless reporter.passed? }
+  end
+
+  at_exit { Riot.report unless Riot.silently? }
+
   #
-  # Exception
+  # Exceptions
 
   class Failure < Exception
-    attr_accessor :assertion, :context
-    def initialize(message, assertion=nil)
-      super(message)
-      @assertion = assertion
-    end
-
-    def contextualize(ctx)
-      @context = ctx
-      self
-    end
-    
     def print_stacktrace?; false; end
   end
+
   class Error < Failure
-    def initialize(message, assertion, error)
-      super(message, assertion)
+    def initialize(message, error)
+      super(message)
       set_backtrace(error.backtrace)
     end
     def print_stacktrace?; true; end

data/lib/riot/assertion.rb

@@ -14,7 +14,7 @@ module Riot
     end
 
     def fail(message)
-      @failure = Failure.new(message, self) unless errored?
+      @failure = Failure.new("#{description}: #{message}") unless errored?
     end
 
     def failed?; !@failure.nil?; end
@@ -27,13 +27,12 @@ module Riot
       @default_failure = fail("expected true, not #{@actual.inspect}") unless @actual == true
     rescue Failure => e
       @failure = e
-      @failure.assertion = self
     rescue Exception => e
       @raised = e
     end
 
     def error
-      Error.new("errored with #{@raised}", self, @raised) if errored?
+      Error.new("#{description}: errored with #{@raised}", @raised) if errored?
     end
   end # Assertion
 end # Riot

data/lib/riot/context.rb

@@ -32,23 +32,14 @@ module Riot
     def asserts(description, &block) new_assertion("asserts #{description}", &block); end
     def should(description, &block) new_assertion("should #{description}", &block); end
 
-    # In conclusion
     def report
-       # we should just be passing assertions to the reporter and building better descriptions earlier
-      assertions.each do |assertion|
-        if assertion.passed?
-          @reporter.passed
-        else
-          result = assertion.result.contextualize(self)
-          @reporter.send( (assertion.errored? ? :errored : :failed), result)
-        end
-      end
+      assertions.each { |assertion| @reporter.process_assertion(assertion) }
     end
 
     def to_s; @to_s ||= [@parent.to_s, @description].join(' ').strip; end
   private
     def new_assertion(description, &block)
-      (assertions << Assertion.new(description, @situation, &block)).last
+      (assertions << Assertion.new("#{to_s} #{description}", @situation, &block)).last
     end
 
     def induce_local_setup(a_situation)

data/lib/riot/report.rb

@@ -17,6 +17,14 @@ module Riot
       @time_taken += (Time.now - @start).to_f
     end
 
+    def process_assertion(assertion)
+      if assertion.passed?
+        passed
+      else
+        send((assertion.errored? ? :errored : :failed), assertion.result)
+      end
+    end
+
     def passed; @passes += 1; end
     
     def failed(failure)
@@ -30,25 +38,27 @@ module Riot
     end
   end # Report
 
+  class NilReport < Report
+    def results; end
+    def time(&block); yield; end
+  end # NilReport
+
   class TextReport < Report
     def initialize(writer=nil)
       super()
-      @writer ||= (Riot.silently? ? StringIO.new : STDOUT)
+      @writer ||= STDOUT
     end
 
     def passed
-      super
-      @writer.print('.')
+      super && @writer.print('.')
     end
 
     def failed(failure)
-      super
-      @writer.print('F')
+      super && @writer.print('F')
     end
 
     def errored(error)
-      super
-      @writer.print('E')
+      super && @writer.print('E')
     end
 
     def results
@@ -66,14 +76,6 @@ module Riot
       end
     end
 
-    def render_result(idx, result)
-      format_args = [idx, result.context.to_s, result.assertion.to_s, result.to_s]
-      "#%d - %s %s: %s" % format_args
-    end
+    def render_result(idx, result) "#%d - %s" % [idx, result.to_s]; end
   end # TextReport
-
-  class NilReport < Report
-    def results; end
-    def time(&block); yield; end
-  end # NilReport
 end # Riot

data/riot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "riot"
-  s.version  = "0.9.3"
+  s.version  = "0.9.4"
   s.date     = "2009-10-06"
   s.summary  = "An extremely fast, expressive, and context-driven unit-testing framework"
   s.email    = %w[gus@gusg.us]
@@ -26,13 +26,13 @@ Gem::Specification.new do |s|
   
   s.test_files = %w[
     Rakefile
-    test/assertion_macro_assigns_test.rb
-    test/assertion_macro_equals_test.rb
-    test/assertion_macro_exists_test.rb
-    test/assertion_macro_kind_of_test.rb
-    test/assertion_macro_matching_test.rb
-    test/assertion_macro_nil_test.rb
-    test/assertion_macro_raises_test.rb
+    test/assertion_macros/assertion_macro_assigns_test.rb
+    test/assertion_macros/assertion_macro_equals_test.rb
+    test/assertion_macros/assertion_macro_exists_test.rb
+    test/assertion_macros/assertion_macro_kind_of_test.rb
+    test/assertion_macros/assertion_macro_matching_test.rb
+    test/assertion_macros/assertion_macro_nil_test.rb
+    test/assertion_macros/assertion_macro_raises_test.rb
     test/assertion_test.rb
     test/benchmark/simple_context_and_assertions.rb
     test/context_test.rb

data/test/{assertion_macro_assigns_test.rb → assertion_macros/assertion_macro_assigns_test.rb}

@@ -1,6 +1,6 @@
 require 'teststrap'
 
-context "assigns assertion:" do
+context "assigns assertion" do
   setup do
     @fake_situation = Riot::Situation.new
     object_with_instance_variables = Riot::Situation.new
@@ -21,7 +21,7 @@ context "assigns assertion:" do
   asserts "an instance variable was defined with nil value" do
     test_object = topic
     Riot::Assertion.new("foo", @fake_situation) { test_object }.assigns(:bar).message
-  end.equals("expected @bar to be assigned a value")
+  end.matches(/expected @bar to be assigned a value/)
 
   asserts("an instance variable was assigned a specific value") do
     test_object = topic
@@ -31,10 +31,10 @@ context "assigns assertion:" do
   asserts("failure when instance never assigned even when a value is expected") do
     test_object = topic
     Riot::Assertion.new("duh", @fake_situation) { test_object }.assigns(:bar, "bar").message
-  end.equals("expected @bar to be assigned a value")
+  end.matches(/expected @bar to be assigned a value/)
 
   asserts("failure when expected value is not assigned to variable with a value") do
     test_object = topic
     Riot::Assertion.new("duh", @fake_situation) { test_object }.assigns(:foo, "baz").message
-  end.equals("expected @foo to be equal to 'baz', not 'bar'")
+  end.matches(/expected @foo to be equal to 'baz', not 'bar'/)
 end # assigns assertion

data/test/assertion_test.rb

@@ -1,6 +1,6 @@
 require 'teststrap'
 
-context "basic assertion:" do
+context "basic assertion" do
   setup { Riot::Situation.new }
 
   should "have a description" do
@@ -19,7 +19,7 @@ context "basic assertion:" do
     Riot::Assertion.new("error", topic) { raise Exception, "blah" }.errored?
   end
 
-  context "that fails while executing test" do
+  context "that fails while executing a test" do
     setup do
       fake_situation = Riot::Situation.new
       Riot::Assertion.new("error", fake_situation) { fail("I'm a bum") }
@@ -27,6 +27,5 @@ context "basic assertion:" do
 
     should("be considered a failing assertion") { topic.failed? }
     should("use failed message in description") { topic.result.message }.matches(/I'm a bum/)
-    should("assign assertion to failure") { topic.result }.assigns(:assertion)
   end # that fails while executing test
 end # basic assertion

data/test/benchmark/simple_context_and_assertions.rb

@@ -11,23 +11,11 @@ class Room
   end
 end
 
-#
-# Riot
-
-require 'riot'
-Riot.silently! # Do this before any contexts are defined
-
-context "a room" do
-  setup { @room = Room.new("bed") }
-
-  asserts("name") { @room.name }.equals("bed")
-end # a room
- 
 #
 # Test::Unit
 
 require 'test/unit'
-Test::Unit.run = false
+Test::Unit.run = true
 
 require 'test/unit/ui/console/testrunner'
 
@@ -55,6 +43,12 @@ class ShouldaRoomTest < Test::Unit::TestCase
   should("be named 'bed'") { assert_equal "bed", @room.name }
 end
 
+#
+# Riot
+
+require 'riot'
+Riot.silently!
+
 #
 # Benchmarking
 
@@ -62,7 +56,13 @@ n = 100 * 100
 
 Benchmark.bmbm do |x|
   x.report("Riot") do
-    n.times { Riot.report }
+    n.times do
+      context "a room" do
+        setup { @room = Room.new("bed") }
+
+        asserts("name") { @room.name }.equals("bed")
+      end # a room
+    end
   end
 
   x.report("Test::Unit") do

data/test/context_test.rb

@@ -1,5 +1,4 @@
 require 'teststrap'
-require 'stringio'
 
 context "any context" do
   setup do
@@ -30,56 +29,46 @@ context "any context" do
 end # any context
 
 # 
-# Test Context
+# Basic Context
 
-test_context = context("foo", Riot::NilReport.new) do
-  setup { @test_counter = 0 }
-  asserts("truthiness") { @test_counter += 1; true }
-  asserts("more truthiness") { @test_counter += 1; true }
-end # A CONTEXT THAT IS DEQUEUED
-
-context "test context" do
-  setup { Riot.dequeue_context(test_context) }
-  should("confirm context description") { test_context.to_s }.equals("foo")
-  should("confirm assertion count") { test_context.assertions.length }.equals(2)
+context "basic context" do
+  setup do
+    test_context = Riot::Context.new("foo", Riot::NilReport.new)
+    test_context.setup { @test_counter = 0 }
+    test_context.asserts("truthiness") { @test_counter += 1; true }
+    test_context.asserts("more truthiness") { @test_counter += 1; true }
+    test_context
+  end
 
-  should("call setup once per context") do
-    test_context.situation.instance_variable_get(:@test_counter) # yuck
-  end.equals(2)
-end # test context
+  asserts("context description") { topic.to_s }.equals("foo")
+  asserts("assertion count") { topic.assertions.length }.equals(2)
+  should("call setup once per context") { topic.situation }.assigns(:test_counter, 2)
+end # basic context
 
 # 
 # Nested Context
 
-inner_nested_context, other_nested_context = nil, nil
-nested_context = context("foo", Riot::NilReport.new) do
+context "nested context" do
   setup do
-    @test_counter = 0
-    @foo = "bar"
+    @parent_context = Riot::Context.new("foo", Riot::NilReport.new)
+    @parent_context.setup { @test_counter = 0; @foo = "bar" }
+    @parent_context.asserts("truthiness") { @test_counter += 1; true }
+    @parent_context
   end
-  asserts("truthiness") { @test_counter += 1; true }
   
-  inner_nested_context = context("baz") do
-    setup { @test_counter += 10 }
-  end # A CONTEXT THAT IS DEQUEUED
-
-  other_nested_context = context("bum") {} # A CONTEXT THAT IS DEQUEUED
-end # A CONTEXT THAT IS DEQUEUED
-
-context "nested context" do
-  setup do
-    [nested_context, inner_nested_context, other_nested_context].each do |c|
-      Riot.dequeue_context(c)
+  context "inner context with own setup" do
+    setup do
+      test_context = @parent_context.context("baz")
+      test_context.setup { @test_counter += 10 }
+      test_context
     end
-  end
   
-  should("inherit parent context") do
-    inner_nested_context.situation.instance_variable_get(:@test_counter)
-  end.equals(10)
-
-  should("chain context names") { inner_nested_context.to_s }.equals("foo baz")
+    should("inherit parent context") { topic.situation }.assigns(:test_counter, 10)
+    should("chain context names") { topic.to_s }.equals("foo baz")
+  end
 
-  asserts "parent setup is called even if setup not defined for self" do
-    other_nested_context.situation.instance_variable_get(:@foo)
-  end.equals("bar")
+  context "inner context without its own setup" do
+    setup { @parent_context.context("bum") }
+    asserts("parent setup is called") { topic.situation }.assigns(:foo, "bar")
+  end
 end

data/test/teststrap.rb

@@ -1,3 +1 @@
 require 'riot'
-
-at_exit { Riot.report }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: riot
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Justin Knowlden
@@ -62,13 +62,13 @@ specification_version: 3
 summary: An extremely fast, expressive, and context-driven unit-testing framework
 test_files: 
 - Rakefile
-- test/assertion_macro_assigns_test.rb
-- test/assertion_macro_equals_test.rb
-- test/assertion_macro_exists_test.rb
-- test/assertion_macro_kind_of_test.rb
-- test/assertion_macro_matching_test.rb
-- test/assertion_macro_nil_test.rb
-- test/assertion_macro_raises_test.rb
+- test/assertion_macros/assertion_macro_assigns_test.rb
+- test/assertion_macros/assertion_macro_equals_test.rb
+- test/assertion_macros/assertion_macro_exists_test.rb
+- test/assertion_macros/assertion_macro_kind_of_test.rb
+- test/assertion_macros/assertion_macro_matching_test.rb
+- test/assertion_macros/assertion_macro_nil_test.rb
+- test/assertion_macros/assertion_macro_raises_test.rb
 - test/assertion_test.rb
 - test/benchmark/simple_context_and_assertions.rb
 - test/context_test.rb