riot 0.11.0 → 0.11.1

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 .*.swp
 doc
 .yardoc
+*.tmproj

data/CHANGELOG

@@ -1,3 +1,19 @@
+*0.11.1*
+
+* Middleware can now acts more like you would expect. Middleware now know the next neighbor in the chain and can do stuff to the context before and after the user-defined context is prepared. Removes support for the handle? method. Now we act more like a Rack app. [jaknowlden]
+
+    class MyMiddleware < Riot::ContextMiddleware
+      register
+      
+      def call(context)
+        context.setup { "fooberries" }
+
+        middleware.call(context)
+
+        context.hookup { "furberries" } if context.option(:barns)
+      end
+    end
+
 *0.11.0*
 
 * Added option to Context#setup which puts the specific setup block at the beginning of the setups to be called for a context. Also useful for middlewares. [jaknowlden]

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.11.1

data/lib/riot.rb

@@ -1,4 +1,5 @@
 require 'riot/reporter'
+require 'riot/middleware'
 require 'riot/context'
 require 'riot/situation'
 require 'riot/runnable'

data/lib/riot/context.rb

@@ -1,31 +1,10 @@
 module Riot
   RootContext = Struct.new(:setups, :teardowns, :detailed_description)
 
-  class ContextMiddleware
-    # Registers the current middleware class with Riot so that it may be included in the set of middlewares
-    # Riot will poke before executing a Context.
-    #
-    #   class MyContextMiddleware < Riot::ContextMiddleware
-    #     register
-    #     def handle?(context); ...; end
-    #     def prepare(context); ...; end
-    #   end
-    def self.register; Context.middlewares << self.new; end
-
-    # Called prior to a Context being executed. If this method returns true, +call+ will be called. This
-    # methods expects to receive an instance of the Context to be executed. Generally, you will inspect
-    # various aspects of the Context to determine if this middleware is meant to be used.
-    def handle?(context); false; end
-
-    # The meat of the middleware. Because you have access to the Context, you can add your own setups,
-    # hookups, etc. +call+ will be called before any tests are run, but after the Context is configured.
-    def call(context); end
-  end
-
   module ContextClassOverrides
     def assertion_class; Assertion; end
     def situation_class; Situation; end
-  end
+  end # ContextClassOverrides
 
   module ContextOptions
     # Set options for the specific context. These options will generally be used for context middleware.
@@ -43,7 +22,7 @@ module Riot
     def option(key) options[key]; end
   private
     def options; @options ||= {}; end
-  end
+  end # ContextOptions
 
   # You make your assertions within a Context. The context stores setup and teardown blocks, and allows for
   # nesting and refactoring into helpers. Extension developers may also configure ContextMiddleware objects
@@ -71,8 +50,7 @@ module Riot
       @parent = parent || RootContext.new([],[], "")
       @description = description
       @contexts, @setups, @assertions, @teardowns = [], [], [], []
-      self.instance_eval(&definition)
-      prepare_middleware
+      prepare_middleware(&definition)
     end
 
     # Create a new test context.
@@ -201,14 +179,18 @@ module Riot
       runnables.each { |runnable| reporter.report(runnable.to_s, runnable.run(situation)) }
     end
 
+    # Prints the full description from the context tree
     def detailed_description
       "#{parent.detailed_description} #{description}".strip
     end
 
   private
 
-    def prepare_middleware
-      Context.middlewares.each { |middleware| middleware.call(self) if middleware.handle?(self) }
+    def prepare_middleware(&context_definition)
+      last_middleware = AllImportantMiddleware.new(&context_definition)
+      Context.middlewares.inject(last_middleware) do |last_middleware, middleware|
+        middleware.new(last_middleware)
+      end.call(self)
     end
 
     def runnables
@@ -232,4 +214,5 @@ module Riot
       (@assertions << assertion_class.new(description, &definition)).last
     end
   end # Context
+
 end # Riot

data/lib/riot/middleware.rb

@@ -0,0 +1,40 @@
+module Riot
+
+  class ContextMiddleware
+    # Registers the current middleware class with Riot so that it may be included in the set of middlewares
+    # Riot will poke before executing a Context.
+    #
+    #   class MyContextMiddleware < Riot::ContextMiddleware
+    #     register
+    #     def call(context)
+    #       context.setup { ... }
+    #       middleware.call(context) # this can go anywhere
+    #       context.hookup { ... }
+    #     end
+    #   end
+    def self.register; Context.middlewares << self; end
+
+    attr_reader :middleware # Theoretically, the next middleware in the stack
+
+    def initialize(middleware)
+      @middleware = middleware
+    end
+
+    # The meat. Because you have access to the Context, you can add your own setups,
+    # hookups, etc. +call+ will be called before any tests are run, but after the Context is configured.
+    def call(context)
+      raise "You should implement call yourself"
+    end
+  end # ContextMiddleware
+
+  # Special middleware used by Context directly. It will always be the last in the chain and is the actual
+  # place where the user's runtime context is processed.
+  class AllImportantMiddleware < ContextMiddleware
+    def initialize(&context_definition)
+      @context_definition = context_definition
+    end
+
+    def call(context) context.instance_eval(&@context_definition); end
+  end # AllImportantMiddleware
+
+end # Riot

data/riot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{riot}
-  s.version = "0.11.0"
+  s.version = "0.11.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin 'Gus' Knowlden"]
-  s.date = %q{2010-05-17}
+  s.date = %q{2010-06-13}
   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 = [
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
      "lib/riot/assertion_macros/size.rb",
      "lib/riot/context.rb",
      "lib/riot/message.rb",
+     "lib/riot/middleware.rb",
      "lib/riot/reporter.rb",
      "lib/riot/rr.rb",
      "lib/riot/runnable.rb",
@@ -70,6 +71,7 @@ Gem::Specification.new do |s|
      "test/core/assertion_macros/same_elements_test.rb",
      "test/core/assertion_macros/size_test.rb",
      "test/core/assertion_test.rb",
+     "test/core/chained_context_middleware_test.rb",
      "test/core/context_middleware_test.rb",
      "test/core/context_test.rb",
      "test/core/context_with_options_test.rb",
@@ -109,6 +111,7 @@ Gem::Specification.new do |s|
      "test/core/assertion_macros/same_elements_test.rb",
      "test/core/assertion_macros/size_test.rb",
      "test/core/assertion_test.rb",
+     "test/core/chained_context_middleware_test.rb",
      "test/core/context_middleware_test.rb",
      "test/core/context_test.rb",
      "test/core/context_with_options_test.rb",

data/test/core/chained_context_middleware_test.rb

@@ -0,0 +1,49 @@
+require 'teststrap'
+
+context "Chaining ContextMiddleware" do
+
+  teardown { Riot::Context.middlewares.clear }
+
+  context("when middleware halts the call chain") do
+    hookup do
+      Class.new(Riot::ContextMiddleware) do
+        register
+        def initialize(middleware); end
+        def call(context) "whoops"; end
+      end
+    end
+
+    setup do
+      situation = Riot::Situation.new
+      Riot::Context.new("Foo") do
+        setup { "foo" }
+      end.local_run(MockReporter.new, situation)
+      situation
+    end
+
+    asserts("situation topic") { topic.topic }.nil
+  end # when middleware halts the call chain
+
+  context("when middleware continues the call chain") do
+    hookup do
+      Class.new(Riot::ContextMiddleware) do
+        register
+        def call(context)
+          context.setup { ["foo"] }
+          middleware.call(context)
+          context.hookup { topic << "baz" }
+        end
+      end
+    end
+
+    setup do
+      situation = Riot::Situation.new
+      Riot::Context.new("Foo") do
+        hookup { topic << "bar" }
+      end.local_run(MockReporter.new, situation)
+      situation
+    end
+
+    asserts("situation topic") { topic.topic }.equals(%w[foo bar baz])
+  end # when middleware halts the call chain
+end # Chaining ContextMiddleware

data/test/core/context_middleware_test.rb

@@ -1,24 +1,28 @@
 require 'teststrap'
 
 context "ContextMiddleware" do
-  setup { Riot::ContextMiddleware.new }
+  setup { Riot::ContextMiddleware.new("") }
   teardown { Riot::Context.middlewares.clear }
 
-  asserts("handle? with context") { topic.handle?("Foo") }.equals(false)
-  asserts("call with context") { topic.call("Foo") }.nil
+  asserts("#call on the base class") do
+    topic.call("Foo")
+  end.raises(RuntimeError, "You should implement call yourself")
 
   context "registration" do
     setup { Class.new(Riot::ContextMiddleware) { register } }
     asserts("registered middlewares list") { Riot::Context.middlewares }.size(1)
-    asserts("registered middleware") { Riot::Context.middlewares.first }.kind_of(Riot::ContextMiddleware)
+    asserts("registered middleware") { Riot::Context.middlewares.first }.kind_of(Class)
   end # registration
 
   context "that is not meant to be used" do
     hookup do
       Class.new(Riot::ContextMiddleware) do
         register
-        def handle?(context) context.description == "Bar"; end
-        def call(context) context.setup { "fooberries" }; end
+        # def handle?(context) context.description == "Bar"; end
+        def call(context)
+          context.setup { "fooberries" } if context.description == "Bar"
+          middleware.call(context)
+        end
       end
     end
 
@@ -33,8 +37,11 @@ context "ContextMiddleware" do
     hookup do
       Class.new(Riot::ContextMiddleware) do
         register
-        def handle?(context); true; end
-        def call(context) context.setup { "fooberries" }; end
+        # def handle?(context); true; end
+        def call(context)
+          context.setup { "fooberries" }
+          middleware.call(context)
+        end
       end
     end
 
@@ -49,16 +56,20 @@ context "ContextMiddleware" do
     hookup do
       Class.new(Riot::ContextMiddleware) do
         register
-        def handle?(context); true; end
-        def call(context) context.setup { "foo" }; end
+        def call(context)
+          context.setup { topic + "berries" }
+          middleware.call(context)
+        end
       end
     end
 
     hookup do
       Class.new(Riot::ContextMiddleware) do
         register
-        def handle?(context); true; end
-        def call(context) context.setup { topic + "berries" }; end
+        def call(context)
+          context.setup { "foo" }
+          middleware.call(context)
+        end
       end
     end
 
@@ -69,12 +80,14 @@ context "ContextMiddleware" do
     asserts("tests passed") { topic.passes }.equals(1)
   end # that are not exclusive
 
-  context "has access to options" do
+  context "has access to options after context setup" do
     hookup do
       Class.new(Riot::ContextMiddleware) do
         register
-        def handle?(context); context.option(:foo) == "bar"; end
-        def call(context) context.setup { "fooberries" }; end
+        def call(context)
+          middleware.call(context)
+          context.setup { "fooberries" } if context.option(:foo) == "bar"
+        end
       end
     end
 
@@ -86,5 +99,5 @@ context "ContextMiddleware" do
     end
 
     asserts("tests passed") { topic.passes }.equals(1)
-  end # has access to options
+  end # has access to options after context setup
 end # ContextMiddleware

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 11
-  - 0
-  version: 0.11.0
+  - 1
+  version: 0.11.1
 platform: ruby
 authors: 
 - Justin 'Gus' Knowlden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 -05:00
+date: 2010-06-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - lib/riot/assertion_macros/size.rb
 - lib/riot/context.rb
 - lib/riot/message.rb
+- lib/riot/middleware.rb
 - lib/riot/reporter.rb
 - lib/riot/rr.rb
 - lib/riot/runnable.rb
@@ -104,6 +105,7 @@ files:
 - test/core/assertion_macros/same_elements_test.rb
 - test/core/assertion_macros/size_test.rb
 - test/core/assertion_test.rb
+- test/core/chained_context_middleware_test.rb
 - test/core/context_middleware_test.rb
 - test/core/context_test.rb
 - test/core/context_with_options_test.rb
@@ -167,6 +169,7 @@ test_files:
 - test/core/assertion_macros/same_elements_test.rb
 - test/core/assertion_macros/size_test.rb
 - test/core/assertion_test.rb
+- test/core/chained_context_middleware_test.rb
 - test/core/context_middleware_test.rb
 - test/core/context_test.rb
 - test/core/context_with_options_test.rb