Skip to content
This repository
tree: b96ea6fb12
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 541 lines (425 sloc) 15.644 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
# encoding: UTF-8
require 'helper'

module Journey
  class TestRouter < MiniTest::Unit::TestCase
    attr_reader :routes

    def setup
      @routes = Routes.new
      @router = Router.new(@routes, {})
      @formatter = Formatter.new(@routes)
    end

    def test_request_class_reader
      klass = Object.new
      router = Router.new(routes, :request_class => klass)
      assert_equal klass, router.request_class
    end

    class FakeRequestFeeler < Struct.new(:env, :called)
      def new env
        self.env = env
        self
      end

      def hello
        self.called = true
        'world'
      end

      def path_info; env['PATH_INFO']; end
      def request_method; env['REQUEST_METHOD']; end
      def ip; env['REMOTE_ADDR']; end
    end

    def test_dashes
      router = Router.new(routes, {})

      exp = Router::Strexp.new '/foo-bar-baz', {}, ['/.?']
      path = Path::Pattern.new exp

      routes.add_route nil, path, {}, {:id => nil}, {}

      env = rails_env 'PATH_INFO' => '/foo-bar-baz'
      called = false
      router.recognize(env) do |r, _, params|
        called = true
      end
      assert called
    end

    def test_unicode
      router = Router.new(routes, {})

      #match the escaped version of /ほげ
      exp = Router::Strexp.new '/%E3%81%BB%E3%81%92', {}, ['/.?']
      path = Path::Pattern.new exp

      routes.add_route nil, path, {}, {:id => nil}, {}

      env = rails_env 'PATH_INFO' => '/%E3%81%BB%E3%81%92'
      called = false
      router.recognize(env) do |r, _, params|
        called = true
      end
      assert called
    end

    def test_request_class_and_requirements_success
      klass = FakeRequestFeeler.new nil
      router = Router.new(routes, {:request_class => klass })

      requirements = { :hello => /world/ }

      exp = Router::Strexp.new '/foo(/:id)', {}, ['/.?']
      path = Path::Pattern.new exp

      routes.add_route nil, path, requirements, {:id => nil}, {}

      env = rails_env 'PATH_INFO' => '/foo/10'
      router.recognize(env) do |r, _, params|
        assert_equal({:id => '10'}, params)
      end

      assert klass.called, 'hello should have been called'
      assert_equal env.env, klass.env
    end

    def test_request_class_and_requirements_fail
      klass = FakeRequestFeeler.new nil
      router = Router.new(routes, {:request_class => klass })

      requirements = { :hello => /mom/ }

      exp = Router::Strexp.new '/foo(/:id)', {}, ['/.?']
      path = Path::Pattern.new exp

      router.routes.add_route nil, path, requirements, {:id => nil}, {}

      env = rails_env 'PATH_INFO' => '/foo/10'
      router.recognize(env) do |r, _, params|
        flunk 'route should not be found'
      end

      assert klass.called, 'hello should have been called'
      assert_equal env.env, klass.env
    end

    class CustomPathRequest < Router::NullReq
      def path_info
        env['custom.path_info']
      end
    end

    def test_request_class_overrides_path_info
      router = Router.new(routes, {:request_class => CustomPathRequest })

      exp = Router::Strexp.new '/bar', {}, ['/.?']
      path = Path::Pattern.new exp

      routes.add_route nil, path, {}, {}, {}

      env = rails_env 'PATH_INFO' => '/foo', 'custom.path_info' => '/bar'

      recognized = false
      router.recognize(env) do |r, _, params|
        recognized = true
      end

      assert recognized, "route should have been recognized"
    end

    def test_regexp_first_precedence
      add_routes @router, [
        Router::Strexp.new("/whois/:domain", {:domain => /\w+\.[\w\.]+/}, ['/', '.', '?']),
        Router::Strexp.new("/whois/:id(.:format)", {}, ['/', '.', '?'])
      ]

      env = rails_env 'PATH_INFO' => '/whois/example.com'

      list = []
      @router.recognize(env) do |r, _, params|
        list << r
      end
      assert_equal 2, list.length

      r = list.first

      assert_equal '/whois/:domain', r.path.spec.to_s
    end

    def test_required_parts_verified_are_anchored
      add_routes @router, [
        Router::Strexp.new("/foo/:id", { :id => /\d/ }, ['/', '.', '?'], false)
      ]

      assert_raises(Router::RoutingError) do
        @formatter.generate(:path_info, nil, { :id => '10' }, { })
      end
    end

    def test_required_parts_are_verified_when_building
      add_routes @router, [
        Router::Strexp.new("/foo/:id", { :id => /\d+/ }, ['/', '.', '?'], false)
      ]

      path, _ = @formatter.generate(:path_info, nil, { :id => '10' }, { })
      assert_equal '/foo/10', path

      assert_raises(Router::RoutingError) do
        @formatter.generate(:path_info, nil, { :id => 'aa' }, { })
      end
    end

    def test_only_required_parts_are_verified
      add_routes @router, [
        Router::Strexp.new("/foo(/:id)", {:id => /\d/}, ['/', '.', '?'], false)
      ]

      path, _ = @formatter.generate(:path_info, nil, { :id => '10' }, { })
      assert_equal '/foo/10', path

      path, _ = @formatter.generate(:path_info, nil, { }, { })
      assert_equal '/foo', path

      path, _ = @formatter.generate(:path_info, nil, { :id => 'aa' }, { })
      assert_equal '/foo/aa', path
    end

    def test_X_Cascade
      add_routes @router, [ "/messages(.:format)" ]
      resp = @router.call({ 'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/lol' })
      assert_equal ['Not Found'], resp.last
      assert_equal 'pass', resp[1]['X-Cascade']
      assert_equal 404, resp.first
    end

    def test_clear_trailing_slash_from_script_name_on_root_unanchored_routes
      strexp = Router::Strexp.new("/", {}, ['/', '.', '?'], false)
      path = Path::Pattern.new strexp
      app = lambda { |env| [200, {}, ['success!']] }
      route = @router.routes.add_route(app, path, {}, {}, {})

      env = rack_env('SCRIPT_NAME' => '', 'PATH_INFO' => '/weblog')
      resp = @router.call(env)
      assert_equal ['success!'], resp.last
      assert_equal '', env['SCRIPT_NAME']
    end

    def test_defaults_merge_correctly
      path = Path::Pattern.new '/foo(/:id)'
      @router.routes.add_route nil, path, {}, {:id => nil}, {}

      env = rails_env 'PATH_INFO' => '/foo/10'
      @router.recognize(env) do |r, _, params|
        assert_equal({:id => '10'}, params)
      end

      env = rails_env 'PATH_INFO' => '/foo'
      @router.recognize(env) do |r, _, params|
        assert_equal({:id => nil}, params)
      end
    end

    def test_recognize_with_unbound_regexp
      add_routes @router, [
        Router::Strexp.new("/foo", { }, ['/', '.', '?'], false)
      ]

      env = rails_env 'PATH_INFO' => '/foo/bar'

      @router.recognize(env) { |*_| }

      assert_equal '/foo', env.env['SCRIPT_NAME']
      assert_equal '/bar', env.env['PATH_INFO']
    end

    def test_bound_regexp_keeps_path_info
      add_routes @router, [
        Router::Strexp.new("/foo", { }, ['/', '.', '?'], true)
      ]

      env = rails_env 'PATH_INFO' => '/foo'

      before = env.env['SCRIPT_NAME']

      @router.recognize(env) { |*_| }

      assert_equal before, env.env['SCRIPT_NAME']
      assert_equal '/foo', env.env['PATH_INFO']
    end

    def test_path_not_found
      add_routes @router, [
        "/messages(.:format)",
        "/messages/new(.:format)",
        "/messages/:id/edit(.:format)",
        "/messages/:id(.:format)"
      ]
      env = rails_env 'PATH_INFO' => '/messages/1.1.1'
      yielded = false

      @router.recognize(env) do |*whatever|
        yielded = false
      end
      refute yielded
    end

    def test_required_part_in_recall
      add_routes @router, [ "/messages/:a/:b" ]

      path, _ = @formatter.generate(:path_info, nil, { :a => 'a' }, { :b => 'b' })
      assert_equal "/messages/a/b", path
    end

    def test_splat_in_recall
      add_routes @router, [ "/*path" ]

      path, _ = @formatter.generate(:path_info, nil, { }, { :path => 'b' })
      assert_equal "/b", path
    end

    def test_recall_should_be_used_when_scoring
      add_routes @router, [
        "/messages/:action(/:id(.:format))",
        "/messages/:id(.:format)"
      ]

      path, _ = @formatter.generate(:path_info, nil, { :id => 10 }, { :action => 'index' })
      assert_equal "/messages/index/10", path
    end

    def test_nil_path_parts_are_ignored
      path = Path::Pattern.new "/:controller(/:action(.:format))"
      @router.routes.add_route nil, path, {}, {}, {}

      params = { :controller => "tasks", :format => nil }
      extras = { :action => 'lol' }

      path, _ = @formatter.generate(:path_info, nil, params, extras)
      assert_equal '/tasks', path
    end

    def test_generate_slash
      path = Path::Pattern.new '/'
      @router.routes.add_route nil, path, {}, {}, {}

      params = [ [:controller, "tasks"],
                 [:action, "show"] ]

      path, _ = @formatter.generate(:path_info, nil, Hash[params], {})
      assert_equal '/', path
    end

    def test_generate_calls_param_proc
      path = Path::Pattern.new '/:controller(/:action)'
      @router.routes.add_route nil, path, {}, {}, {}

      parameterized = []
      params = [ [:controller, "tasks"],
                 [:action, "show"] ]

      @formatter.generate(
        :path_info,
        nil,
        Hash[params],
        {},
        lambda { |k,v| parameterized << [k,v]; v })

      assert_equal params.map(&:to_s).sort, parameterized.map(&:to_s).sort
    end

    def test_generate_id
      path = Path::Pattern.new '/:controller(/:action)'
      @router.routes.add_route nil, path, {}, {}, {}

      path, params = @formatter.generate(
        :path_info, nil, {:id=>1, :controller=>"tasks", :action=>"show"}, {})
      assert_equal '/tasks/show', path
      assert_equal({:id => 1}, params)
    end

    def test_generate_escapes
      path = Path::Pattern.new '/:controller(/:action)'
      @router.routes.add_route nil, path, {}, {}, {}

      path, _ = @formatter.generate(:path_info,
        nil, { :controller => "tasks",
               :action => "a/b c+d",
      }, {})
      assert_equal '/tasks/a/b%20c+d', path
    end

    def test_generate_extra_params
      path = Path::Pattern.new '/:controller(/:action)'
      @router.routes.add_route nil, path, {}, {}, {}

      path, params = @formatter.generate(:path_info,
        nil, { :id => 1,
               :controller => "tasks",
               :action => "show",
               :relative_url_root => nil
      }, {})
      assert_equal '/tasks/show', path
      assert_equal({:id => 1, :relative_url_root => nil}, params)
    end

    def test_generate_uses_recall_if_needed
      path = Path::Pattern.new '/:controller(/:action(/:id))'
      @router.routes.add_route nil, path, {}, {}, {}

      path, params = @formatter.generate(:path_info,
        nil,
        {:controller =>"tasks", :id => 10},
        {:action =>"index"})
      assert_equal '/tasks/index/10', path
      assert_equal({}, params)
    end

    def test_generate_with_name
      path = Path::Pattern.new '/:controller(/:action)'
      @router.routes.add_route nil, path, {}, {}, {}

      path, params = @formatter.generate(:path_info,
        "tasks",
        {:controller=>"tasks"},
        {:controller=>"tasks", :action=>"index"})
      assert_equal '/tasks', path
      assert_equal({}, params)
    end

    {
      '/content' => { :controller => 'content' },
      '/content/list' => { :controller => 'content', :action => 'list' },
      '/content/show/10' => { :controller => 'content', :action => 'show', :id => "10" },
    }.each do |request_path, expected|
      define_method("test_recognize_#{expected.keys.map(&:to_s).join('_')}") do
        path = Path::Pattern.new "/:controller(/:action(/:id))"
        app = Object.new
        route = @router.routes.add_route(app, path, {}, {}, {})

        env = rails_env 'PATH_INFO' => request_path
        called = false

        @router.recognize(env) do |r, _, params|
          assert_equal route, r
          assert_equal(expected, params)
          called = true
        end

        assert called
      end
    end

    {
      :segment => ['/a%2Fb%20c+d/splat', { :segment => 'a/b c+d', :splat => 'splat' }],
      :splat => ['/segment/a/b%20c+d', { :segment => 'segment', :splat => 'a/b c+d' }]
    }.each do |name, (request_path, expected)|
      define_method("test_recognize_#{name}") do
        path = Path::Pattern.new '/:segment/*splat'
        app = Object.new
        route = @router.routes.add_route(app, path, {}, {}, {})

        env = rails_env 'PATH_INFO' => request_path
        called = false

        @router.recognize(env) do |r, _, params|
          assert_equal route, r
          assert_equal(expected, params)
          called = true
        end

        assert called
      end
    end

    def test_namespaced_controller
      strexp = Router::Strexp.new(
        "/:controller(/:action(/:id))",
        { :controller => /.+?/ },
        ["/", ".", "?"]
      )
      path = Path::Pattern.new strexp
      app = Object.new
      route = @router.routes.add_route(app, path, {}, {}, {})

      env = rails_env 'PATH_INFO' => '/admin/users/show/10'
      called = false
      expected = {
        :controller => 'admin/users',
        :action => 'show',
        :id => '10'
      }

      @router.recognize(env) do |r, _, params|
        assert_equal route, r
        assert_equal(expected, params)
        called = true
      end
      assert called
    end

    def test_recognize_literal
      path = Path::Pattern.new "/books(/:action(.:format))"
      app = Object.new
      route = @router.routes.add_route(app, path, {}, {:controller => 'books'})

      env = rails_env 'PATH_INFO' => '/books/list.rss'
      expected = { :controller => 'books', :action => 'list', :format => 'rss' }
      called = false
      @router.recognize(env) do |r, _, params|
        assert_equal route, r
        assert_equal(expected, params)
        called = true
      end

      assert called
    end

    def test_recognize_cares_about_verbs
      path = Path::Pattern.new "/books(/:action(.:format))"
      app = Object.new
      conditions = {
        :request_method => 'GET'
      }
      @router.routes.add_route(app, path, conditions, {})

      conditions = conditions.dup
      conditions[:request_method] = 'POST'

      post = @router.routes.add_route(app, path, conditions, {})

      env = rails_env 'PATH_INFO' => '/books/list.rss',
                      "REQUEST_METHOD" => "POST"

      called = false
      @router.recognize(env) do |r, _, params|
        assert_equal post, r
        called = true
      end

      assert called
    end

    private

    def add_routes router, paths
      paths.each do |path|
        path = Path::Pattern.new path
        router.routes.add_route nil, path, {}, {}, {}
      end
    end

    RailsEnv = Struct.new(:env)

    def rails_env env
      RailsEnv.new rack_env env
    end

    def rack_env env
      {
        "rack.version" => [1, 1],
        "rack.input" => StringIO.new,
        "rack.errors" => StringIO.new,
        "rack.multithread" => true,
        "rack.multiprocess" => true,
        "rack.run_once" => false,
        "REQUEST_METHOD" => "GET",
        "SERVER_NAME" => "example.org",
        "SERVER_PORT" => "80",
        "QUERY_STRING" => "",
        "PATH_INFO" => "/content",
        "rack.url_scheme" => "http",
        "HTTPS" => "off",
        "SCRIPT_NAME" => "",
        "CONTENT_LENGTH" => "0"
      }.merge env
    end
  end
end
Something went wrong with that request. Please try again.