lotus-router 0.0.0 → 0.1.0

data/test/integration/client_error_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+describe Lotus::Router do
+  before do
+    @router = Lotus::Router.new { get '/', to: ->(env) {} }
+    @app    = Rack::MockRequest.new(@router)
+  end
+
+  it 'returns 404 for unknown path' do
+    @app.get('/unknown').status.must_equal 404
+  end
+
+  it 'returns 405 for unacceptable HTTP method' do
+    @app.post('/').status.must_equal 405
+  end
+end

data/test/integration/pass_on_response_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe 'Pass on response' do
+  before do
+    @routes = Lotus::Router.new { get '/', to: ->(env) { Rack::Response.new } }
+    @app    = Rack::MockRequest.new(@routes)
+  end
+
+  it 'is successful' do
+    response = @app.get('/')
+    response.status.must_equal 200
+  end
+end

data/test/named_routes_test.rb

@@ -0,0 +1,123 @@
+describe Lotus::Router do
+  before do
+    @router = Lotus::Router.new(scheme: 'https', host: 'test.com', port: 443)
+
+    @router.get('/lotus',                  to: endpoint, as: :fixed)
+    @router.get('/flowers/:id',            to: endpoint, as: :variables)
+    @router.get('/books/:id',   id: /\d+/, to: endpoint, as: :constraints)
+    @router.get('/articles(.:format)',     to: endpoint, as: :optional)
+    @router.get('/files/*',                to: endpoint, as: :glob)
+  end
+
+  after do
+    @router.reset!
+  end
+
+  let(:endpoint) { ->(env) { [200, {}, ['Hi!']] } }
+
+  describe '#path' do
+    it 'recognizes fixed string' do
+      @router.path(:fixed).must_equal '/lotus'
+    end
+
+    it 'recognizes string with variables' do
+      @router.path(:variables, id: 'lotus').must_equal '/flowers/lotus'
+    end
+
+    it "raises error when variables aren't satisfied" do
+      -> {
+        @router.path(:variables)
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'recognizes string with variables and constraints' do
+      @router.path(:constraints, id: 23).must_equal '/books/23'
+    end
+
+    it "raises error when constraints aren't satisfied" do
+      -> {
+        @router.path(:constraints, id: 'x')
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'recognizes optional variables' do
+      @router.path(:optional).must_equal                           '/articles'
+      @router.path(:optional, page: '1').must_equal                '/articles?page=1'
+      @router.path(:optional, format: 'rss').must_equal            '/articles.rss'
+      @router.path(:optional, format: 'rss', page: '1').must_equal '/articles.rss?page=1'
+    end
+
+    it 'recognizes glob string' do
+      @router.path(:glob).must_equal '/files/'
+    end
+
+    it 'escapes additional params in query string' do
+      @router.path(:fixed, return_to: '/dashboard').must_equal '/lotus?return_to=%2Fdashboard'
+    end
+
+    it 'raises error when insufficient params are passed' do
+      -> {
+        @router.path(nil)
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'raises error when too many params are passed' do
+      -> {
+        @router.path(:fixed, 'x')
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+  end
+
+  describe '#url' do
+    it 'recognizes fixed string' do
+      @router.url(:fixed).must_equal 'https://test.com/lotus'
+    end
+
+    it 'recognizes string with variables' do
+      @router.url(:variables, id: 'lotus').must_equal 'https://test.com/flowers/lotus'
+    end
+
+    it "raises error when variables aren't satisfied" do
+      -> {
+        @router.url(:variables)
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'recognizes string with variables and constraints' do
+      @router.url(:constraints, id: 23).must_equal 'https://test.com/books/23'
+    end
+
+    it "raises error when constraints aren't satisfied" do
+      -> {
+        @router.url(:constraints, id: 'x')
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'recognizes optional variables' do
+      @router.url(:optional).must_equal                           'https://test.com/articles'
+      @router.url(:optional, page: '1').must_equal                'https://test.com/articles?page=1'
+      @router.url(:optional, format: 'rss').must_equal            'https://test.com/articles.rss'
+      @router.url(:optional, format: 'rss', page: '1').must_equal 'https://test.com/articles.rss?page=1'
+    end
+
+    it 'recognizes glob string' do
+      @router.url(:glob).must_equal 'https://test.com/files/'
+    end
+
+    it 'escapes additional params in query string' do
+      @router.url(:fixed, return_to: '/dashboard').must_equal 'https://test.com/lotus?return_to=%2Fdashboard'
+    end
+
+    it 'raises error when insufficient params are passed' do
+      -> {
+        @router.url(nil)
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+
+    it 'raises error when too many params are passed' do
+      -> {
+        @router.url(:fixed, 'x')
+      }.must_raise(Lotus::Routing::InvalidRouteException)
+    end
+  end
+end

data/test/namespace_test.rb

@@ -0,0 +1,289 @@
+require 'test_helper'
+
+describe Lotus::Router do
+  before do
+    @router = Lotus::Router.new
+    @app    = Rack::MockRequest.new(@router)
+  end
+
+  after do
+    @router.reset!
+  end
+
+  def endpoint(response)
+    ->(env) { response }
+  end
+
+  describe '#namespace' do
+    it 'recognizes get path' do
+      endpoint = endpoint([200, {}, ['Trees (GET)!']])
+      @router.namespace 'trees' do
+        get '/plane-tree', to: endpoint
+      end
+
+      @app.request('GET', '/trees/plane-tree').body.must_equal 'Trees (GET)!'
+    end
+
+    it 'recognizes post path' do
+      endpoint = endpoint([200, {}, ['Trees (POST)!']])
+      @router.namespace 'trees' do
+        post '/sequoia', to: endpoint
+      end
+
+      @app.request('POST', '/trees/sequoia').body.must_equal 'Trees (POST)!'
+    end
+
+    it 'recognizes put path' do
+      endpoint = endpoint([200, {}, ['Trees (PUT)!']])
+      @router.namespace 'trees' do
+        put '/cherry-tree', to: endpoint
+      end
+
+      @app.request('PUT', '/trees/cherry-tree').body.must_equal 'Trees (PUT)!'
+    end
+
+    it 'recognizes patch path' do
+      endpoint = endpoint([200, {}, ['Trees (PATCH)!']])
+      @router.namespace 'trees' do
+        patch '/cedar', to: endpoint
+      end
+
+      @app.request('PATCH', '/trees/cedar').body.must_equal 'Trees (PATCH)!'
+    end
+
+    it 'recognizes delete path' do
+      endpoint = endpoint([200, {}, ['Trees (DELETE)!']])
+      @router.namespace 'trees' do
+        delete '/pine', to: endpoint
+      end
+
+      @app.request('DELETE', '/trees/pine').body.must_equal 'Trees (DELETE)!'
+    end
+
+    it 'recognizes trace path' do
+      endpoint = endpoint([200, {}, ['Trees (TRACE)!']])
+      @router.namespace 'trees' do
+        trace '/cypress', to: endpoint
+      end
+
+      @app.request('TRACE', '/trees/cypress').body.must_equal 'Trees (TRACE)!'
+    end
+
+    describe 'nested' do
+      before do
+        endpoint = endpoint([200, {}, ['Meow!']])
+        @router.namespace 'animals' do
+          namespace 'mammals' do
+            get '/cats', to: endpoint
+          end
+        end
+      end
+
+      it 'recognizes get path' do
+        @app.request('GET', '/animals/mammals/cats').body.must_equal 'Meow!'
+      end
+    end
+
+    describe 'redirect' do
+      before do
+        endpoint = endpoint([200, {}, ['New Home!']])
+        @router.namespace 'users' do
+          get '/home', to: endpoint
+          redirect '/dashboard', to: '/home'
+        end
+      end
+
+      it 'recognizes get path' do
+        @app.request('GET', '/users/dashboard').headers['Location'].must_equal '/users/home'
+        @app.request('GET', '/users/dashboard').status.must_equal 302
+      end
+    end
+
+    describe 'restful resources' do
+      before do
+        @router.namespace 'vegetals' do
+          resources 'flowers'
+        end
+      end
+
+      it 'recognizes get index' do
+        @router.path(:vegetals_flowers).must_equal              '/vegetals/flowers'
+        @app.request('GET', '/vegetals/flowers').body.must_equal         'Flowers::Index'
+      end
+
+      it 'recognizes get new' do
+        @router.path(:vegetals_new_flowers).must_equal          '/vegetals/flowers/new'
+        @app.request('GET', '/vegetals/flowers/new').body.must_equal     'Flowers::New'
+      end
+
+      it 'recognizes post create' do
+        @router.path(:vegetals_flowers).must_equal                       '/vegetals/flowers'
+        @app.request('POST', '/vegetals/flowers').body.must_equal        'Flowers::Create'
+      end
+
+      it 'recognizes get show' do
+        @router.path(:vegetals_flowers, id: 23).must_equal               '/vegetals/flowers/23'
+        @app.request('GET', '/vegetals/flowers/23').body.must_equal      'Flowers::Show 23'
+      end
+
+      it 'recognizes get edit' do
+        @router.path(:vegetals_edit_flowers, id: 23).must_equal          '/vegetals/flowers/23/edit'
+        @app.request('GET', '/vegetals/flowers/23/edit').body.must_equal 'Flowers::Edit 23'
+      end
+
+      it 'recognizes patch update' do
+        @router.path(:vegetals_flowers, id: 23).must_equal               '/vegetals/flowers/23'
+        @app.request('PATCH', '/vegetals/flowers/23').body.must_equal    'Flowers::Update 23'
+      end
+
+      it 'recognizes delete destroy' do
+        @router.path(:vegetals_flowers, id: 23).must_equal               '/vegetals/flowers/23'
+        @app.request('DELETE', '/vegetals/flowers/23').body.must_equal   'Flowers::Destroy 23'
+      end
+
+      describe ':only option' do
+        before do
+          @router.namespace 'electronics' do
+            resources 'keyboards', only: [:index, :edit]
+          end
+        end
+
+        it 'recognizes only specified paths' do
+          @router.path(:electronics_keyboards).must_equal                       '/electronics/keyboards'
+          @app.request('GET', '/electronics/keyboards').body.must_equal         'Keyboards::Index'
+
+          @router.path(:electronics_edit_keyboards, id: 23).must_equal          '/electronics/keyboards/23/edit'
+          @app.request('GET', '/electronics/keyboards/23/edit').body.must_equal 'Keyboards::Edit 23'
+        end
+
+        it 'does not recognize other paths' do
+          @app.request('GET',    '/electronics/keyboards/new').status.must_equal 404
+          @app.request('POST',   '/electronics/keyboards').status.must_equal     405
+          @app.request('GET',    '/electronics/keyboards/23').status.must_equal  404
+          @app.request('PATCH',  '/electronics/keyboards/23').status.must_equal  405
+          @app.request('DELETE', '/electronics/keyboards/23').status.must_equal  405
+
+          -> { @router.path(:electronics_new_keyboards) }.must_raise HttpRouter::InvalidRouteException
+        end
+      end
+
+      describe ':except option' do
+        before do
+          @router.namespace 'electronics' do
+            resources 'keyboards', except: [:new, :show, :update, :destroy]
+          end
+        end
+
+        it 'recognizes only the non-rejected paths' do
+          @router.path(:electronics_keyboards).must_equal                       '/electronics/keyboards'
+          @app.request('GET', '/electronics/keyboards').body.must_equal         'Keyboards::Index'
+
+          @router.path(:electronics_edit_keyboards, id: 23).must_equal          '/electronics/keyboards/23/edit'
+          @app.request('GET', '/electronics/keyboards/23/edit').body.must_equal 'Keyboards::Edit 23'
+
+          @router.path(:electronics_keyboards).must_equal                       '/electronics/keyboards'
+          @app.request('POST', '/electronics/keyboards').body.must_equal        'Keyboards::Create'
+        end
+
+        it 'does not recognize other paths' do
+          @app.request('GET',    '/electronics/keyboards/new').status.must_equal 404
+          @app.request('PATCH',  '/electronics/keyboards/23').status.must_equal  405
+          @app.request('DELETE', '/electronics/keyboards/23').status.must_equal  405
+
+          -> { @router.path(:electronics_new_keyboards) }.must_raise HttpRouter::InvalidRouteException
+        end
+      end
+    end
+
+    describe 'restful resource' do
+      before do
+        @router.namespace 'settings' do
+          resource 'avatar'
+        end
+      end
+
+      it 'recognizes get new' do
+        @router.path(:settings_new_avatar).must_equal      '/settings/avatar/new'
+        @app.request('GET', '/settings/avatar/new').body.must_equal 'Avatar::New'
+      end
+
+      it 'recognizes post create' do
+        @router.path(:settings_avatar).must_equal              '/settings/avatar'
+        @app.request('POST', '/settings/avatar').body.must_equal 'Avatar::Create'
+      end
+
+      it 'recognizes get show' do
+        @router.path(:settings_avatar).must_equal           '/settings/avatar'
+        @app.request('GET', '/settings/avatar').body.must_equal 'Avatar::Show'
+      end
+
+      it 'recognizes get edit' do
+        @router.path(:settings_edit_avatar).must_equal      '/settings/avatar/edit'
+        @app.request('GET', '/settings/avatar/edit').body.must_equal 'Avatar::Edit'
+      end
+
+      it 'recognizes patch update' do
+        @router.path(:settings_avatar).must_equal               '/settings/avatar'
+        @app.request('PATCH', '/settings/avatar').body.must_equal 'Avatar::Update'
+      end
+
+      it 'recognizes delete destroy' do
+        @router.path(:settings_avatar).must_equal                 '/settings/avatar'
+        @app.request('DELETE', '/settings/avatar').body.must_equal 'Avatar::Destroy'
+      end
+
+      describe ':only option' do
+        before do
+          @router.namespace 'settings' do
+            resource 'profile', only: [:edit, :update]
+          end
+        end
+
+        it 'recognizes only specified paths' do
+          @router.path(:settings_edit_profile).must_equal      '/settings/profile/edit'
+          @app.request('GET', '/settings/profile/edit').body.must_equal 'Profile::Edit'
+
+          @router.path(:settings_profile).must_equal               '/settings/profile'
+          @app.request('PATCH', '/settings/profile').body.must_equal 'Profile::Update'
+        end
+
+        it 'does not recognize other paths' do
+          @app.request('GET',    '/settings/profile').status.must_equal     405
+          @app.request('GET',    '/settings/profile/new').status.must_equal 405
+          @app.request('POST',   '/settings/profile').status.must_equal     405
+          @app.request('DELETE', '/settings/profile').status.must_equal     405
+
+          -> { @router.path(:settings_new_profile) }.must_raise HttpRouter::InvalidRouteException
+        end
+      end
+
+      describe ':except option' do
+        before do
+          @router.namespace 'settings' do
+            resource 'profile', except: [:edit, :update]
+          end
+        end
+
+        it 'recognizes only the non-rejected paths' do
+          @router.path(:settings_profile).must_equal           '/settings/profile'
+          @app.request('GET', '/settings/profile').body.must_equal 'Profile::Show'
+
+          @router.path(:settings_new_profile).must_equal      '/settings/profile/new'
+          @app.request('GET', '/settings/profile/new').body.must_equal 'Profile::New'
+
+          @router.path(:settings_profile).must_equal              '/settings/profile'
+          @app.request('POST', '/settings/profile').body.must_equal 'Profile::Create'
+
+          @router.path(:settings_profile).must_equal                 '/settings/profile'
+          @app.request('DELETE', '/settings/profile').body.must_equal 'Profile::Destroy'
+        end
+
+        it 'does not recognize other paths' do
+          @app.request('GET', '/settings/profile/edit').status.must_equal 404
+
+          -> { @router.path(:settings_edit_profile) }.must_raise HttpRouter::InvalidRouteException
+        end
+      end
+    end
+  end
+end

data/test/new_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+describe Lotus::Router do
+  describe '.new' do
+    before do
+      class MockRoute
+      end
+
+      endpoint = ->(env) { [200, {}, ['']] }
+      @router = Lotus::Router.new do
+        get '/route',       to: endpoint
+        get '/named_route', to: endpoint, as: :named_route
+        resource  'avatar'
+        resources 'flowers'
+        namespace 'admin' do
+          get '/dashboard', to: endpoint
+        end
+      end
+
+      @app = Rack::MockRequest.new(@router)
+    end
+
+    it 'returns instance of Lotus::Router with empty block' do
+      router = Lotus::Router.new { }
+      router.must_be_instance_of Lotus::Router
+    end
+
+    it 'returns instance of Lotus::Router' do
+      @router.must_be_instance_of Lotus::Router
+    end
+
+    it 'sets options' do
+      router = Lotus::Router.new(scheme: 'https') do
+        get '/', to: ->(env) { }, as: :root
+      end
+
+      router.url(:root).must_match('https')
+    end
+
+    it 'sets custom separator' do
+      router = Lotus::Router.new(action_separator: '^')
+      route  = router.get('/', to: 'test^show', as: :root)
+
+      route.dest.must_equal(TestController::Show)
+    end
+
+    it 'recognizes path' do
+      @app.get('/route').status.must_equal 200
+    end
+
+    it 'recognizes named path' do
+      @app.get('/named_route').status.must_equal 200
+    end
+
+    it 'recognizes resource' do
+      @app.get('/avatar').status.must_equal 200
+    end
+
+    it 'recognizes resources' do
+      @app.get('/avatar').status.must_equal 200
+    end
+
+    it 'recognizes namespaced path' do
+      @app.get('/admin/dashboard').status.must_equal 200
+    end
+  end
+end