substation 0.0.8 → 0.0.9

data/lib/substation/dispatcher.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Substation
 
   # Encapsulates all registered actions and their observers
@@ -249,7 +251,7 @@ module Substation
     #
     # @api public
     def call(name, input)
-      fetch(name).call(Request.new(env, input))
+      fetch(name).call(Request.new(name, env, input))
     end
 
     # The names of all registered actions

data/lib/substation/environment.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Substation
 
   # The environment holding all registered {Chain} processors
@@ -15,7 +17,9 @@ module Substation
     #
     # @api private
     def self.build(&block)
-      new(DSL.registry(&block))
+      registry  = DSL.registry(&block)
+      chain_dsl = Chain::DSL::Builder.call(registry)
+      new(registry, chain_dsl)
     end
 
     # Initialize a new instance
@@ -26,9 +30,8 @@ module Substation
     # @return [undefined]
     #
     # @api private
-    def initialize(registry)
-      @registry  = registry
-      @chain_dsl = Chain::DSL::Builder.call(@registry)
+    def initialize(registry, chain_dsl)
+      @registry, @chain_dsl = registry, chain_dsl
     end
 
     # Build a new {Chain} instance
@@ -42,8 +45,8 @@ module Substation
     # @return [Chain]
     #
     # @api private
-    def chain(other = Chain::EMPTY, &block)
-      Chain.build(@chain_dsl, other, &block)
+    def chain(other = Chain::EMPTY, failure_chain = Chain::EMPTY, &block)
+      @chain_dsl.build(other, failure_chain, &block)
     end
 
     protected

data/lib/substation/environment/dsl.rb

@@ -1,7 +1,9 @@
+# encoding: utf-8
+
 module Substation
   class Environment
 
-    # The DSL class used to define register processors
+    # The DSL class used to register processors
     class DSL
 
       # The registry of processors
@@ -11,7 +13,6 @@ module Substation
       # @api private
       attr_reader :registry
 
-
       # The registry of processors
       #
       # @param [Proc] block
@@ -49,7 +50,7 @@ module Substation
       #
       # @api private
       def register(name, processor)
-        @registry[name] = processor
+        @registry[name.to_sym] = processor
         self
       end
 

data/lib/substation/observer.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Substation
 
   # Abstract observer base class

data/lib/substation/processor.rb

@@ -1,23 +1,122 @@
+# encoding: utf-8
+
 module Substation
 
   # Namespace for chain processors
   module Processor
 
-    include AbstractType
-    include Adamantium::Flat
+    # Test wether chain processing should continue
+    #
+    # @param [Response] response
+    #   the response returned from invoking the processor
+    #
+    # @return [true] for a successful response
+    # @return [false] otherwise
+    #
+    # @api private
+    def success?(response)
+      response.success?
+    end
+
+    # The response passed on to the next processor in a {Chain}
+    #
+    # @param [Response] response
+    #   the response returned from invoking the processor
+    #
+    # @return [Response]
+    #   the response passed on to the next processor in a {Chain}
+    #
+    # @api private
+    def result(response)
+      response
+    end
+
+    module Fallible
+      include Concord.new(:name, :handler, :failure_chain)
+
+      # This processor's name
+      #
+      # @return [Symbol]
+      #
+      # @api private
+      attr_reader :name
 
-    abstract_method :call
-    abstract_method :result
+      # Return a new processor with +chain+ as failure_chain
+      #
+      # @param [#call] chain
+      #   the failure chain to use for the new processor
+      #
+      # @return [#call]
+      #
+      # @api private
+      def with_failure_chain(chain)
+        self.class.new(name, handler, chain)
+      end
+    end
 
     module Incoming
       include Processor
-      include Chain::Incoming
+      include Fallible
+
+      # The request passed on to the next processor in a {Chain}
+      #
+      # @param [Response] _response
+      #   the response returned from invoking this processor
+      #
+      # @return [Request]
+      #   the request passed on to the next processor in a {Chain}
+      #
+      # @api private
+      def result(_response)
+        super.to_request
+      end
+    end
+
+    module Pivot
+      include Processor
+      include Fallible
     end
 
     module Outgoing
+      include Concord.new(:name, :handler)
       include Processor
-      include Chain::Outgoing
-    end
 
+      # This processor's name
+      #
+      # @return [Symbol]
+      #
+      # @api private
+      attr_reader :name
+
+      # Test wether chain processing should continue
+      #
+      # @param [Response] _response
+      #   the response returned from invoking the processor
+      #
+      # @return [false]
+      #
+      # @api private
+      def success?(_response)
+        true
+      end
+
+      private
+
+      # Build a new {Response} based on +response+ and +output+
+      #
+      # @param [Response] response
+      #   the original response
+      #
+      # @param [Object] output
+      #   the data to be wrapped within the new {Response}
+      #
+      # @return [Response]
+      #
+      # @api private
+      def respond_with(response, output)
+        response.class.new(response.request, output)
+      end
+
+    end # module Outgoing
   end # module Processor
 end # module Substation

data/lib/substation/processor/evaluator.rb

@@ -1,11 +1,60 @@
+# encoding: utf-8
+
 module Substation
   module Processor
 
-    # A processor to evaluate a chain's request input data
+    # Abstract processor to evaluate a request coming into a chain
     class Evaluator
 
-      include Incoming
-      include Concord.new(:handler)
+      # Processor to evaluate request input data
+      class Data < self
+        include Incoming
+
+        private
+
+        # Invoke the handler
+        #
+        # @param [Request] request
+        #   the request to evaluate
+        #
+        # @return [Response]
+        #
+        # @api private
+        def invoke(request)
+          handler.call(request.input)
+        end
+
+      end
+
+      # Processor to evaluate an incoming request
+      class Request < self
+        include Incoming
+      end
+
+      # Processor to evaluate a pivot chain handler
+      class Pivot < self
+        include Processor::Pivot
+
+        private
+
+        # Return a successful response
+        #
+        # @param [Request] _request
+        #   the evaluated request
+        #
+        # @param [#output] result
+        #   the evaluation result
+        #
+        # @return [Response::Success]
+        #
+        # @api private
+        def on_success(_request, response)
+          response
+        end
+      end
+
+      include Adamantium::Flat
+      include AbstractType
 
       # Evaluate a chain's request input data
       #
@@ -16,15 +65,57 @@ module Substation
       #
       # @api private
       def call(request)
-        result = handler.call(request.input)
-        output = result.output
+        result = invoke(request)
         if result.success?
-          request.success(output)
+          on_success(request, result)
         else
-          request.error(output)
+          on_failure(request, result)
         end
       end
 
+      private
+
+      # Invoke the handler
+      #
+      # @param [Request] request
+      #   the request to evaluate
+      #
+      # @return [Response]
+      #
+      # @api private
+      def invoke(request)
+        handler.call(request)
+      end
+
+      # Return a successful response
+      #
+      # @param [Request] request
+      #   the evaluated request
+      #
+      # @param [#output] result
+      #   the evaluation result
+      #
+      # @return [Response::Success]
+      #
+      # @api private
+      def on_success(request, result)
+        request.success(result.output)
+      end
+
+      # Return a failure response by invoking a failure chain
+      #
+      # @param [Request] request
+      #   the evaluated request
+      #
+      # @param [#output] result
+      #   the evaluation result
+      #
+      # @return [Response::Failure]
+      #
+      # @api private
+      def on_failure(request, result)
+        failure_chain.call(request.error(result.output))
+      end
     end # class Evaluator
   end # module Processor
 end # module Substation

data/lib/substation/processor/transformer.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Substation
+  module Processor
+
+    # A processor that transforms output data into something else
+    class Transformer
+
+      include Processor::Outgoing
+      include Adamantium::Flat
+
+      # Transform response data into something else
+      #
+      # @param [Response] response
+      #   the response to process
+      #
+      # @return [Response]
+      #
+      # @api private
+      def call(response)
+        respond_with(response, handler.call(response))
+      end
+
+    end # class Wrapper
+  end # module Processor
+end # module Substation

data/lib/substation/processor/wrapper.rb

@@ -1,11 +1,13 @@
+# encoding: utf-8
+
 module Substation
   module Processor
 
     # A processor that wraps output data in a new handler instance
     class Wrapper
 
-      include Outgoing
-      include Concord.new(:handler)
+      include Processor::Outgoing
+      include Adamantium::Flat
 
       # Wrap response data in an instance of {#handler}
       #
@@ -16,7 +18,7 @@ module Substation
       #
       # @api private
       def call(response)
-        respond_with(response, handler.new(response.output))
+        respond_with(response, handler.new(response.data))
       end
 
     end # class Wrapper

data/lib/substation/request.rb

@@ -1,11 +1,20 @@
+# encoding: utf-8
+
 module Substation
 
   # Encapsulates the application environment and an input model instance
   class Request
 
-    include Concord.new(:env, :input)
+    include Concord.new(:name, :env, :input)
     include Adamantium::Flat
 
+    # The name of the request
+    #
+    # @return [Symbol]
+    #
+    # @api private
+    attr_reader :name
+
     # The application environment
     #
     # @example
@@ -36,6 +45,8 @@ module Substation
     # @api public
     attr_reader :input
 
+    alias_method :data, :input
+
     # Create a new successful response
     #
     # @example

data/lib/substation/response.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Substation
 
   # Base class for action responses
@@ -91,6 +93,8 @@ module Substation
     # @api public
     attr_reader :output
 
+    alias_method :data, :output
+
     # Initialize a new instance
     #
     # @param [Request] request
@@ -127,6 +131,15 @@ module Substation
     # @api public
     abstract_method :success?
 
+    # Return a {Request} instance built upon this response
+    #
+    # @return [Request]
+    #
+    # @api private
+    def to_request
+      Request.new(request.name, env, output)
+    end
+
     # An errorneous {Response}
     class Failure < self