deas 0.43.3 → 0.43.4

data/lib/deas/url.rb

@@ -28,7 +28,7 @@ module Deas
 
       # ignore captures when setting params
       # remove duplicate forward slashes
-      set_anchor(set_extra(set_named(set_splat(@path, s), h), h), a).gsub(/\/\/+/, '/')
+      set_anchor(set_extra(set_named(set_splat(@path, s), h).gsub(/\/\/+/, '/'), h), a)
     end
 
     private

data/lib/deas/version.rb

@@ -1,3 +1,3 @@
 module Deas
-  VERSION = "0.43.3"
+  VERSION = "0.43.4"
 end

data/lib/deas/view_handler.rb

@@ -73,6 +73,7 @@ module Deas
       def headers(*args);      @deas_runner.headers(*args);      end
       def body(*args);         @deas_runner.body(*args);         end
       def content_type(*args); @deas_runner.content_type(*args); end
+      def set_cookie(*args);   @deas_runner.set_cookie(*args);   end
       def halt(*args);         @deas_runner.halt(*args);         end
       def redirect(*args);     @deas_runner.redirect(*args);     end
       def send_file(*args);    @deas_runner.send_file(*args);    end

data/test/support/factory.rb

@@ -41,8 +41,8 @@ module Factory
     Deas::RequestData.new({
       :request    => args[:request]    || Factory.request,
       :response   => args[:response]   || Factory.response,
-      :params     => args[:params]     || { Factory.string => Factory.string },
-      :route_path => args[:route_path] || Factory.string
+      :route_path => args[:route_path] || Factory.string,
+      :params     => args[:params]     || { Factory.string => Factory.string }
     })
   end
 

data/test/support/fake_sinatra_call.rb

@@ -22,9 +22,7 @@ class FakeSinatraCall
     @status       = 200
     @headers      = {}
 
-    @settings = OpenStruct.new({
-      :deas_server_data => Factory.server_data
-    }.merge(settings || {}))
+    @settings = OpenStruct.new(settings || {})
   end
 
   def call(env)

data/test/support/routes.rb

@@ -69,6 +69,40 @@ class DeasDevServer
 
 end
 
+class RemoveTrailingSlashesServer
+  include Deas::Server
+
+  root            TEST_SUPPORT_ROOT
+  logger          TEST_LOGGER
+  verbose_logging true
+  show_exceptions true
+
+  router do
+    remove_trailing_slashes
+
+    get '/show', 'ShowHandler'
+  end
+
+end
+
+class AllowTrailingSlashesServer
+  include Deas::Server
+
+  root            TEST_SUPPORT_ROOT
+  logger          TEST_LOGGER
+  verbose_logging true
+  show_exceptions true
+
+  router do
+    allow_trailing_slashes
+
+    get '/show',       'ShowHandler'
+    get '/show-text/', 'ShowTextHandler'
+
+  end
+
+end
+
 class ShowHandler
   include Deas::ViewHandler
 

data/test/system/deas_tests.rb

@@ -152,7 +152,7 @@ module Deas
 
       assert_equal 404, last_response.status
       assert_equal "text/plain", last_response.headers['Content-Type']
-      assert_match "Deas::NotFound: /not_defined", last_response.body
+      assert_match "Deas::NotFound: GET /not_defined", last_response.body
     end
 
     should "return a text/plain body when an exception occurs" do
@@ -165,4 +165,45 @@ module Deas
 
   end
 
+  class RemoveTrailingSlashesTests < RackTestsContext
+    desc "a Deas server rack app with a router that requires no trailing slashes"
+    setup do
+      @app = RemoveTrailingSlashesServer.new
+    end
+
+    should "redirect any paths that end in a slash" do
+      get '/show/'
+
+      assert_equal 302,      last_response.status
+      assert_equal '/show', last_response.headers['Location']
+    end
+
+  end
+
+  class AllowTrailingSlashesTests < RackTestsContext
+    desc "a Deas server rack app with a router that allows trailing slashes"
+    setup do
+      @app = AllowTrailingSlashesServer.new
+    end
+
+    should "serve any found paths regardless of whether they end with a slash" do
+      get '/show'
+      assert_equal 200, last_response.status
+      assert_equal 'text/html;charset=utf-8', last_response.headers['Content-Type']
+
+      get '/show/'
+      assert_equal 200, last_response.status
+      assert_equal 'text/html;charset=utf-8', last_response.headers['Content-Type']
+
+      get '/show-text'
+      assert_equal 200, last_response.status
+      assert_equal 'text/plain', last_response.headers['Content-Type']
+
+      get '/show-text/'
+      assert_equal 200, last_response.status
+      assert_equal 'text/plain', last_response.headers['Content-Type']
+    end
+
+  end
+
 end

data/test/unit/error_handler_tests.rb

@@ -12,21 +12,21 @@ class Deas::ErrorHandler
       @server_data      = Factory.server_data(:error_procs => @error_proc_spies)
       @request          = Factory.string
       @response         = Factory.string
+      @route_path       = Factory.string
       @handler_class    = Factory.string
       @handler          = Factory.string
       @params           = Factory.string
       @splat            = Factory.string
-      @route_path       = Factory.string
 
       @context_hash = {
         :server_data   => @server_data,
         :request       => @request,
         :response      => @response,
+        :route_path    => @route_path,
         :handler_class => @handler_class,
         :handler       => @handler,
         :params        => @params,
-        :splat         => @splat,
-        :route_path    => @route_path
+        :splat         => @splat
       }
 
       @error_handler_class = Deas::ErrorHandler
@@ -117,18 +117,18 @@ class Deas::ErrorHandler
     subject{ @context }
 
     should have_readers :server_data
-    should have_readers :request, :response, :handler_class, :handler
-    should have_readers :params, :splat, :route_path
+    should have_readers :request, :response
+    should have_readers :route_path, :handler_class, :handler, :params, :splat
 
     should "know its attributes" do
       assert_equal @context_hash[:server_data],   subject.server_data
       assert_equal @context_hash[:request],       subject.request
       assert_equal @context_hash[:response],      subject.response
+      assert_equal @context_hash[:route_path],    subject.route_path
       assert_equal @context_hash[:handler_class], subject.handler_class
       assert_equal @context_hash[:handler],       subject.handler
       assert_equal @context_hash[:params],        subject.params
       assert_equal @context_hash[:splat],         subject.splat
-      assert_equal @context_hash[:route_path],    subject.route_path
     end
 
     should "know if it equals another context" do
@@ -139,11 +139,11 @@ class Deas::ErrorHandler
         :server_data   => Factory.server_data,
         :request       => Factory.string,
         :response      => Factory.string,
+        :route_path    => Factory.string,
         :handler_class => Factory.string,
         :handler       => Factory.string,
         :params        => Factory.string,
         :splat         => Factory.string,
-        :route_path    => Factory.string
       })
       assert_not_equal exp, subject
     end

data/test/unit/handler_proxy_tests.rb

@@ -62,8 +62,8 @@ class Deas::HandlerProxy
         :router          => @server_data.router,
         :template_source => @server_data.template_source,
         :request         => @request_data.request,
-        :params          => @request_data.params,
-        :route_path      => @request_data.route_path
+        :route_path      => @request_data.route_path,
+        :params          => @request_data.params
       }
       assert_equal exp_args, @runner_spy.args
 
@@ -71,6 +71,9 @@ class Deas::HandlerProxy
     end
 
     should "add data to the request env to make it available to Rack" do
+      exp = @runner_spy.route_path
+      assert_equal exp, @request_data.request.env['deas.route_path']
+
       exp = subject.handler_class
       assert_equal exp, @request_data.request.env['deas.handler_class']
 
@@ -82,17 +85,14 @@ class Deas::HandlerProxy
 
       exp = @runner_spy.splat
       assert_equal exp, @request_data.request.env['deas.splat']
-
-      exp = @runner_spy.route_path
-      assert_equal exp, @request_data.request.env['deas.route_path']
     end
 
     should "log the handler class name and the params" do
       exp_msgs = [
+        "  Route:   #{@runner_spy.route_path.inspect}",
         "  Handler: #{subject.handler_class.name}",
         "  Params:  #{@runner_spy.params.inspect}",
-        "  Splat:   #{@runner_spy.splat.inspect}",
-        "  Route:   #{@runner_spy.route_path.inspect}"
+        "  Splat:   #{@runner_spy.splat.inspect}"
       ]
       assert_equal exp_msgs, @request_data.request.logging_msgs
     end

data/test/unit/logging_tests.rb

@@ -7,11 +7,11 @@ module Deas::Logging
     desc "Deas::Logging"
     subject{ Deas::Logging }
 
-    should have_imeths :middleware_args
+    should have_imeths :middleware_type
 
     should "return middleware args given a verbose flag" do
-      assert_equal [Deas::VerboseLogging], subject.middleware_args(true)
-      assert_equal [Deas::SummaryLogging], subject.middleware_args(false)
+      assert_equal Deas::VerboseLogging, subject.middleware_type(true)
+      assert_equal Deas::SummaryLogging, subject.middleware_type(false)
     end
 
   end
@@ -19,9 +19,7 @@ module Deas::Logging
   class CallSetupTests < UnitTests
     setup do
       @logger = SpyLogger.new
-      @app = Factory.sinatra_call({
-        :deas_server_data => Factory.server_data(:logger => @logger)
-      })
+      @app    = Factory.sinatra_call
 
       @app_call_env = nil
       @resp_status  = Factory.integer
@@ -60,7 +58,7 @@ module Deas::Logging
         @benchmark
       end
 
-      @middleware = @middleware_class.new(@app)
+      @middleware = @middleware_class.new(@app, @logger)
     end
     subject{ @middleware }
 
@@ -131,7 +129,7 @@ module Deas::Logging
       @resp_status = @middleware_class::RESPONSE_STATUS_NAMES.keys.sample
       @app_response[0] = @resp_status
 
-      @middleware = Deas::VerboseLogging.new(@app)
+      @middleware = Deas::VerboseLogging.new(@app, @logger)
     end
     subject{ @middleware }
 
@@ -213,7 +211,7 @@ module Deas::Logging
         'deas.handler_class' => @handler_class
       })
 
-      @middleware = Deas::SummaryLogging.new(@app)
+      @middleware = Deas::SummaryLogging.new(@app, @logger)
     end
     subject{ @middleware }
 

data/test/unit/request_data_tests.rb

@@ -8,25 +8,25 @@ class Deas::RequestData
     setup do
       @request    = Factory.string
       @response   = Factory.string
-      @params     = Factory.string
       @route_path = Factory.string
+      @params     = Factory.string
 
       @request_data = Deas::RequestData.new({
         :request    => @request,
         :response   => @response,
-        :params     => @params,
-        :route_path => @route_path
+        :route_path => @route_path,
+        :params     => @params
       })
     end
     subject{ @request_data }
 
-    should have_readers :request, :response, :params, :route_path
+    should have_readers :request, :response, :route_path, :params
 
     should "know its attributes" do
       assert_equal @request,    subject.request
       assert_equal @response,   subject.response
-      assert_equal @params,     subject.params
       assert_equal @route_path, subject.route_path
+      assert_equal @params,     subject.params
     end
 
     should "default its attributes when they aren't provided" do
@@ -34,16 +34,16 @@ class Deas::RequestData
 
       assert_nil request_data.request
       assert_nil request_data.response
-      assert_nil request_data.params
       assert_nil request_data.route_path
+      assert_nil request_data.params
     end
 
     should "know if it is equal to another request data" do
       request_data = Deas::RequestData.new({
         :request    => @request,
         :response   => @response,
-        :params     => @params,
-        :route_path => @route_path
+        :route_path => @route_path,
+        :params     => @params
       })
       assert_equal request_data, subject
 

data/test/unit/router_tests.rb

@@ -19,6 +19,12 @@ class Deas::Router
       assert_equal 'default', subject::DEFAULT_REQUEST_TYPE_NAME
     end
 
+    should "know its trailing slashes constants" do
+      assert_equal 'remove', subject::REMOVE_TRAILING_SLASHES
+      assert_equal 'allow',  subject::ALLOW_TRAILING_SLASHES
+      assert_equal '/',      subject::SLASH
+    end
+
   end
 
   class InitTests < UnitTests
@@ -32,9 +38,13 @@ class Deas::Router
     subject{ @router }
 
     should have_readers :request_types, :urls, :routes, :definitions
-    should have_readers :escape_query_value_proc
+    should have_readers :trailing_slashes, :escape_query_value_proc
 
-    should have_imeths :view_handler_ns, :escape_query_value
+    should have_imeths :view_handler_ns
+    should have_imeths :allow_trailing_slashes, :allow_trailing_slashes_set?
+    should have_imeths :remove_trailing_slashes, :remove_trailing_slashes_set?
+    should have_imeths :trailing_slashes_set?
+    should have_imeths :escape_query_value
     should have_imeths :base_url, :set_base_url, :prepend_base_url
     should have_imeths :url, :url_for
     should have_imeths :default_request_type_name, :add_request_type
@@ -42,10 +52,12 @@ class Deas::Router
     should have_imeths :get, :post, :put, :patch, :delete
     should have_imeths :route, :redirect, :not_found
     should have_imeths :apply_definitions!, :validate!
+    should have_imeths :validate_trailing_slashes!
 
     should "default its attrs" do
       router = @router_class.new
       assert_nil router.view_handler_ns
+      assert_nil router.trailing_slashes
       assert_nil router.base_url
       assert_empty router.request_types
       assert_empty router.urls
@@ -74,6 +86,26 @@ class Deas::Router
       assert_equal exp, subject.view_handler_ns
     end
 
+    should "config trailing slash handling" do
+      assert_false subject.allow_trailing_slashes_set?
+      assert_false subject.remove_trailing_slashes_set?
+      assert_false subject.trailing_slashes_set?
+
+      subject.allow_trailing_slashes
+
+      assert_equal subject.class::ALLOW_TRAILING_SLASHES, subject.trailing_slashes
+      assert_true  subject.allow_trailing_slashes_set?
+      assert_false subject.remove_trailing_slashes_set?
+      assert_true  subject.trailing_slashes_set?
+
+      subject.remove_trailing_slashes
+
+      assert_equal subject.class::REMOVE_TRAILING_SLASHES, subject.trailing_slashes
+      assert_false subject.allow_trailing_slashes_set?
+      assert_true  subject.remove_trailing_slashes_set?
+      assert_true  subject.trailing_slashes_set?
+    end
+
     should "allow configuring a custom escape query value proc" do
       escape_proc = proc{ Factory.string }
       subject.escape_query_value(&escape_proc)
@@ -158,21 +190,91 @@ class Deas::Router
       assert_equal path1, nf.path
     end
 
+    should "validate trailing slashes" do
+      router = @router_class.new
+      router.get('/something',  'EmptyViewHandler')
+      router.get('/something/', 'EmptyViewHandler')
+      router.apply_definitions!
+
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.allow_trailing_slashes
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.remove_trailing_slashes
+      err = assert_raises(TrailingSlashesError) do
+        router.validate_trailing_slashes!
+      end
+      exp = "all route paths must *not* end with a \"/\", but these do:\n/something/"
+      assert_includes exp, err.message
+
+      router = @router_class.new
+      router.get('/something/',      'EmptyViewHandler')
+      router.get('/something-else/', 'EmptyViewHandler')
+      router.apply_definitions!
+
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.allow_trailing_slashes
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.remove_trailing_slashes
+      err = assert_raises(TrailingSlashesError) do
+        router.validate_trailing_slashes!
+      end
+      exp = "all route paths must *not* end with a \"/\", but these do:\n"\
+            "/something/\n/something-else/"
+      assert_includes exp, err.message
+
+      router = @router_class.new
+      router.get('/something',      'EmptyViewHandler')
+      router.get('/something-else', 'EmptyViewHandler')
+      router.apply_definitions!
+
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.allow_trailing_slashes
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+
+      router.remove_trailing_slashes
+      assert_nothing_raised do
+        router.validate_trailing_slashes!
+      end
+    end
+
     should "apply definitions and validate each route when validating" do
       subject.get('/something', 'EmptyViewHandler')
       subject.apply_definitions!
+      subject.validate_trailing_slashes!
       route = subject.routes.last
       proxy = route.handler_proxies[subject.default_request_type_name]
 
       apply_def_called = false
       Assert.stub(subject, :apply_definitions!){ apply_def_called = true }
 
+      val_trailing_called = false
+      Assert.stub(subject, :validate_trailing_slashes!){ val_trailing_called = true }
+
       assert_false apply_def_called
+      assert_false val_trailing_called
       assert_nil proxy.handler_class
 
       subject.validate!
 
       assert_true apply_def_called
+      assert_true val_trailing_called
       assert_equal EmptyViewHandler, proxy.handler_class
     end