roda 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 992b12eaa4153e29ad448ac21c6afafe12f9a89a
-  data.tar.gz: 3ce43ca69c2faeb4a335968959365f33309460ed
+SHA256:
+  metadata.gz: fc5d44e8586188ebb590d75d204b22fdd5b547c35e8631d31cf184ef5bfc0908
+  data.tar.gz: 03f023b11296d7cdebe72229d47988f3cf644ef3e80f243030e3b678c0ee9cb3
 SHA512:
-  metadata.gz: af0baab222fcd78a7b49e5d8d2e204139ab7b1ec25cf75d001c2715777d31effa1527dda7ecfe9e1f18082978f77ad419d5c0b020667c6265d9273038d441483
-  data.tar.gz: 4b7da58d7c976ed77f7da407090c14f38f912ac0dbead739cc676a16b10665d09866a95f739c852139919a260805e839a80ea0c9797a3da8413aaef632109046
+  metadata.gz: 942fb33ceeb0faef69467fa5b705bfd8b73f92bfb27557f58c9d459a9c1f1d4447eec1ac10c5cbf4eacf09293f20a4562e997125a41a226c5fb673154b85524d
+  data.tar.gz: e5d5f9533bed9c0c126a1203a9715bda8461b587bfb647a70a8aae1dd0a951cb5512d189c2e205ccbc1d67086afaa4e2a8c7104c741824c0ab3f8003fe999a98

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 3.4.0 (2018-01-12)
+
+* Add middleware_stack plugin for removing middleware and inserting middleware before the end of the stack (jeremyevans)
+
+* Make head plugin handle closing existing response bodies if the body responds to close (Eric Wong)
+
 = 3.3.0 (2017-12-14)
 
 * Add typecast_params plugin for converting param values to explicit types (jeremyevans)

data/doc/release_notes/3.4.0.txt

@@ -0,0 +1,24 @@
+= New Features
+
+* A middleware_stack plugin has been added for more detailed control
+  over middleware, allowing for the removal of middleware and the
+  insertion of middleware before existing middleware.  Example:
+
+    plugin :middleware_stack
+
+    # Remove csrf middleware
+    middleware_stack.remove{|m, *args| m == Rack::Csrf}
+
+    # Insert csrf middleware before logger middleware
+    middleware_stack.before{|m, *args| m == Rack::CommonLogger}.
+      use(Rack::Csrf, raise: true)
+
+    # Insert csrf middleware after logger middleware
+    middleware_stack.after{|m, *args| m == Rack::CommonLogger}.
+      use(Rack::Csrf, raise: true)
+
+= Other Improvements
+
+* The head plugin now calls close on the response body if the body
+  responds to close.  Previously an existing response body was
+  just ignored.

data/lib/roda/plugins/assets.rb

@@ -564,7 +564,9 @@ class Roda
           begin
             require 'uglifier'
           rescue => e
+            # :nocov:
             raise CompressorNotFound, "#{e.class}: #{e.message}", e.backtrace
+            # :nocov:
           end
 
           Uglifier.compile(content)

data/lib/roda/plugins/head.rb

@@ -37,13 +37,36 @@ class Roda
     # this plugin those HEAD requests will return a 404 status, which
     # may prevent search engines from crawling your website.
     module Head
+
+      # used to ensure proper resource release on HEAD requests
+      # we do not respond to a to_path method, here.
+      class CloseLater
+        def initialize(body)
+          @body = body
+        end
+
+        # yield nothing
+        def each
+        end
+
+        # this should be called by the Rack server
+        def close
+          @body.close
+        end
+      end
+
       module InstanceMethods
         # Always use an empty response body for head requests, with a
         # content length of 0.
         def call(*)
           res = super
           if @_request.head?
-            res[2] = EMPTY_ARRAY
+            body = res[2]
+            if body.respond_to?(:close)
+              res[2] = CloseLater.new(body)
+            else
+              res[2] = EMPTY_ARRAY
+            end
           end
           res
         end

data/lib/roda/plugins/middleware_stack.rb

@@ -0,0 +1,101 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The middleware_stack plugin adds methods to remove middleware
+    # from the middleware stack, and insert new middleware at specific
+    # positions in the middleware stack.
+    #
+    #   plugin :middleware_stack
+    #
+    #   # Remove csrf middleware
+    #   middleware_stack.remove{|m, *args| m == Rack::Csrf}
+    #
+    #   # Insert csrf middleware
+    #   middleware_stack.before{|m, *args| m == Rack::CommonLogger}.use(Rack::Csrf, raise: true)
+    #   middleware_stack.after{|m, *args| m == Rack::CommonLogger}.use(Rack::Csrf, raise: true)
+    module MiddlewareStack
+      # Represents a specific position in the application's middleware stack where new
+      # middleware can be inserted.
+      class StackPosition
+        def initialize(app, middleware, position)
+          @app = app
+          @middleware = middleware
+          @position = position
+        end
+
+        # Insert a new middleware into the current position in the middleware stack.
+        # Increments the position so that calling this multiple times adds later
+        # middleware after earlier middleware, similar to how +Roda.use+ works.
+        def use(*args, &block)
+          @middleware.insert(@position, [args, block])
+          @app.send(:build_rack_app)
+          @position += 1
+          nil
+        end
+      end
+
+      # Represents the applications middleware as a stack, allowing for easily
+      # removing middleware or finding places to insert new middleware.
+      class Stack
+        def initialize(app, middleware)
+          @app = app
+          @middleware = middleware
+        end
+
+        # Return a StackPosition representing the position after the middleware where
+        # the block returns true. Yields the middleware and any middleware arguments
+        # given, but not the middleware block.
+        # It the block never returns true, returns a StackPosition that will insert
+        # new middleware at the end of the stack.
+        def after(&block)
+          handle(1, &block)
+        end
+
+        # Return a StackPosition representing the position before the middleware where
+        # the block returns true. Yields the middleware and any middleware arguments
+        # given, but not the middleware block.
+        # It the block never returns true, returns a StackPosition that will insert
+        # new middleware at the end of the stack.
+        def before(&block)
+          handle(0, &block)
+        end
+
+        # Removes any middleware where the block returns true. Yields the middleware
+        # and any middleware arguments given, but not the middleware block
+        def remove
+          @middleware.delete_if do |m, _|
+            yield(*m)
+          end
+          @app.send(:build_rack_app)
+          nil
+        end
+
+        private
+
+        # Internals of before and after.
+        def handle(offset)
+          @middleware.each_with_index do |(m, _), i|
+            if yield(*m)
+              return StackPosition.new(@app, @middleware, i+offset)
+            end
+          end
+
+          StackPosition.new(@app, @middleware, @middleware.length)
+        end
+      end
+
+      module ClassMethods
+        # Return a new Stack that allows removing middleware and inserting
+        # middleware at specific places in the stack.
+        def middleware_stack
+          Stack.new(self, @middleware)
+        end
+      end
+    end
+
+    register_plugin(:middleware_stack, MiddlewareStack)
+  end
+end
+

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 3
+  RodaMinorVersion = 4
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/head_spec.rb

@@ -32,4 +32,21 @@ describe "head plugin" do
     body('/b').must_equal 'b'
     status('/b', 'REQUEST_METHOD' => 'HEAD').must_equal 200
   end
+
+  it "releases resources via body.close" do
+    body = StringIO.new('hi')
+    app(:head) do |r|
+      r.root do
+        r.halt [ 200, {}, body ]
+      end
+    end
+    s, h, b = req('REQUEST_METHOD' => 'HEAD')
+    s.must_equal 200
+    res = String.new
+    body.closed?.must_equal false
+    b.each { |buf| res << buf }
+    b.close
+    body.closed?.must_equal true
+    res.must_equal ''
+  end
 end

data/spec/plugin/middleware_stack_spec.rb

@@ -0,0 +1,81 @@
+require_relative "../spec_helper"
+
+describe "middleware_stack plugin" do 
+  it "adds middleware_stack method for removing and inserting into middleware stack" do
+    make_middleware = lambda do |name|
+      Class.new do
+        define_singleton_method(:name){name}
+
+        attr_reader :app
+        attr_reader :args
+        attr_reader :block
+        def initialize(app, *args, &block)
+          @app = app
+          @args = args
+          @block = block
+        end
+
+        def call(env)
+          (env[:record] ||= []) << [self.class.name, args, block]
+          app.call(env)
+        end
+      end
+    end
+
+    recorded = nil
+
+    app(:middleware_stack) do |r|
+      recorded = env[:record]
+      nil 
+    end
+
+    status.must_equal 404
+    recorded.must_be_nil
+
+    called = false
+    app.middleware_stack.before{called = true}.use(make_middleware[:m1], :a1).must_be_nil
+    called.must_equal false
+
+    status.must_equal 404
+    recorded.must_equal [[:m1, [:a1], nil]]
+
+    app.middleware_stack.before{|m, *a| m.name == :m1}.use(make_middleware[:m2]).must_be_nil
+
+    status.must_equal 404
+    recorded.must_equal [[:m2, [], nil], [:m1, [:a1], nil]]
+
+    b = lambda{}
+    app.middleware_stack.before{|m, *a| m.name == :m1}.use(make_middleware[:m3], :a2, :a3, &b).must_be_nil
+
+    status.must_equal 404
+    recorded.must_equal [[:m2, [], nil], [:m3, [:a2, :a3], b], [:m1, [:a1], nil]]
+
+    app.middleware_stack.after{|m, *a| m.name == :m4}.use(make_middleware[:m4]).must_be_nil
+    status.must_equal 404
+    recorded.must_equal [[:m2, [], nil], [:m3, [:a2, :a3], b], [:m1, [:a1], nil], [:m4, [], nil]]
+
+    app.middleware_stack.after{|m, *a| m.name == :m4}.use(make_middleware[:m5]).must_be_nil
+    status.must_equal 404
+    recorded.must_equal [[:m2, [], nil], [:m3, [:a2, :a3], b], [:m1, [:a1], nil], [:m4, [], nil], [:m5, [], nil]]
+
+    app.middleware_stack.after{|m, *a| a == [:a1]}.use(make_middleware[:m6]).must_be_nil
+    status.must_equal 404
+    recorded.must_equal [[:m2, [], nil], [:m3, [:a2, :a3], b], [:m1, [:a1], nil], [:m6, [], nil], [:m4, [], nil], [:m5, [], nil]]
+
+    app.middleware_stack.remove{|m, *a| a.empty?}.must_be_nil
+    status.must_equal 404
+    recorded.must_equal [[:m3, [:a2, :a3], b], [:m1, [:a1], nil]]
+
+    sp = app.middleware_stack.after{|m, *a| m.name == :m3}
+    sp.use(make_middleware[:m7])
+    sp.use(make_middleware[:m8])
+    status.must_equal 404
+    recorded.must_equal [[:m3, [:a2, :a3], b], [:m7, [], nil], [:m8, [], nil], [:m1, [:a1], nil]]
+
+    sp = app.middleware_stack.before{|m, *a| m.name == :m8}
+    sp.use(make_middleware[:m9])
+    sp.use(make_middleware[:m10])
+    status.must_equal 404
+    recorded.must_equal [[:m3, [:a2, :a3], b], [:m7, [], nil], [:m9, [], nil], [:m10, [], nil], [:m8, [], nil], [:m1, [:a1], nil]]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-14 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -199,6 +199,7 @@ extra_rdoc_files:
 - doc/release_notes/3.1.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
+- doc/release_notes/3.4.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -244,6 +245,7 @@ files:
 - doc/release_notes/3.1.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
+- doc/release_notes/3.4.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
 - lib/roda/plugins/all_verbs.rb
@@ -284,6 +286,7 @@ files:
 - lib/roda/plugins/mailer.rb
 - lib/roda/plugins/match_affix.rb
 - lib/roda/plugins/middleware.rb
+- lib/roda/plugins/middleware_stack.rb
 - lib/roda/plugins/module_include.rb
 - lib/roda/plugins/multi_route.rb
 - lib/roda/plugins/multi_run.rb
@@ -377,6 +380,7 @@ files:
 - spec/plugin/mailer_spec.rb
 - spec/plugin/match_affix_spec.rb
 - spec/plugin/middleware_spec.rb
+- spec/plugin/middleware_stack_spec.rb
 - spec/plugin/module_include_spec.rb
 - spec/plugin/multi_route_spec.rb
 - spec/plugin/multi_run_spec.rb
@@ -463,7 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit