azeroth 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09152b8053d40bd19405c5b7165458483d4304310fa5ec64c0d2b5723dda0067'
-  data.tar.gz: 1a1039542352929720e5cc7ae1242932b7d2a65856e2156b14a36d1a8bb1722b
+  metadata.gz: 60f05e09418f7fc0e6155ee3c4e7349e3a80638295eb01032dc0c284a5ccbaa5
+  data.tar.gz: 97e333436d04d1cfb255c2dc26751e43aa9da6fad9a383f4c26de33c1df70ffe
 SHA512:
-  metadata.gz: 2ae5257e2851ccbbadbd79d9a0c0a13be63e392b2af16c6e1f66be399ee00bc51b06f9682f25d88648f3a32d2c07451d456d80035f04b48a4cc471d27a572e59
-  data.tar.gz: d7c01b81ce09615d65cc451d2a1669ac9d843d18d75fbb0c12c2e4356507fce62288145bd30295674619a0649327b1b69568fede8adb452e602073f67659235e
+  metadata.gz: 2d01f8321b172c0f3d6aedde71ae3e34de04ba261bcacaa4f9157bf8223a75390378167dee429e704a67c38d9d8bb21e695d00faaf612b32dd09d2f53aff9927
+  data.tar.gz: b73a0aee9cc39faff3f6e7a3281987028a27bee1034ecc22e0176e36bd8113fa784800d0460966e16fe973384e081112a74472c7e5878595a4156375b09d0ce2

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.8.0](https://www.rubydoc.info/gems/azeroth/0.8.0)
+[https://www.rubydoc.info/gems/azeroth/0.8.1](https://www.rubydoc.info/gems/azeroth/0.8.1)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same

data/config/yardstick.yml

@@ -23,6 +23,7 @@ rules:
   Summary::Presence:
     enabled: true
     exclude:
+      - Azeroth::ControllerInterface#initialize
       - Azeroth::Decorator#initialize
       - Azeroth::Decorator::HashBuilder#initialize
       - Azeroth::Decorator::KeyValueExtractor#initialize

data/lib/azeroth.rb

@@ -11,12 +11,13 @@ require 'jace'
 #
 # @see Resourceable
 module Azeroth
-  autoload :Decorator,       'azeroth/decorator'
-  autoload :DummyDecorator,  'azeroth/dummy_decorator'
-  autoload :Model,           'azeroth/model'
-  autoload :RequestHandler,  'azeroth/request_handler'
-  autoload :Resourceable,    'azeroth/resourceable'
-  autoload :ResourceBuilder, 'azeroth/resource_builder'
-  autoload :RoutesBuilder,   'azeroth/routes_builder'
-  autoload :Options,         'azeroth/options'
+  autoload :ControllerInterface, 'azeroth/controller_interface'
+  autoload :Decorator,           'azeroth/decorator'
+  autoload :DummyDecorator,      'azeroth/dummy_decorator'
+  autoload :Model,               'azeroth/model'
+  autoload :RequestHandler,      'azeroth/request_handler'
+  autoload :Resourceable,        'azeroth/resourceable'
+  autoload :ResourceBuilder,     'azeroth/resource_builder'
+  autoload :RoutesBuilder,       'azeroth/routes_builder'
+  autoload :Options,             'azeroth/options'
 end

data/lib/azeroth/controller_interface.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Azeroth
+  # @api private
+  #
+  # Interface for using the controller
+  class ControllerInterface
+    # @param controller [ApplicationController]
+    def initialize(controller)
+      @controller = controller
+    end
+
+    # Set response headers
+    #
+    # @param headers_hash [Hash] headers to be set
+    #
+    # @return [Hash]
+    def add_headers(headers_hash)
+      controller.instance_eval do
+        headers_hash.each do |key, value|
+          headers[key.to_s] = value
+        end
+      end
+    end
+
+    # Renders response json
+    #
+    # @return [String]
+    def render_json(json, status)
+      controller.instance_eval do
+        render(json: json, status: status)
+      end
+    end
+
+    # Set a variable in the controller
+    #
+    # @param variable [String,Symbol] variable name
+    # @param value [Object] value to be set
+    #
+    # @return [Object]
+    def set(variable, value)
+      controller.instance_variable_set("@#{variable}", value)
+    end
+
+    private
+
+    attr_reader :controller
+    # @method controller
+    # @private
+    # @api private
+    #
+    # Controller where methods will be called
+    #
+    # @return [ApplicationController]
+
+    # @private
+    #
+    # Dispatcher to delegate all methods call to controller
+    #
+    # @param method_name [Symbol] name of the method
+    #   called
+    # @param args [Array<Object>] arguments of the
+    #   method called
+    #
+    # @return [Object]
+    def method_missing(method_name, *args)
+      if controller.respond_to?(method_name, true)
+        controller.send(method_name, *args)
+      else
+        super
+      end
+    end
+
+    # @private
+    #
+    # Checks if a controller responds to a method
+    #
+    # @param method_name [Symbol] name of the method checked
+    # @param include_private [TrueClass,FalseClass] flag
+    #   indicating if private methods should be included
+    #
+    # @return [TrueClass,FalseClass]
+    def respond_to_missing?(method_name, include_private)
+      controller.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/azeroth/decorator/method_builder.rb

@@ -11,7 +11,7 @@ module Azeroth
       #
       # reaader delegate method calls to @object
       #
-      # @return (see Sinclair#build)
+      # @return [Array<Sinclair::MethodDefinition>]
       def self.build_reader(klass, attribute)
         new(klass).build_reader(attribute)
       end

data/lib/azeroth/request_handler.rb

@@ -19,7 +19,7 @@ module Azeroth
     # @param controller [ApplicationController]
     # @param model [Azeroth::Model]
     def initialize(controller, model, options)
-      @controller = controller
+      @controller = ControllerInterface.new(controller)
       @model = model
       @options = options
     end
@@ -35,12 +35,11 @@ module Azeroth
     def process
       return unless json?
 
-      json            = model.decorate(resource)
-      response_status = status
-
-      controller.instance_eval do
-        render(json: json, status: response_status)
-      end
+      controller.add_headers(headers)
+      controller.render_json(
+        model.decorate(resource),
+        status
+      )
     end
 
     private
@@ -141,5 +140,15 @@ module Azeroth
     def collection
       @collection = controller.send(model.plural)
     end
+
+    # @private
+    # @abstract
+    #
+    # Headers to be added
+    #
+    # @return [Hash]
+    def headers
+      {}
+    end
   end
 end

data/lib/azeroth/request_handler/create.rb

@@ -29,7 +29,7 @@ module Azeroth
       # @return [Object]
       def build_and_save_resource
         @resource = build_resource
-        controller.instance_variable_set("@#{model.name}", resource)
+        controller.set(model.name, resource)
 
         trigger_event(:save) do
           resource.tap(&:save)

data/lib/azeroth/request_handler/index.rb

@@ -21,6 +21,21 @@ module Azeroth
         paginated_entries
       end
 
+      # @private
+      #
+      # returns pagination headers
+      #
+      # @return [Hash] heders
+      def headers
+        return {} unless paginated?
+
+        {
+          pages: pages,
+          page: current_page,
+          per_page: limit
+        }
+      end
+
       # @private
       #
       # paginated collection of the model
@@ -39,8 +54,7 @@ module Azeroth
       #
       # @return [Integer]
       def offset
-        page = (params[:page] || 1).to_i - 1
-        page * limit
+        (current_page - 1) * limit
       end
 
       # @private
@@ -62,6 +76,24 @@ module Azeroth
       def scoped_entries
         controller.send(model.plural)
       end
+
+      # @private
+      #
+      # calculates current page
+      #
+      # @return [Integer]
+      def current_page
+        (params[:page] || 1).to_i
+      end
+
+      # @private
+      #
+      # calculates how many pages are there
+      #
+      # @return [Integer]
+      def pages
+        (scoped_entries.count.to_f / limit).ceil
+      end
     end
   end
 end

data/lib/azeroth/version.rb

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

data/spec/controllers/paginated_documents_controller_spec.rb

@@ -38,6 +38,18 @@ describe PaginatedDocumentsController do
         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
@@ -54,6 +66,18 @@ describe PaginatedDocumentsController 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
@@ -72,6 +96,18 @@ describe PaginatedDocumentsController do
             .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
@@ -91,6 +127,19 @@ describe PaginatedDocumentsController do
             .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

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/request_handler/index_spec.rb

@@ -14,6 +14,21 @@ describe Azeroth::RequestHandler::Index 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
@@ -22,6 +37,21 @@ describe Azeroth::RequestHandler::Index do
           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
 
@@ -31,6 +61,21 @@ describe Azeroth::RequestHandler::Index do
           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
 
@@ -39,15 +84,45 @@ describe Azeroth::RequestHandler::Index 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(15).limit(15) }
-          let(:options_hash)      { { paginated: true, per_page: 10 } }
-          let(:extra_params)      { { page: '2', per_page: '15' } }
+          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

data/spec/support/shared_examples/request_handler.rb

@@ -24,6 +24,8 @@ shared_examples 'a request handler' do |status: :ok|
     { format: format }.merge(extra_params)
   end
 
+  let(:controller_headers) { {} }
+
   before do
     create_list(:document, documents_count)
 
@@ -33,6 +35,9 @@ shared_examples 'a request handler' do |status: :ok|
     allow(controller).to receive(:render)
       .with(json: expected_json, status: status)
       .and_return(expected_json)
+
+    allow(controller).to receive(:headers)
+      .and_return(controller_headers)
   end
 
   it 'returns all documents json' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -456,6 +456,7 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/azeroth.rb
+- lib/azeroth/controller_interface.rb
 - lib/azeroth/decorator.rb
 - lib/azeroth/decorator/hash_builder.rb
 - lib/azeroth/decorator/key_value_extractor.rb
@@ -583,6 +584,7 @@ files:
 - spec/integration/readme/controllers/games_controller_spec.rb
 - spec/integration/yard/azeroth/decorator_spec.rb
 - spec/integration/yard/controllers/games_controller_spec.rb
+- spec/lib/azeroth/controller_interface_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator/key_value_extractor_spec.rb
 - spec/lib/azeroth/decorator/method_builder_spec.rb
@@ -748,6 +750,7 @@ test_files:
 - spec/integration/readme/controllers/games_controller_spec.rb
 - spec/integration/yard/azeroth/decorator_spec.rb
 - spec/integration/yard/controllers/games_controller_spec.rb
+- spec/lib/azeroth/controller_interface_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator/key_value_extractor_spec.rb
 - spec/lib/azeroth/decorator/method_builder_spec.rb