meddler 0.0.2 → 0.0.3

data/README.rdoc

@@ -2,7 +2,30 @@
 
 == Hey, someone meddled with my middleware!
 
-This lets you have on_request and on_response wrappers around a builder, and optionally skip them in either case.
+This lets you have +on_request+ and +on_response+ wrappers around a builder, and optionally skip them in either case. It also gives you before and after even hooks, to do something else awesome before you proceed.
+
+=== Why?
+
+There's a few reasons you might want to do this.  One is that you may have an expensive sub stack that only needs to run on specifiec urls, or you may want to make something available only to part of the userbase.  Here's an example:
+
+  require 'meddler'
+  use Meddler::Builder do
+    on_request {|req| req.will_be_expensive? }
+    use ExpensiveMiddleware
+    use AnotherExpensiveMiddleware
+  end
+
+Or perhaps you want to give all of your developers Rack::Bug even in production.
+
+  require 'meddler'
+  use Meddler::Builder do
+    on_request do |req|
+      req.env['warden'].authenticate
+      user = req.env['warden'].user
+      user && user.staff_developer?
+    end
+    use Rack::Bug
+  end
 
 == Usage
 
@@ -11,6 +34,7 @@ In your rackup file, do this:
   require 'meddler'
   use Meddler::Builder do
     on_request {|req| req.post?}
+    before {|req| puts "yup, we passed, and now we're onto passing in the request"}
     use MungePostMiddleware
   end
 
@@ -19,6 +43,8 @@ Or, on response
   require 'meddler'
   use Meddler::Builder do
     on_response {|resp| resp.status == 200}
+    after {|req| puts "yup, we passed, just about to pass the response back to the middleware stack in here"}
     use MiddlewareThatLikesOkThings
   end
 
+You can have as many +on_request+ and +on_response+ as you'd like, and processing will stop on the first one that returns false. +before+ and +after+ hooks will get called in order and be called with an instance of <tt>Rack::Request</tt> and <tt>Rack::Response</tt> respectively. 

data/Rakefile

@@ -15,3 +15,17 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
+require 'spec'
+require 'spec/rake/spectask'
+task :spec => 'spec:all'
+namespace(:spec) do
+  Spec::Rake::SpecTask.new(:all) do |t|
+    t.spec_opts ||= []
+    t.spec_opts << "-rubygems"
+    t.spec_opts << "-rlib/meddler"
+    t.spec_opts << "--options" << "spec/spec.opts"
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+end
+

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/meddler.rb

@@ -5,9 +5,12 @@ require 'meddler/builder'
 
 class Meddler
 
-  def initialize(app, on_request, on_response, before, after, wrapped_app)
-    wrapped_app.run(PostInterceptor.new(app, on_response, after, signal))
-    @app = PreInterceptor.new(wrapped_app.to_app, app, on_request, before)
+  attr_reader :original_app, :app
+
+  def initialize(original_app, on_request, on_response, before, after, wrapped_app, skip_app = original_app)
+    @original_app, @skip_app = original_app, skip_app
+    wrapped_app.run(PostInterceptor.new(original_app, on_response, after, signal))
+    @app = PreInterceptor.new(wrapped_app.to_app, skip_app, on_request, before)
   end
   
   def signal
@@ -16,9 +19,19 @@ class Meddler
   
   def call(env)
     response = catch(signal) do
-      @app.call(env)
+      app.call(env)
+    end
+
+    if response.length == 4 && response.last == signal
+      response.pop
+      if @skip_app != @original_app
+        @skip_app.call(env)
+      else
+       response
+      end
+    else
+      response
     end
-    response
   end
   
 
@@ -36,9 +49,9 @@ class Meddler
       response = Rack::Response.new(raw_response[2], raw_response[0], raw_response[1])
       if rules.nil? || rules.all?{|r| r.call(response)}
         filters && filters.each{|f| f.call(response)}
-        response.to_a
+        [response.status, response.headers, response.body]
       else
-        throw signal, response.to_a
+        throw signal, [response.status, response.headers, response.body, signal]
       end
     end
 
@@ -57,9 +70,9 @@ class Meddler
       request = Rack::Request.new(env)
       if rules.nil? || rules.all?{|f| f.call(request)}
         filters && filters.each{|f| f.call(request)}
-        app.call(env)
+        app.call(request.env)
       else
-        skip_app.call(env)
+        skip_app.call(request.env)
       end
     end
   end

data/lib/meddler/builder.rb

@@ -1,27 +1,54 @@
 class Meddler
   class Builder
 
-    def initialize(app, rules = nil, &block)
-      @app = app
+    attr_reader :app, :target
+
+    def initialize(endpoint, &block)
       @target = Rack::Builder.new{}
       instance_eval(&block)
-      @meddler = Meddler.new(@app, @on_request, @on_response, @before, @after, @target)
+      @app = if @run_endpoint
+        Meddler.new(@run_endpoint, @on_request, @on_response, @before, @after, @target, endpoint)
+      else
+        Meddler.new(endpoint, @on_request, @on_response, @before, @after, @target)
+      end
     end
     
     def method_missing(method, *args, &block)
-      @target.send(method, *args, &block)
+      if method == :run
+        @run_endpoint = args.first
+      else
+        target.send(method, *args, &block)
+      end
+    end
+    
+    def add_to_on_request
+      (@on_request ||= []) << yield
+    end
+    
+    def add_to_on_response
+      (@on_response ||= []) << yield
     end
     
     def on_request(&block)
-      @on_request ||= []
-      @on_request << block
+      add_to_on_request { block }
     end
       
     def on_response(&block)
-      @on_response ||= []
-      @on_response << block
+      add_to_on_response { block }
     end
       
+    def on_status(status)
+      add_to_on_response { proc{|response| status === response.status } }
+    end
+      
+    def on_path_info(path_info)
+      add_to_on_request { proc{|request| path_info === request.path_info } }
+    end
+      
+    def on_xhr?(invert = false)
+      add_to_on_request { proc{|request| invert ^ request.xhr? } }
+    end
+    
     def before(&block)
       @before ||= []
       @before << block
@@ -33,7 +60,7 @@ class Meddler
     end
     
     def call(env)
-      @meddler.call(env)
+      app.call(env)
     end
 
   end

data/spec/meddler_spec.rb

@@ -0,0 +1,151 @@
+require 'rack'
+
+class TestMiddleware
+  attr_reader :state
+  
+  @@last_instance = nil
+  
+  def self.last_instance
+    @@last_instance
+  end
+  
+  def self.reset_last_instance!
+    @last_instance = nil
+  end
+
+  def initialize(app)
+    @@last_instance = self
+    @state = :initial
+    @app = app
+  end
+
+  def call(env)
+    @state = :pre
+    response = @app.call(env)
+    @state = :post
+    response
+  end
+end
+
+describe Meddler do
+  
+  before(:each) do
+    TestMiddleware.reset_last_instance!
+    @app = proc {|env| [200, {'Content-type' => 'text/html', 'Content-length' => '5'}, ['hello']]}
+  end
+  
+  it "should run normally" do
+    @builder = Meddler::Builder.new(@app) do
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :post
+  end
+
+  it "should stop on_request" do
+    @builder = Meddler::Builder.new(@app) do
+      on_request{|request| request.post? }
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :initial
+  end
+
+  it "should stop multiple on_request" do
+    @builder = Meddler::Builder.new(@app) do
+      on_request{|request| request.get? }
+      on_request{|request| request.path_info == '/' }
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/test'))
+    TestMiddleware.last_instance.state.should == :initial
+  end
+
+  it "should stop on_repsonse" do
+    @builder = Meddler::Builder.new(@app) do
+      on_response{|response| response.status == 404 }
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :pre
+  end
+
+  it "should stop on_status" do
+    @builder = Meddler::Builder.new(@app) do
+      on_status 300..500
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :pre
+  end
+
+  it "should stop on_path_info" do
+    @builder = Meddler::Builder.new(@app) do
+      on_path_info '/path'
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :initial
+  end
+
+  it "should stop on_xhr?" do
+    @builder = Meddler::Builder.new(@app) do
+      on_xhr?
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :initial
+  end
+
+  it "should stop multiple on_repsonse" do
+    @builder = Meddler::Builder.new(@app) do
+      on_response{|response| response.status == 200 }
+      on_response{|response| response.length == 10 }
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    TestMiddleware.last_instance.state.should == :pre
+  end
+
+  it "should call before" do
+    before_called = false
+    @builder = Meddler::Builder.new(@app) do
+      before{|response| before_called = true}
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    before_called.should be_true
+  end
+
+  it "should call after" do
+    after_called = false
+    @builder = Meddler::Builder.new(@app) do
+      after{|response| after_called = true}
+      use TestMiddleware
+    end
+    @builder.call(Rack::MockRequest.env_for('/'))
+    after_called.should be_true
+  end
+
+  it "should be able to act as an endpoint" do
+    after_called = false
+    @builder = Meddler::Builder.new(@app) do
+      use TestMiddleware
+      run proc {|env| [200, {'Content-type' => 'text/html', 'Content-length' => '10'}, ['hellohello']]}
+    end
+    response = @builder.call(Rack::MockRequest.env_for('/'))
+    response.last.should == ['hellohello']
+  end
+
+  it "should be able to act as an endpoint (which gets skipped)" do
+    after_called = false
+    @builder = Meddler::Builder.new(@app) do
+      on_status 404
+      use TestMiddleware
+      run proc {|env| [200, {'Content-type' => 'text/html', 'Content-length' => '10'}, ['hellohello']]}
+    end
+    response = @builder.call(Rack::MockRequest.env_for('/'))
+    response.last.should == ['hello']
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: meddler
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Joshua Hull
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-30 00:00:00 -05:00
+date: 2009-12-01 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -55,5 +55,5 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Hey, someone meddled with my middleware!
-test_files: []
-
+test_files: 
+- spec/meddler_spec.rb