middleware-xt 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33a68628d196f6b7324a85bbe8dab085d542a902
+  data.tar.gz: 4710ff4e7313302648c3f9f30d9b1ba3cf8c69d8
+SHA512:
+  metadata.gz: 6dc6206bdfccb179da54804e6f1a0ffbf34a89fe77f1cc5082e68965f7b59e80ef77bfaf0b34f7f30a9705203e4562e3345b51df3ef2cd02b6ec177d370c41b3
+  data.tar.gz: 8a2c2ec1e358820fcc7cebb34f3266ec93f6da4ea6d348c8b8bf45128ce1ea6fcff7e121ea3aeae086bb1ba2e13b7763642d2663e14c866be235501dd87665fe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/.yardopts

@@ -0,0 +1,3 @@
+-m markdown
+--files
+user_guide.md

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.2.0 (unreleased)
+
+
+
+## 0.1.0 (March 16, 2012)
+
+  - Initial release, almost directly extracted from [Vagrant](http://vagrantup.com)
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleware.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mitchell Hashimoto
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,2 @@
+benchmark:
+	ruby benchmarks/reusable_runner_instance.rb

data/README.md

@@ -0,0 +1,80 @@
+# Middleware
+
+[![Build Status](https://secure.travis-ci.org/mitchellh/middleware.png?branch=master)](http://travis-ci.org/mitchellh/middleware)
+
+
+-- currently a fork to play with some non-generalizable ideas ---
+
+
+This is a generalized library for using middleware patterns within
+your Ruby projects.
+
+To get started, the best place to look is [the user guide](https://github.com/mitchellh/middleware/blob/master/user_guide.md).
+
+## Installation
+
+This project is distributed as a RubyGem:
+
+```console
+$ gem install middleware
+```
+
+## Usage
+
+Once you create a basic middleware, you can use the builder to
+have a nice DSL to build middleware stacks. Calling the middleware
+is simple, as well.
+
+```ruby
+# Basic middleware that just prints the inbound and
+# outbound steps.
+class Trace
+  def initialize(app, value)
+    @app   = app
+    @value = value
+  end
+
+  def call(env)
+    puts "--> #{@value}"
+    @app.call(env)
+    puts "<-- #{@value}"
+  end
+end
+
+# Build the actual middleware stack which runs a sequence
+# of slightly different versions of our middleware.
+stack = Middleware::Builder.new do
+  use Trace, "A"
+  use Trace, "B"
+  use Trace, "C"
+end
+
+# Run it!
+stack.call(nil)
+```
+
+And the output:
+
+```
+--> A
+--> B
+--> C
+<-- C
+<-- B
+<-- A
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Benchmarks
+
+```
+  $ make benchmark
+```

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+# RSpec test task
+RSpec::Core::RakeTask.new
+
+# Make sure the default is to run RSpec
+task :default => "spec"

data/benchmarks/reusable_runner_instance.rb

@@ -0,0 +1,189 @@
+require 'bundler'
+Bundler.setup
+require 'middleware'
+require 'benchmark/ips'
+
+
+class FrontParamsValidator
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if errors = validate_params(env[:front_params])
+      env[:response][:errors] = errors
+    else
+      @app.call(env)
+    end
+  end
+
+  def validate_params(params)
+    if false
+      return [{msg: 'Bad format for param xyz!'}]
+    end
+  end
+end
+
+class ApiParamsGenerator
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    (env[:api_params]||={})[:modified] = true
+    res = @app.call(env)
+    env[:api_params][:after] = true
+    env
+  end
+end
+
+
+class ResponseModifier
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    @app.call(env)
+    env[:response][:works] = true
+    env
+  end
+end
+
+class ResponseMultiModifier
+  def initialize(app, value)
+    @app = app
+    @value = value
+  end
+
+  def call(env)
+    @app.call(env)
+    (env[:response][:multi_modifier]||=[]) << 'called with ' + @value
+    env
+  end
+end
+
+class ExceptionHandling
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    begin
+      @app.call env
+    rescue => ex
+      puts ex
+      puts ex.backtrace
+      hash = { :message => ex.to_s }
+      hash[:backtrace] = ex.backtrace
+      env['api.errors'] = MultiJson.dump(hash)
+      env
+    end
+  end
+end
+
+
+class PrepareEnvironment
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    env[:response]||= {}
+    env[:api_params]||= {}
+    @app.call(env)
+  end
+end
+
+class ApiDirect
+  def self.call(env)
+    begin
+      env[:response]||= {}
+      env[:api_params]||= {}
+      if errors = validate_params(env[:front_params])
+        env[:response][:errors] = errors
+      else
+        (env[:api_params]||={})[:modified] = true
+        env[:response][:works] = true
+
+        (env[:response][:multi_modifier]||=[]) << 'called with ' + 'first'
+        (env[:response][:multi_modifier]||=[]) << 'called with ' + 'second'
+        env[:api_params][:after] = true
+      end
+
+    rescue => ex
+      puts ex
+      puts ex.backtrace
+      hash = { :message => ex.to_s }
+      hash[:backtrace]  = ex.backtrace
+      env['api.errors'] = MultiJson.dump(hash)
+      env
+    end
+  end
+
+  def self.validate_params(params)
+    if false
+      return [{msg: 'Bad format for param xyz!'}]
+    end
+  end
+end
+
+
+ApiStack = Middleware::Builder.new do
+  use ExceptionHandling
+  use PrepareEnvironment
+  use FrontParamsValidator
+  use ApiParamsGenerator
+  use ResponseModifier
+  use ResponseMultiModifier, 'first'
+  use ResponseMultiModifier, 'second'
+end
+
+
+ApiStackReuse = Middleware::Builder.new(reuse_instance: true) do
+  use ExceptionHandling
+  use PrepareEnvironment
+  use FrontParamsValidator
+  use ApiParamsGenerator
+  use ResponseModifier
+  use ResponseMultiModifier, 'first'
+  use ResponseMultiModifier, 'second'
+end
+
+Benchmark.ips do |x|
+  x.time   = 5
+  x.warmup = 2
+
+  x.report("normal stack") {
+    env = {}
+    ApiStack.call(env)
+  }
+
+  x.report("reuse stack") {
+    env = {}
+    ApiStackReuse.call(env)
+  }
+
+  x.report("direct stack") {
+    env = {}
+    ApiDirect.call(env)
+  }
+
+  x.compare!
+end
+
+
+### results
+# Calculating -------------------------------------
+#         normal stack     8.621k i/100ms
+#          reuse stack    17.643k i/100ms
+#         direct stack    21.179k i/100ms
+# -------------------------------------------------
+#         normal stack     98.986k (± 6.4%) i/s -    500.018k
+#          reuse stack    243.372k (± 6.4%) i/s -      1.217M
+#         direct stack    285.986k (± 5.7%) i/s -      1.440M
+
+# Comparison:
+#         direct stack:   285985.9 i/s
+#          reuse stack:   243372.1 i/s - 1.18x slower
+#         normal stack:    98986.1 i/s - 2.89x slower

data/lib/middleware.rb

@@ -0,0 +1,3 @@
+require "middleware/version"
+require "middleware/builder"
+require "middleware/runner"

data/lib/middleware/builder.rb

@@ -0,0 +1,144 @@
+module Middleware
+  # This provides a DSL for building up a stack of middlewares.
+  #
+  # This code is based heavily off of `Rack::Builder` and
+  # `ActionDispatch::MiddlewareStack` in Rack and Rails, respectively.
+  #
+  # # Usage
+  #
+  # Building a middleware stack is very easy:
+  #
+  #     app = Middleware::Builder.new do
+  #       use A
+  #       use B
+  #     end
+  #
+  #     # Call the middleware
+  #     app.call(7)
+  #
+  class Builder
+    # Initializes the builder. An optional block can be passed which
+    # will be evaluated in the context of the instance.
+    #
+    # Example:
+    #
+    #     Builder.new do
+    #       use A
+    #       use B
+    #     end
+    #
+    # @param [Hash] opts Options hash
+    # @option opts [Class] :runner_class The class to wrap the middleware stack
+    #   in which knows how to run them.
+    # @yield [] Evaluated in this instance which allows you to use methods
+    #   like {#use} and such.
+    def initialize(opts=nil, &block)
+      opts ||= {}
+      @runner_class   = opts[:runner_class] || Runner
+      @reuse_instance = opts[:reuse_instance]
+      instance_eval(&block) if block_given?
+    end
+
+    # Returns a mergeable version of the builder. If `use` is called with
+    # the return value of this method, then the stack will merge, instead
+    # of being treated as a separate single middleware.
+    def flatten
+      lambda do |env|
+        self.call(env)
+      end
+    end
+
+    # Adds a middleware class to the middleware stack. Any additional
+    # args and a block, if given, are saved and passed to the initializer
+    # of the middleware.
+    #
+    # @param [Class] middleware The middleware class
+    def use(middleware, *args, &block)
+      if middleware.kind_of?(Builder)
+        # Merge in the other builder's stack into our own
+        self.stack.concat(middleware.stack)
+      else
+        self.stack << [middleware, args, block]
+      end
+
+      self
+    end
+
+    # Inserts a middleware at the given index or directly before the
+    # given middleware object.
+    def insert(index, middleware, *args, &block)
+      index = self.index(index) unless index.is_a?(Integer)
+      raise "no such middleware to insert before: #{index.inspect}" unless index
+      stack.insert(index, [middleware, args, block])
+    end
+
+    alias_method :insert_before, :insert
+
+    # Inserts a middleware after the given index or middleware object.
+    def insert_after(index, middleware, *args, &block)
+      index = self.index(index) unless index.is_a?(Integer)
+      raise "no such middleware to insert after: #{index.inspect}" unless index
+      insert(index + 1, middleware, *args, &block)
+    end
+
+    # Replaces the given middleware object or index with the new
+    # middleware.
+    def replace(index, middleware, *args, &block)
+      if index.is_a?(Integer)
+        delete(index)
+        insert(index, middleware, *args, &block)
+      else
+        insert_before(index, middleware, *args, &block)
+        delete(index)
+      end
+    end
+
+    # Deletes the given middleware object or index
+    def delete(index)
+      index = self.index(index) unless index.is_a?(Integer)
+      stack.delete_at(index)
+    end
+
+    # Runs the builder stack with the given environment.
+    def call(env=nil)
+      if @reuse_instance
+        runner_instance.call(env)
+      else
+        to_app.call(env)
+      end
+    end
+
+    protected
+
+    # Returns the numeric index for the given middleware object.
+    #
+    # @param [Object] object The item to find the index for
+    # @return [Integer]
+    def index(object)
+      stack.each_with_index do |item, i|
+        return i if item[0] == object
+      end
+
+      nil
+    end
+
+    # Returns the current stack of middlewares. You probably won't
+    # need to use this directly, and it's recommended that you don't.
+    #
+    # @return [Array]
+    def stack
+      @stack ||= []
+    end
+
+    # Converts the builder stack to a runnable action sequence.
+    #
+    # @return [Object] A callable object
+    def to_app
+      @runner_class.new(stack.dup)
+    end
+
+    def runner_instance
+      @runner_instance ||= to_app
+    end
+  end
+end

data/lib/middleware/runner.rb

@@ -0,0 +1,69 @@
+module Middleware
+  # This is a basic runner for middleware stacks. This runner does
+  # the default expected behavior of running the middleware stacks
+  # in order, then reversing the order.
+  class Runner
+    # A middleware which does nothing
+    EMPTY_MIDDLEWARE = lambda { |env| }
+
+    # Build a new middleware runner with the given middleware
+    # stack.
+    #
+    # Note: This class usually doesn't need to be used directly.
+    # Instead, take a look at using the {Builder} class, which is
+    # a much friendlier way to build up a middleware stack.
+    #
+    # @param [Array] stack An array of the middleware to run.
+    def initialize(stack)
+      # We need to take the stack of middleware and initialize them
+      # all so they call the proper next middleware.
+      @kickoff = build_call_chain(stack)
+    end
+
+    # Run the middleware stack with the given state bag.
+    #
+    # @param [Object] env The state to pass into as the initial
+    #   environment data. This is usual a hash of some sort.
+    def call(env)
+      # We just call the kickoff middleware, which is responsible
+      # for properly calling the next middleware, and so on and so
+      # forth.
+      @kickoff.call(env)
+    end
+
+    protected
+
+    # This takes a stack of middlewares and initializes them in a way
+    # that each middleware properly calls the next middleware.
+    def build_call_chain(stack)
+      # We need to instantiate the middleware stack in reverse
+      # order so that each middleware can have a reference to
+      # the next middleware it has to call. The final middleware
+      # is always the empty middleware, which does nothing but return.
+      stack.reverse.inject(EMPTY_MIDDLEWARE) do |next_middleware, current_middleware|
+        # Unpack the actual item
+        klass, args, block = current_middleware
+
+        # Default the arguments to an empty array. Otherwise in Ruby 1.8
+        # a `nil` args will actually pass `nil` into the class. Not what
+        # we want!
+        args ||= []
+
+        if klass.is_a?(Class)
+          # If the klass actually is a class, then instantiate it with
+          # the app and any other arguments given.
+          klass.new(next_middleware, *args, &block)
+        elsif klass.respond_to?(:call)
+          # Make it a lambda which calls the item then forwards up
+          # the chain.
+          lambda do |env|
+            klass.call(env)
+            next_middleware.call(env)
+          end
+        else
+          raise "Invalid middleware, doesn't respond to `call`: #{klass.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/middleware/version.rb

@@ -0,0 +1,3 @@
+module Middleware
+  VERSION = "0.2.0"
+end

data/middleware.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/middleware/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mitchell Hashimoto", "Roman Heinrich"]
+  gem.email         = ["mitchell.hashimoto@gmail.com"]
+  gem.description   = %q{Generalized implementation of the middleware abstraction for Ruby.}
+  gem.summary       = %q{Generalized implementation of the middleware abstraction for Ruby.}
+  gem.homepage      = "https://github.com/mindreframer/middleware"
+  gem.license       = "MIT"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "redcarpet", "~> 2.1.0"
+  gem.add_development_dependency "rspec-core", "~> 2.8.0"
+  gem.add_development_dependency "rspec-expectations", "~> 2.8.0"
+  gem.add_development_dependency "rspec-mocks", "~> 2.8.0"
+  gem.add_development_dependency "yard", "~> 0.7.5"
+  gem.add_development_dependency "benchmark-ips"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "middleware-xt"
+  gem.require_paths = ["lib"]
+  gem.version       = Middleware::VERSION
+end

data/spec/middleware/builder_spec.rb

@@ -0,0 +1,160 @@
+require File.expand_path("../../setup", __FILE__)
+require "middleware"
+
+describe Middleware::Builder do
+  let(:data) { { :data => [] } }
+  let(:instance) { described_class.new }
+
+  # This returns a proc that can be used with the builder
+  # that simply appends data to an array in the env.
+  def appender_proc(data)
+    Proc.new { |env| env[:data] << data }
+  end
+
+  context "basic `use`" do
+    it "should add items to the stack and make them callable" do
+      data = {}
+      proc = Proc.new { |env| env[:data] = true }
+
+      instance.use proc
+      instance.call(data)
+
+      data[:data].should == true
+    end
+
+    it "should be able to add multiple items" do
+      data = {}
+      proc1 = Proc.new { |env| env[:one] = true }
+      proc2 = Proc.new { |env| env[:two] = true }
+
+      instance.use proc1
+      instance.use proc2
+      instance.call(data)
+
+      data[:one].should == true
+      data[:two].should == true
+    end
+
+    it "should be able to add another builder" do
+      data  = {}
+      proc1 = Proc.new { |env| env[:one] = true }
+
+      # Build the first builder
+      one   = described_class.new
+      one.use proc1
+
+      # Add it to this builder
+      two   = described_class.new
+      two.use one
+
+      # Call the 2nd and verify results
+      two.call(data)
+      data[:one].should == true
+    end
+
+    it "should default the env to `nil` if not given" do
+      result = false
+      proc = Proc.new { |env| result = env.nil? }
+
+      instance.use proc
+      instance.call
+
+      result.should be
+     end
+  end
+
+  context "inserting" do
+    it "can insert at an index" do
+      instance.use appender_proc(1)
+      instance.insert(0, appender_proc(2))
+      instance.call(data)
+
+      data[:data].should == [2, 1]
+    end
+
+    it "can insert next to a previous object" do
+      proc2 = appender_proc(2)
+      instance.use appender_proc(1)
+      instance.use proc2
+      instance.insert(proc2, appender_proc(3))
+      instance.call(data)
+
+      data[:data].should == [1, 3, 2]
+    end
+
+    it "can insert before" do
+      instance.use appender_proc(1)
+      instance.insert_before 0, appender_proc(2)
+      instance.call(data)
+
+      data[:data].should == [2, 1]
+    end
+
+    it "raises an exception if attempting to insert before an invalid object" do
+      expect { instance.insert "object", appender_proc(1) }.
+        to raise_error(RuntimeError)
+    end
+
+    it "can insert after" do
+      instance.use appender_proc(1)
+      instance.use appender_proc(3)
+      instance.insert_after 0, appender_proc(2)
+      instance.call(data)
+
+      data[:data].should == [1, 2, 3]
+    end
+
+    it "raises an exception if attempting to insert after an invalid object" do
+      expect { instance.insert_after "object", appender_proc(1) }.
+        to raise_error(RuntimeError)
+    end
+  end
+
+  context "replace" do
+    it "can replace an object" do
+      proc1 = appender_proc(1)
+      proc2 = appender_proc(2)
+
+      instance.use proc1
+      instance.replace proc1, proc2
+      instance.call(data)
+
+      data[:data].should == [2]
+    end
+
+    it "can replace by index" do
+      proc1 = appender_proc(1)
+      proc2 = appender_proc(2)
+
+      instance.use proc1
+      instance.replace 0, proc2
+      instance.call(data)
+
+      data[:data].should == [2]
+    end
+  end
+
+  context "deleting" do
+    it "can delete by object" do
+      proc1 = appender_proc(1)
+
+      instance.use proc1
+      instance.use appender_proc(2)
+      instance.delete proc1
+      instance.call(data)
+
+      data[:data].should == [2]
+    end
+
+    it "can delete by index" do
+      proc1 = appender_proc(1)
+
+      instance.use proc1
+      instance.use appender_proc(2)
+      instance.delete 0
+      instance.call(data)
+
+      data[:data].should == [2]
+    end
+  end
+end

data/spec/middleware/runner_spec.rb

@@ -0,0 +1,193 @@
+require File.expand_path("../../setup", __FILE__)
+require "middleware"
+
+describe Middleware::Runner do
+  it "should work with an empty stack" do
+    instance = described_class.new([])
+    expect { instance.call({}) }.to_not raise_error
+  end
+
+  it "should call classes in the proper order" do
+    a = Class.new do
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env[:result] << "A"
+        @app.call(env)
+        env[:result] << "A"
+      end
+    end
+
+    b = Class.new do
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env[:result] << "B"
+        @app.call(env)
+        env[:result] << "B"
+      end
+    end
+
+    env = { :result => [] }
+    instance = described_class.new([a, b])
+    instance.call(env)
+    env[:result].should == ["A", "B", "B", "A"]
+  end
+
+  it "should call lambdas in the proper order" do
+    data = []
+    a = lambda { |env| data << "A" }
+    b = lambda { |env| data << "B" }
+
+    instance = described_class.new([a, b])
+    instance.call({})
+
+    data.should == ["A", "B"]
+  end
+
+  it "passes in arguments if given" do
+    a = Class.new do
+      def initialize(app, value)
+        @app   = app
+        @value = value
+      end
+
+      def call(env)
+        env[:result] = @value
+      end
+    end
+
+    env = {}
+    instance = described_class.new([[a, 42]])
+    instance.call(env)
+
+    env[:result].should == 42
+  end
+
+  it "passes in a block if given" do
+    a = Class.new do
+      def initialize(app, &block)
+        @block = block
+      end
+
+      def call(env)
+        env[:result] = @block.call
+      end
+    end
+
+    block = Proc.new { 42 }
+    env = {}
+    instance = described_class.new([[a, nil, block]])
+    instance.call(env)
+
+    env[:result].should == 42
+  end
+
+  it "should raise an error if an invalid middleware is given" do
+    expect { described_class.new([27]) }.to raise_error(/Invalid middleware/)
+  end
+
+  it "should not call middlewares which aren't called" do
+    # A does not call B, so B should never execute
+    data = []
+    a = Class.new do
+      def initialize(app); @app = app; end
+
+      define_method :call do |env|
+        data << "a"
+      end
+    end
+
+    b = lambda { |env| data << "b" }
+
+    env = {}
+    instance = described_class.new([a, b])
+    instance.call(env)
+
+    data.should == ["a"]
+  end
+
+  describe "exceptions" do
+    it "should propagate the exception up the middleware chain" do
+      # This tests a few important properties:
+      # * Exceptions propagate multiple middlewares
+      #   - C raises an exception, which raises through B to A.
+      # * Rescuing exceptions works
+      data = []
+      a = Class.new do
+        def initialize(app)
+          @app = app
+        end
+
+        define_method :call do |env|
+          data << "a"
+          begin
+            @app.call(env)
+            data << "never"
+          rescue Exception => e
+            data << "e"
+            raise
+          end
+        end
+      end
+
+      b = Class.new do
+        def initialize(app); @app = app; end
+
+        define_method :call do |env|
+          data << "b"
+          @app.call(env)
+        end
+      end
+
+      c = lambda { |env| raise "ERROR" }
+
+      env = {}
+      instance = described_class.new([a, b, c])
+      expect { instance.call(env) }.to raise_error
+
+      data.should == ["a", "b", "e"]
+    end
+
+    it "should stop propagation if rescued" do
+      # This test mainly tests that if there is a sequence A, B, C, and
+      # an exception is raised in C, that if B rescues this, then the chain
+      # continues fine backwards.
+      data = []
+      a = Class.new do
+        def initialize(app); @app = app; end
+
+        define_method :call do |env|
+          data << "in_a"
+          @app.call(env)
+          data << "out_a"
+        end
+      end
+
+      b = Class.new do
+        def initialize(app); @app = app; end
+
+        define_method :call do |env|
+          data << "in_b"
+          @app.call(env) rescue nil
+          data << "out_b"
+        end
+      end
+
+      c = lambda do |env|
+        data << "in_c"
+        raise "BAD"
+      end
+
+      env = {}
+      instance = described_class.new([a, b, c])
+      instance.call(env)
+
+      data.should == ["in_a", "in_b", "in_c", "out_b", "out_a"]
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "rspec/autorun"
+
+# Do not buffer output
+$stdout.sync = true
+$stderr.sync = true
+
+# Configure RSpec
+RSpec.configure do |c|
+end

data/user_guide.md

@@ -0,0 +1,207 @@
+# Middleware User Guide
+
+`middleware` is a library which provides a generalized implementation
+of the middleware pattern for Ruby. The middleware pattern is a useful
+abstraction tool in various cases, but is specifically useful for splitting
+large sequential chunks of logic into small pieces.
+
+## Installing
+
+Middleware is distributed as a RubyGem, so simply gem install:
+
+```console
+$ gem install middleware
+```
+
+## A Basic Example
+
+Below is a basic example of the library in use. If you don't understand
+what middleware is, please read below. This example is simply meant to give
+you a quick idea of what the library looks like.
+
+```ruby
+# Basic middleware that just prints the inbound and
+# outbound steps.
+class Trace
+  def initialize(app, value)
+    @app   = app
+    @value = value
+  end
+
+  def call(env)
+    puts "--> #{@value}"
+    @app.call(env)
+    puts "<-- #{@value}"
+  end
+end
+
+# Build the actual middleware stack which runs a sequence
+# of slightly different versions of our middleware.
+stack = Middleware::Builder.new do
+  use Trace, "A"
+  use Trace, "B"
+  use Trace, "C"
+end
+
+# Run it!
+stack.call(nil)
+```
+
+And the output:
+
+```
+--> A
+--> B
+--> C
+<-- C
+<-- B
+<-- A
+```
+
+
+
+## Middleware
+
+### What is it?
+
+Middleware is a reusable chunk of logic that is called to perform some
+action. The middleware itself is responsible for calling up the next item
+in the middleware chain using a recursive-like call. This allows middleware
+to perform logic both _before_ and _after_ something is done.
+
+The canonical middleware example is in web request processing, and middleware
+is used heavily by both [Rack](#) and [Rails](#).
+In web processing, the first middleware is called with some information about
+the web request, such as HTTP headers, request URL, etc. The middleware is
+responsible for calling the next middleware, and may modify the request along
+the way. When the middlewares begin returning, the state now has the HTTP
+response, so that the middlewares can then modify the response.
+
+Cool? Yeah! And this pattern is generally usable in a wide variety of
+problems.
+
+### Middleware Classes
+
+One method of creating middleware, and by far the most common, is to define
+a class that duck types to the following interface:
+
+```ruby
+class MiddlewareExample
+  def initialize(app); end
+  def call(env); end
+end
+```
+
+Therefore, a basic middleware example follows:
+
+```ruby
+class Trace
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    puts "Trace up"
+    @app.call(env)
+    puts "Trace down"
+  end
+end
+```
+
+A basic description of the two methods that a middleware must implement:
+
+  * **initialize(app)** - This is a constructor. It can take additional arguments
+    but the first argument sent will always be the next middleware to call, called
+    `app` for historical reasons. This should be stored away for later.
+
+  * **call(env)** - This is what is actually invoked to do work. `env` is just some
+    state sent in (defined by the caller, but usually a Hash). This call should also
+    call `app.call(env)` at some point to move on.
+
+### Middleware Lambdas
+
+A middleware can also be a simple lambda. The downside of using a lambda is that
+it only has access to the state on the initial call, there is no "post" step for
+lambdas. A basic example, in the context of a web request:
+
+```ruby
+lambda { |env| puts "You requested: #{env["http.request_url"]}" }
+```
+
+## Middleware Stacks
+
+Middlewares on their own are useful as small chunks of logic, but their real
+power comes from building them up into a _stack_. A stack of middlewares are
+executed in the order given.
+
+### Basic Building and Running
+
+The middleware library comes with a `Builder` class which provides a nice DSL
+for building a stack of middlewares:
+
+```ruby
+stack = Middleware::Builder.new do
+  use Trace
+  use lambda { |env| puts "LAMBDA!" }
+end
+```
+
+This `stack` variable itself is now a valid middleware and has the same interface,
+so to execute the stack, just call `call` on it:
+
+```ruby
+stack.call
+```
+
+The call method takes an optional parameter which is the state to pass into the
+initial middleware.
+
+### Manipulating a Stack
+
+Stacks also provide a set of methods for manipulating the middleware stack. This
+lets you insert, replace, and delete middleware after a stack has already been
+created. Given the `stack` variable created above, we can manipulate it as
+follows. Please imagine that each example runs with the original `stack` variable,
+so that the order of the examples doesn't actually matter:
+
+```ruby
+# Insert a new item after the Trace middleware
+stack.insert_after(Trace, SomeOtherMiddleware)
+
+# Replace the lambda
+stack.replace(1, SomeOtherMiddleware)
+
+# Delete the lambda
+stack.delete(1)
+```
+
+### Passing Additional Constructor Arguments
+
+When using middleware in a stack, you can also pass in additional constructor
+arguments. Given the following middleware:
+
+```ruby
+class Echo
+  def initialize(app, message)
+    @app = app
+    @message = message
+  end
+
+  def call(env)
+    puts @message
+    @app.call(env)
+  end
+end
+```
+
+We can initialize `Echo` with a proper message as follows:
+
+```ruby
+Middleware::Builder.new do
+  use Echo, "Hello, World!"
+end
+```
+
+Then when the stack is called, it will output "Hello, World!"
+
+Note that you can also pass blocks in using the `use` method.

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: middleware-xt
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mitchell Hashimoto
+- Roman Heinrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generalized implementation of the middleware abstraction for Ruby.
+email:
+- mitchell.hashimoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- benchmarks/reusable_runner_instance.rb
+- lib/middleware.rb
+- lib/middleware/builder.rb
+- lib/middleware/runner.rb
+- lib/middleware/version.rb
+- middleware.gemspec
+- spec/middleware/builder_spec.rb
+- spec/middleware/runner_spec.rb
+- spec/setup.rb
+- user_guide.md
+homepage: https://github.com/mindreframer/middleware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Generalized implementation of the middleware abstraction for Ruby.
+test_files:
+- spec/middleware/builder_spec.rb
+- spec/middleware/runner_spec.rb
+- spec/setup.rb
+has_rdoc: