azeroth 0.7.2 → 0.8.1

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '0.7.2'
+  VERSION = '0.8.1'
 end

data/spec/controllers/documents_controller_spec.rb

@@ -11,7 +11,7 @@ describe DocumentsController do
     let(:documents_count) { 0 }
 
     before do
-      documents_count.times.map { create(:document) }
+      create_list(:document, documents_count)
     end
 
     context 'when calling on format json' do

data/spec/controllers/documents_with_error_controller_spec.rb

@@ -11,7 +11,7 @@ describe DocumentsWithErrorController do
     let(:documents_count) { 0 }
 
     before do
-      documents_count.times.map { create(:document) }
+      create_list(:document, documents_count)
     end
 
     context 'when calling on format json' do

data/spec/controllers/index_documents_controller_spec.rb

@@ -10,7 +10,7 @@ describe IndexDocumentsController do
   describe 'GET index' do
     let(:documents_count) { 0 }
     let!(:documents) do
-      documents_count.times.map { create(:document) }
+      create_list(:document, documents_count)
     end
 
     let(:expected_json) do
@@ -37,6 +37,17 @@ describe IndexDocumentsController do
           expect(parsed_response).to eq(expected_json)
         end
       end
+
+      context 'when there are more documents than expected pagination' do
+        let(:documents_count) { Random.rand(21..30) }
+
+        it { expect(response).to be_successful }
+
+        it 'returns all documents' do
+          expect(parsed_response)
+            .to have(documents_count).elements
+        end
+      end
     end
   end
 

data/spec/controllers/paginated_documents_controller_spec.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaginatedDocumentsController do
+  let(:parsed_response) do
+    JSON.parse(response.body)
+  end
+
+  describe 'GET index' do
+    let(:documents_count) { 0 }
+    let!(:documents) do
+      create_list(:document, documents_count)
+    end
+
+    let(:expected_json) do
+      Document::Decorator.new(documents).as_json
+    end
+
+    context 'when calling on format json' do
+      let(:parameters) { {} }
+
+      before do
+        get :index, params: parameters.merge(format: :json)
+      end
+
+      it { expect(response).to be_successful }
+
+      it 'returns empty array' do
+        expect(parsed_response).to eq(expected_json)
+      end
+
+      context 'when there is a document' do
+        let(:documents_count) { 1 }
+
+        it { expect(response).to be_successful }
+
+        it 'renders documents json' do
+          expect(parsed_response).to eq(expected_json)
+        end
+
+        it 'adds total pages header' do
+          expect(response.headers['pages']).to eq(1)
+        end
+
+        it 'adds current page header' do
+          expect(response.headers['page']).to eq(1)
+        end
+
+        it 'adds per page header' do
+          expect(response.headers['per_page']).to eq(20)
+        end
+      end
+
+      context 'when there are more documents than expected pagination' do
+        let(:documents_count) { Random.rand(21..30) }
+
+        it { expect(response).to be_successful }
+
+        it 'returns paginated documents' do
+          expect(parsed_response)
+            .not_to have(documents_count).elements
+        end
+
+        it 'returns full page of documents' do
+          expect(parsed_response)
+            .to have(20).elements
+        end
+
+        it 'adds total pages header' do
+          expect(response.headers['pages']).to eq(2)
+        end
+
+        it 'adds current page header' do
+          expect(response.headers['page']).to eq(1)
+        end
+
+        it 'adds per page header' do
+          expect(response.headers['per_page']).to eq(20)
+        end
+      end
+
+      context 'when page is given' do
+        let(:documents_count) { Random.rand(21..30) }
+        let(:parameters)      { { page: 2 } }
+
+        it { expect(response).to be_successful }
+
+        it 'returns paginated documents' do
+          expect(parsed_response)
+            .not_to have(documents_count).elements
+        end
+
+        it 'returns full page of documents' do
+          expect(parsed_response)
+            .to have(documents_count - 20)
+            .elements
+        end
+
+        it 'adds total pages header' do
+          expect(response.headers['pages']).to eq(2)
+        end
+
+        it 'adds current page header' do
+          expect(response.headers['page']).to eq(2)
+        end
+
+        it 'adds per page header' do
+          expect(response.headers['per_page']).to eq(20)
+        end
+      end
+
+      context 'when per_page is given' do
+        let(:documents_count) { Random.rand(21..30) }
+        let(:per_page)        { Random.rand(5..15) }
+        let(:parameters)      { { per_page: per_page } }
+
+        it { expect(response).to be_successful }
+
+        it 'returns paginated documents' do
+          expect(parsed_response)
+            .not_to have(documents_count).elements
+        end
+
+        it 'returns full page of documents' do
+          expect(parsed_response)
+            .to have(per_page)
+            .elements
+        end
+
+        it 'adds total pages header' do
+          expect(response.headers['pages'])
+            .to eq((documents_count.to_f / per_page).ceil)
+        end
+
+        it 'adds current page header' do
+          expect(response.headers['page']).to eq(1)
+        end
+
+        it 'adds per page header' do
+          expect(response.headers['per_page']).to eq(per_page)
+        end
+      end
+    end
+  end
+end

data/spec/dummy/app/controllers/paginated_documents_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class PaginatedDocumentsController < ApplicationController
+  include Azeroth::Resourceable
+
+  resource_for :document, only: 'index', paginated: true
+end

data/spec/dummy/config/routes.rb

@@ -4,6 +4,7 @@ Rails.application.routes.draw do
   resources :documents
   resources :public_documents, controller: :index_documents
   resources :create_documents, controller: :documents_with_error
+  resources :paginated_documents
 
   resources :publishers, only: %i[create index] do
     resources :games, except: :delete

data/spec/lib/azeroth/controller_interface_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::ControllerInterface do
+  subject(:interface)    { described_class.new(controller) }
+
+  let(:controller)       { controller_class.new }
+  let(:controller_class) { RequestHandlerController }
+
+  describe '#add_headers' do
+    let(:controller_headers) do
+      {
+        'old_key': 100
+      }
+    end
+
+    let(:headers) do
+      {
+        key1: 10,
+        key2: 20
+      }
+    end
+
+    before do
+      allow(controller)
+        .to receive(:headers)
+        .and_return(controller_headers)
+    end
+
+    it 'sets controller headers' do
+      expect { interface.add_headers(headers) }
+        .to change { controller_headers }
+        .from(controller_headers)
+        .to(controller_headers.merge(headers.stringify_keys))
+    end
+  end
+
+  describe '#render_json' do
+    let(:json)   { { key: 'value' } }
+    let(:status) { 200 }
+
+    before do
+      allow(controller)
+        .to receive(:render)
+        .with(json: json, status: status)
+    end
+
+    it 'renders json' do
+      interface.render_json(json, status)
+
+      expect(controller).to have_received(:render)
+    end
+  end
+
+  describe '#set' do
+    it 'sets instance variable' do
+      expect { interface.set(:name, 20) }
+        .to change { controller.instance_variable_get('@name') }
+        .from(nil)
+        .to(20)
+    end
+  end
+
+  describe 'method missing' do
+    before do
+      create(:document)
+    end
+
+    it 'delegates call to controller' do
+      expect(interface.documents)
+        .to eq(Document.all)
+    end
+
+    context 'when method is not defined' do
+      it do
+        expect { interface.pokemons }
+          .to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/lib/azeroth/decorator/method_builder_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Decorator::MethodBuilder do
+  let(:decorator_class) { Class.new(Azeroth::Decorator) }
+  let(:decorator)       { decorator_class.new(object) }
+  let(:model)           { build(:dummy_model) }
+  let(:object)          { model }
+
+  describe '.build_reader' do
+    it do
+      expect { described_class.build_reader(decorator_class, :age) }
+        .to add_method(:age).to(decorator)
+    end
+
+    it do
+      described_class.build_reader(decorator_class, :age)
+
+      expect(decorator.age).to eq(model.age)
+    end
+  end
+end

data/spec/lib/azeroth/request_handler/create_spec.rb

@@ -106,6 +106,112 @@ describe Azeroth::RequestHandler::Create do
         end
       end
     end
+
+    context 'with after_save block option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:block) do
+          value = 10
+          proc do
+            document.update(reference: "X-MAGIC-#{value}")
+            Worker.perform(document.id)
+          end
+        end
+
+        let(:options_hash) do
+          {
+            after_save: block
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-10'
+          }
+        end
+
+        before do
+          allow(Worker).to receive(:perform)
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'trigger workers after saving' do
+          handler.process
+
+          expect(Worker).to have_received(:perform)
+            .with(Document.last.id)
+        end
+
+        it 'changes entry after saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-10')
+        end
+      end
+    end
+
+    context 'with after_save symbol option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:options_hash) do
+          {
+            after_save: :add_magic_reference_and_trigger
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-15'
+          }
+        end
+
+        before do
+          allow(Worker).to receive(:perform)
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'trigger workers after saving' do
+          handler.process
+
+          expect(Worker).to have_received(:perform)
+            .with(Document.last.id)
+        end
+
+        it 'changes entry after saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-15')
+        end
+      end
+    end
   end
 
   context 'with build_with as symbol' do

data/spec/lib/azeroth/request_handler/index_spec.rb

@@ -8,5 +8,123 @@ describe Azeroth::RequestHandler::Index do
       let(:documents_count)   { 3 }
       let(:expected_resource) { Document.all }
     end
+
+    context 'when pagination is active' do
+      it_behaves_like 'a request handler' do
+        let(:documents_count)   { Random.rand(21..30) }
+        let(:expected_resource) { Document.all.limit(20) }
+        let(:options_hash)      { { paginated: true } }
+
+        it 'adds total pages header' do
+          handler.process
+          expect(controller_headers['pages']).to eq(2)
+        end
+
+        it 'adds current page header' do
+          handler.process
+          expect(controller_headers['page']).to eq(1)
+        end
+
+        it 'adds per page header' do
+          handler.process
+          expect(controller_headers['per_page']).to eq(20)
+        end
+      end
+
+      context 'when page is given' do
+        it_behaves_like 'a request handler' do
+          let(:documents_count)   { Random.rand(41..50) }
+          let(:expected_resource) { Document.all.offset(20).limit(20) }
+          let(:options_hash)      { { paginated: true } }
+          let(:extra_params)      { { page: '2' } }
+
+          it 'adds total pages header' do
+            handler.process
+            expect(controller_headers['pages']).to eq(3)
+          end
+
+          it 'adds current page header' do
+            handler.process
+            expect(controller_headers['page']).to eq(2)
+          end
+
+          it 'adds per page header' do
+            handler.process
+            expect(controller_headers['per_page']).to eq(20)
+          end
+        end
+      end
+
+      context 'when third page is given' do
+        it_behaves_like 'a request handler' do
+          let(:documents_count)   { Random.rand(41..50) }
+          let(:expected_resource) { Document.all.offset(40) }
+          let(:options_hash)      { { paginated: true } }
+          let(:extra_params)      { { page: '3' } }
+
+          it 'adds total pages header' do
+            handler.process
+            expect(controller_headers['pages']).to eq(3)
+          end
+
+          it 'adds current page header' do
+            handler.process
+            expect(controller_headers['page']).to eq(3)
+          end
+
+          it 'adds per page header' do
+            handler.process
+            expect(controller_headers['per_page']).to eq(20)
+          end
+        end
+      end
+
+      context 'when per_page is not default' do
+        it_behaves_like 'a request handler' do
+          let(:documents_count)   { Random.rand(21..30) }
+          let(:expected_resource) { Document.all.limit(10) }
+          let(:options_hash)      { { paginated: true, per_page: 10 } }
+
+          it 'adds total pages header' do
+            handler.process
+            expect(controller_headers['pages']).to eq(3)
+          end
+
+          it 'adds current page header' do
+            handler.process
+            expect(controller_headers['page']).to eq(1)
+          end
+
+          it 'adds per page header' do
+            handler.process
+            expect(controller_headers['per_page']).to eq(10)
+          end
+        end
+      end
+
+      context 'when per page is given in params' do
+        it_behaves_like 'a request handler' do
+          let(:documents_count)   { Random.rand(41..50) }
+          let(:expected_resource) { Document.all.offset(10).limit(10) }
+          let(:options_hash)      { { paginated: true, per_page: 15 } }
+          let(:extra_params)      { { page: '2', per_page: '10' } }
+
+          it 'adds total pages header' do
+            handler.process
+            expect(controller_headers['pages']).to eq(5)
+          end
+
+          it 'adds current page header' do
+            handler.process
+            expect(controller_headers['page']).to eq(2)
+          end
+
+          it 'adds per page header' do
+            handler.process
+            expect(controller_headers['per_page']).to eq(10)
+          end
+        end
+      end
+    end
   end
 end