lotus-router 0.0.0 → 0.1.0

data/test/redirect_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe Lotus::Router do
+  before do
+    @router = Lotus::Router.new
+  end
+
+  describe '#redirect' do
+    it 'recognizes string endpoint' do
+      endpoint = ->(env) { [200, {}, ['Redirect destination!']] }
+      @router.get('/redirect_destination', to: endpoint)
+      @router.redirect('/redirect', to: '/redirect_destination')
+
+      env = Rack::MockRequest.env_for('/redirect')
+      status, headers, _ = @router.call(env)
+
+      status.must_equal 302
+      headers['Location'].must_equal '/redirect_destination'
+    end
+
+    it 'recognizes string endpoint with custom http code' do
+      endpoint = ->(env) { [200, {}, ['Redirect destination!']] }
+      @router.get('/redirect_destination', to: endpoint)
+      @router.redirect('/redirect', to: '/redirect_destination', code: 301)
+
+      env = Rack::MockRequest.env_for('/redirect')
+      status, headers, _ = @router.call(env)
+
+      status.must_equal 301
+      headers['Location'].must_equal '/redirect_destination'
+    end
+  end
+end

data/test/resource_test.rb

@@ -0,0 +1,128 @@
+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 '#resource' do
+    before do
+      @router.resource 'avatar'
+    end
+
+    it 'recognizes get new' do
+      @router.path(:new_avatar).must_equal                '/avatar/new'
+      @app.request('GET', '/avatar/new').body.must_equal  'Avatar::New'
+    end
+
+    it 'recognizes post create' do
+      @router.path(:avatar).must_equal                    '/avatar'
+      @app.request('POST', '/avatar').body.must_equal     'Avatar::Create'
+    end
+
+    it 'recognizes get show' do
+      @router.path(:avatar).must_equal                    '/avatar'
+      @app.request('GET', '/avatar').body.must_equal      'Avatar::Show'
+    end
+
+    it 'recognizes get edit' do
+      @router.path(:edit_avatar).must_equal               '/avatar/edit'
+      @app.request('GET', '/avatar/edit').body.must_equal 'Avatar::Edit'
+    end
+
+    it 'recognizes patch update' do
+      @router.path(:avatar).must_equal                    '/avatar'
+      @app.request('PATCH', '/avatar').body.must_equal    'Avatar::Update'
+    end
+
+    it 'recognizes delete destroy' do
+      @router.path(:avatar).must_equal                    '/avatar'
+      @app.request('DELETE', '/avatar').body.must_equal   'Avatar::Destroy'
+    end
+
+    describe ':only option' do
+      before do
+        @router.resource 'profile', only: [:edit, :update]
+      end
+
+      it 'recognizes only specified paths' do
+        @router.path(:edit_profile).must_equal               '/profile/edit'
+        @app.request('GET', '/profile/edit').body.must_equal 'Profile::Edit'
+
+        @router.path(:profile).must_equal                    '/profile'
+        @app.request('PATCH', '/profile').body.must_equal    'Profile::Update'
+      end
+
+      it 'does not recognize other paths' do
+        @app.request('GET',    '/profile/new').status.must_equal 405
+        @app.request('POST',   '/profile').status.must_equal     405
+        @app.request('GET',    '/profile').status.must_equal     405
+        @app.request('DELETE', '/profile').status.must_equal     405
+
+        -> { @router.path(:new_profile) }.must_raise HttpRouter::InvalidRouteException
+      end
+    end
+
+    describe ':except option' do
+      before do
+        @router.resource 'profile', except: [:new, :show, :create, :destroy]
+      end
+
+      it 'recognizes only the non-rejected paths' do
+        @router.path(:edit_profile).must_equal               '/profile/edit'
+        @app.request('GET', '/profile/edit').body.must_equal 'Profile::Edit'
+
+        @router.path(:profile).must_equal                    '/profile'
+        @app.request('PATCH', '/profile').body.must_equal    'Profile::Update'
+      end
+
+      it 'does not recognize other paths' do
+        @app.request('GET',    '/profile/new').status.must_equal 405
+        @app.request('POST',   '/profile').status.must_equal     405
+        @app.request('GET',    '/profile').status.must_equal     405
+        @app.request('DELETE', '/profile').status.must_equal     405
+
+        -> { @router.path(:new_profile) }.must_raise HttpRouter::InvalidRouteException
+      end
+    end
+
+    describe 'member' do
+      before do
+        @router.resource 'profile', only: [] do
+          member do
+            patch 'activate'
+          end
+        end
+      end
+
+      it 'recognizes the path' do
+        @router.path(:activate_profile).must_equal                 '/profile/activate'
+        @app.request('PATCH', '/profile/activate').body.must_equal 'Profile::Activate'
+      end
+    end
+
+    describe 'collection' do
+      before do
+        @router.resource 'profile', only: [] do
+          collection do
+            get 'keys'
+          end
+        end
+      end
+
+      it 'recognizes the path' do
+        @router.path(:keys_profile).must_equal               '/profile/keys'
+        @app.request('GET', '/profile/keys').body.must_equal 'Profile::Keys'
+      end
+    end
+  end
+end

data/test/resources_test.rb

@@ -0,0 +1,136 @@
+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 '#resources' do
+    before do
+      @router.resources 'flowers'
+    end
+
+    it 'recognizes get index' do
+      @router.path(:flowers).must_equal                       '/flowers'
+      @app.request('GET', '/flowers').body.must_equal         'Flowers::Index'
+    end
+
+    it 'recognizes get new' do
+      @router.path(:new_flowers).must_equal                   '/flowers/new'
+      @app.request('GET', '/flowers/new').body.must_equal     'Flowers::New'
+    end
+
+    it 'recognizes post create' do
+      @router.path(:flowers).must_equal                       '/flowers'
+      @app.request('POST', '/flowers').body.must_equal        'Flowers::Create'
+    end
+
+    it 'recognizes get show' do
+      @router.path(:flowers, id: 23).must_equal               '/flowers/23'
+      @app.request('GET', '/flowers/23').body.must_equal      'Flowers::Show 23'
+    end
+
+    it 'recognizes get edit' do
+      @router.path(:edit_flowers, id: 23).must_equal          '/flowers/23/edit'
+      @app.request('GET', '/flowers/23/edit').body.must_equal 'Flowers::Edit 23'
+    end
+
+    it 'recognizes patch update' do
+      @router.path(:flowers, id: 23).must_equal               '/flowers/23'
+      @app.request('PATCH', '/flowers/23').body.must_equal    'Flowers::Update 23'
+    end
+
+    it 'recognizes delete destroy' do
+      @router.path(:flowers, id: 23).must_equal               '/flowers/23'
+      @app.request('DELETE', '/flowers/23').body.must_equal   'Flowers::Destroy 23'
+    end
+
+    describe ':only option' do
+      before do
+        @router.resources 'keyboards', only: [:index, :edit]
+      end
+
+      it 'recognizes only specified paths' do
+        @router.path(:keyboards).must_equal                       '/keyboards'
+        @app.request('GET', '/keyboards').body.must_equal         'Keyboards::Index'
+
+        @router.path(:edit_keyboards, id: 23).must_equal          '/keyboards/23/edit'
+        @app.request('GET', '/keyboards/23/edit').body.must_equal 'Keyboards::Edit 23'
+      end
+
+      it 'does not recognize other paths' do
+        @app.request('GET',    '/keyboards/new').status.must_equal 404
+        @app.request('POST',   '/keyboards').status.must_equal     405
+        @app.request('GET',    '/keyboards/23').status.must_equal  404
+        @app.request('PATCH',  '/keyboards/23').status.must_equal  405
+        @app.request('DELETE', '/keyboards/23').status.must_equal  405
+
+        -> { @router.path(:new_keyboards) }.must_raise HttpRouter::InvalidRouteException
+      end
+    end
+
+    describe ':except option' do
+      before do
+        @router.resources 'keyboards', except: [:new, :show, :update, :destroy]
+      end
+
+      it 'recognizes only the non-rejected paths' do
+        @router.path(:keyboards).must_equal                       '/keyboards'
+        @app.request('GET', '/keyboards').body.must_equal         'Keyboards::Index'
+
+        @router.path(:edit_keyboards, id: 23).must_equal          '/keyboards/23/edit'
+        @app.request('GET', '/keyboards/23/edit').body.must_equal 'Keyboards::Edit 23'
+
+        @router.path(:keyboards).must_equal                       '/keyboards'
+        @app.request('POST', '/keyboards').body.must_equal        'Keyboards::Create'
+      end
+
+      it 'does not recognize other paths' do
+        @app.request('GET',    '/keyboards/new').status.must_equal 404
+        @app.request('PATCH',  '/keyboards/23').status.must_equal  405
+        @app.request('DELETE', '/keyboards/23').status.must_equal  405
+
+        -> { @router.path(:new_keyboards) }.must_raise HttpRouter::InvalidRouteException
+      end
+    end
+
+    describe 'member' do
+      before do
+        @router.resources 'keyboards', only: [] do
+          member do
+            get 'screenshot'
+          end
+        end
+      end
+
+      it 'recognizes the path' do
+        @router.path(:screenshot_keyboards, id: 23).must_equal          '/keyboards/23/screenshot'
+        @app.request('GET', '/keyboards/23/screenshot').body.must_equal 'Keyboards::Screenshot 23'
+      end
+    end
+
+    describe 'collection' do
+      before do
+        @router.resources 'keyboards', only: [] do
+          collection do
+            get 'search'
+          end
+        end
+      end
+
+      it 'recognizes the path' do
+        @router.path(:search_keyboards).must_equal               '/keyboards/search'
+        @app.request('GET', '/keyboards/search').body.must_equal 'Keyboards::Search'
+      end
+    end
+  end
+end

data/test/routing/endpoint_resolver_test.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+describe Lotus::Routing::EndpointResolver do
+  before do
+    @resolver = Lotus::Routing::EndpointResolver.new
+  end
+
+  it 'recognizes :to when it is a callable object' do
+    endpoint = Object.new
+    endpoint.define_singleton_method(:call) { }
+
+    options = { to: endpoint }
+
+    @resolver.resolve(options).must_equal(endpoint)
+  end
+
+  it 'recognizes :to when it is a string that references a class that can be retrieved now' do
+    options = { to: 'test_endpoint' }
+    @resolver.resolve(options).call({}).must_equal 'Hi from TestEndpoint!'
+  end
+
+  describe 'when :to references a missing class' do
+    it 'if the class is available when invoking call, it succeed' do
+      options  = { to: 'lazy_controller' }
+      endpoint = @resolver.resolve(options)
+      LazyController = Class.new(Object) { define_method(:call) {|env| env } }
+
+      endpoint.call({}).must_equal({})
+    end
+
+    it 'if the class is not available when invoking call, it raises error' do
+      options  = { to: 'missing_endpoint' }
+      endpoint = @resolver.resolve(options)
+
+      -> { endpoint.call({}) }.must_raise Lotus::Routing::EndpointNotFound
+    end
+  end
+
+  it 'recognizes :to when it is a string with separator' do
+    options = { to: 'test#show' }
+    @resolver.resolve(options).call({}).must_equal 'Hi from Test::Show!'
+  end
+
+  it 'returns the default endpoint when cannot match anything' do
+    options = { to: 23 }
+    @resolver.resolve(options).call({}).first.must_equal 404
+  end
+
+  describe 'namespace' do
+    before do
+      @resolver = Lotus::Routing::EndpointResolver.new(namespace: TestApp)
+    end
+
+    it 'recognizes :to when it is a string and an explicit namespace' do
+      options = { to: 'test_endpoint' }
+      @resolver.resolve(options).call({}).must_equal 'Hi from TestApp::TestEndpoint!'
+    end
+
+    it 'recognizes :to when it is a string with separator and it has an explicit namespace' do
+      options = { to: 'test2#show' }
+      @resolver.resolve(options).call({}).must_equal 'Hi from TestApp::Test2Controller::Show!'
+    end
+  end
+
+  describe 'custom endpoint' do
+    before :all do
+      class CustomEndpoint
+        def initialize(endpoint)
+          @endpoint = endpoint
+        end
+      end
+
+      @resolver = Lotus::Routing::EndpointResolver.new(endpoint: CustomEndpoint)
+    end
+
+    after do
+      Object.send(:remove_const, :CustomEndpoint)
+    end
+
+    it 'returns specified endpoint instance' do
+      @resolver.resolve({}).class.must_equal(CustomEndpoint)
+    end
+  end
+
+  describe 'custom separator' do
+    before do
+      @resolver = Lotus::Routing::EndpointResolver.new(action_separator: action_separator)
+    end
+
+    let(:action_separator) { '@' }
+
+    it 'matches controller and action with a custom separator' do
+      options = { to: "test#{ action_separator }show" }
+      @resolver.resolve(options).call({}).must_equal 'Hi from Test::Show!'
+    end
+  end
+
+  describe 'custom suffix' do
+    before do
+      @resolver = Lotus::Routing::EndpointResolver.new(suffix: suffix)
+    end
+
+    let(:suffix) { 'Controller::' }
+
+    it 'matches controller and action with a custom separator' do
+      options = { to: 'test#show' }
+      @resolver.resolve(options).call({}).must_equal 'Hi from Test::Show!'
+    end
+  end
+end

data/test/routing/resource/options_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Lotus::Routing::Resource::Options do
+  before do
+    @actions = [:index, :new, :create, :show, :edit, :update, :destroy]
+  end
+
+  it 'returns all the actions when no exceptions are requested' do
+    Lotus::Routing::Resources::Options.new(@actions).actions.must_equal @actions
+  end
+
+  it 'returns only the action requested via the :only option' do
+    options = Lotus::Routing::Resources::Options.new(@actions, only: :show)
+    options.actions.must_equal [:show]
+  end
+
+  it 'returns only the actions requested via the :only options' do
+    options = Lotus::Routing::Resources::Options.new(@actions, only: [:create, :edit])
+    options.actions.must_equal [:create, :edit]
+  end
+
+  it 'returns only the action not rejected via the :except option' do
+    options = Lotus::Routing::Resources::Options.new(@actions, except: :destroy)
+    options.actions.must_equal [:index, :new, :create, :show, :edit, :update]
+  end
+
+  it 'returns only the actions requested via the :only options' do
+    options = Lotus::Routing::Resources::Options.new(@actions, except: [:index, :new, :edit])
+    options.actions.must_equal [:create, :show, :update, :destroy]
+  end
+
+  it 'allow access to values' do
+    options = Lotus::Routing::Resources::Options.new(@actions, name: :lotus)
+    options[:name].must_equal :lotus
+  end
+end