azeroth 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 197968637291c04e3ce145d6d5dd9f84451e4b47d104d420aef7c1a5e7b999dc
-  data.tar.gz: 9936013b82fcc56048027c6a469130bc15913e095c5373a9b3b50d577d2fcc93
+  metadata.gz: '09152b8053d40bd19405c5b7165458483d4304310fa5ec64c0d2b5723dda0067'
+  data.tar.gz: 1a1039542352929720e5cc7ae1242932b7d2a65856e2156b14a36d1a8bb1722b
 SHA512:
-  metadata.gz: d05f185b913c3ac80e58bfad3cdcfea1de68c4836251d5a121826961bf3779adc3e9b39e4dff6d92e72204a4bc8d355d063f0b910c4607dad17f741206a31149
-  data.tar.gz: 85e4d4c4625e36fd40358bf486e5bb2dd81fef82cc6fbf198545b6fdad51642d63d3ee5af2e828d0cf394ca0dfbf7aff5efd568634517a1c5236a79901275915
+  metadata.gz: 2ae5257e2851ccbbadbd79d9a0c0a13be63e392b2af16c6e1f66be399ee00bc51b06f9682f25d88648f3a32d2c07451d456d80035f04b48a4cc471d27a572e59
+  data.tar.gz: d7c01b81ce09615d65cc451d2a1669ac9d843d18d75fbb0c12c2e4356507fce62288145bd30295674619a0649327b1b69568fede8adb452e602073f67659235e

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.7.4](https://www.rubydoc.info/gems/azeroth/0.7.4)
+[https://www.rubydoc.info/gems/azeroth/0.8.0](https://www.rubydoc.info/gems/azeroth/0.8.0)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -61,6 +61,8 @@ It accepts options
 - before_save: Method/Proc to be ran before saving the resource on create or update
 - after_save: Method/Proc to be ran after saving the resource on create or update
 - build_with: Method/Block to be ran when building the reource on create
+- paginated: Flag when pagination should be applied
+- per_page: Number of items returned when pagination is active
 
 ```ruby
   # publishers_controller.rb

data/azeroth.gemspec

@@ -23,28 +23,30 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'jace',                '>= 0.0.3'
   gem.add_runtime_dependency 'sinclair',            '>= 1.6.7'
 
-  gem.add_development_dependency 'actionpack',               '~> 5.2.x'
-  gem.add_development_dependency 'activerecord',             '~> 5.2.x'
-  gem.add_development_dependency 'bundler',                  '1.16.1'
-  gem.add_development_dependency 'factory_bot',              '5.2.0'
-  gem.add_development_dependency 'nokogiri',                 '1.11.4'
-  gem.add_development_dependency 'pry',                      '0.12.2'
-  gem.add_development_dependency 'pry-nav',                  '0.3.0'
-  gem.add_development_dependency 'rails',                    '~> 5.2.x'
-  gem.add_development_dependency 'rails-controller-testing', '1.0.4'
-  gem.add_development_dependency 'rake',                     '13.0.3'
-  gem.add_development_dependency 'reek',                     '6.0.3'
-  gem.add_development_dependency 'rspec',                    '3.9.0'
-  gem.add_development_dependency 'rspec-core',               '3.9.3'
-  gem.add_development_dependency 'rspec-expectations',       '3.9.4'
-  gem.add_development_dependency 'rspec-mocks',              '3.9.1'
-  gem.add_development_dependency 'rspec-rails',              '3.9.0'
-  gem.add_development_dependency 'rspec-support',            '3.9.4'
-  gem.add_development_dependency 'rubocop',                  '0.80.1'
-  gem.add_development_dependency 'rubocop-rspec',            '1.38.1'
-  gem.add_development_dependency 'rubycritic',               '4.6.1'
-  gem.add_development_dependency 'simplecov',                '0.17.1'
-  gem.add_development_dependency 'sqlite3',                  '1.4.2'
-  gem.add_development_dependency 'yard',                     '0.9.26'
-  gem.add_development_dependency 'yardstick',                '0.9.9'
+  gem.add_development_dependency 'actionpack',                '~> 5.2.x'
+  gem.add_development_dependency 'activerecord',              '~> 5.2.x'
+  gem.add_development_dependency 'bundler',                   '1.16.1'
+  gem.add_development_dependency 'factory_bot',               '5.2.0'
+  gem.add_development_dependency 'nokogiri',                  '1.11.4'
+  gem.add_development_dependency 'pry',                       '0.12.2'
+  gem.add_development_dependency 'pry-nav',                   '0.3.0'
+  gem.add_development_dependency 'rails',                     '~> 5.2.x'
+  gem.add_development_dependency 'rails-controller-testing',  '1.0.4'
+  gem.add_development_dependency 'rake',                      '13.0.3'
+  gem.add_development_dependency 'reek',                      '6.0.3'
+  gem.add_development_dependency 'rspec',                     '3.9.0'
+  gem.add_development_dependency 'rspec-collection_matchers', '1.2.0'
+  gem.add_development_dependency 'rspec-core',                '3.9.3'
+  gem.add_development_dependency 'rspec-expectations',        '3.9.4'
+  gem.add_development_dependency 'rspec-mocks',               '3.9.1'
+  gem.add_development_dependency 'rspec-rails',               '3.9.0'
+  gem.add_development_dependency 'rspec-support',             '3.9.4'
+  gem.add_development_dependency 'rubocop',                   '0.80.1'
+  gem.add_development_dependency 'rubocop-rspec',             '1.38.1'
+  gem.add_development_dependency 'rubycritic',                '4.6.1'
+  gem.add_development_dependency 'shoulda-matchers',          '4.3.0'
+  gem.add_development_dependency 'simplecov',                 '0.17.1'
+  gem.add_development_dependency 'sqlite3',                   '1.4.2'
+  gem.add_development_dependency 'yard',                      '0.9.26'
+  gem.add_development_dependency 'yardstick',                 '0.9.9'
 end

data/lib/azeroth/decorator.rb

@@ -42,6 +42,7 @@ module Azeroth
   class Decorator
     autoload :HashBuilder,       'azeroth/decorator/hash_builder'
     autoload :KeyValueExtractor, 'azeroth/decorator/key_value_extractor'
+    autoload :MethodBuilder,     'azeroth/decorator/method_builder'
     autoload :Options,           'azeroth/decorator/options'
 
     class << self
@@ -228,9 +229,7 @@ module Azeroth
       def expose(attribute, **options_hash)
         options = Decorator::Options.new(options_hash)
 
-        builder = Sinclair.new(self)
-        builder.add_method(attribute, "@object.#{attribute}")
-        builder.build
+        MethodBuilder.build_reader(self, attribute)
 
         attributes_map[attribute] = options
       end

data/lib/azeroth/decorator/method_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  class Decorator
+    # Responsible for building readers for attributes
+    # @api private
+    class MethodBuilder < Sinclair
+      # Builds reader
+      #
+      # reaader delegate method calls to @object
+      #
+      # @return (see Sinclair#build)
+      def self.build_reader(klass, attribute)
+        new(klass).build_reader(attribute)
+      end
+
+      # (see MethodBuilder.build_reader)
+      def build_reader(attribute)
+        add_method(attribute, "@object.#{attribute}")
+        build
+      end
+    end
+  end
+end

data/lib/azeroth/options.rb

@@ -20,7 +20,9 @@ module Azeroth
       decorator: true,
       before_save: nil,
       after_save: nil,
-      build_with: nil
+      build_with: nil,
+      paginated: false,
+      per_page: 20
     }.freeze
 
     with_options DEFAULT_OPTIONS
@@ -46,6 +48,13 @@ module Azeroth
       )
     end
 
+    alias paginated? paginated
+    # @method paginated?
+    # @api private
+    #
+    # @see paginated
+    # @return [TrueClass,FalseClass]
+
     # @method only
     # @api private
     #
@@ -100,5 +109,19 @@ module Azeroth
     # Block or method name to be ran when building the resource
     #
     # @return [Symbol,Proc]
+
+    # @method paginated
+    # @api private
+    #
+    # Boolean indicating if pagination should or not be used
+    #
+    # @return [TrueClass,FalseClass]
+
+    # @method per_page
+    # @api private
+    #
+    # Number of elements when pagination is active
+    #
+    # @return [Integer]
   end
 end

data/lib/azeroth/request_handler/index.rb

@@ -8,12 +8,58 @@ module Azeroth
     class Index < RequestHandler
       private
 
+      delegate :paginated?, :per_page, to: :options
+
       # @private
       #
       # return a collection of the model
       #
       # @return [Enumerable<Object>]
       def resource
+        return scoped_entries unless paginated?
+
+        paginated_entries
+      end
+
+      # @private
+      #
+      # paginated collection of the model
+      #
+      # @return [Enumerable<Object>]
+      def paginated_entries
+        scoped_entries.offset(offset).limit(limit)
+      end
+
+      # @private
+      #
+      # offest used in pagination
+      #
+      # offset is retrieved from +params[:per_page]+
+      # or +options.per_page+
+      #
+      # @return [Integer]
+      def offset
+        page = (params[:page] || 1).to_i - 1
+        page * limit
+      end
+
+      # @private
+      #
+      # limit used in pagination
+      #
+      # limit is retrieved from +params[:page]+
+      #
+      # @return [Integer]
+      def limit
+        (params[:per_page] || per_page).to_i
+      end
+
+      # @private
+      #
+      # default scope of elements
+      #
+      # @return [Enumerable<Object>]
+      def scoped_entries
         controller.send(model.plural)
       end
     end

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '0.7.4'
+  VERSION = '0.8.0'
 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,97 @@
+# 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
+      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
+      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
+      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
+      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/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/index_spec.rb

@@ -8,5 +8,48 @@ 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 } }
+      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' } }
+        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' } }
+        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 } }
+        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' } }
+        end
+      end
+    end
   end
 end

data/spec/lib/azeroth/request_handler_spec.rb

@@ -34,7 +34,7 @@ describe Azeroth::RequestHandler do
     end
 
     before do
-      documents_count.times { create(:document) }
+      create_list(:document, documents_count)
 
       allow(controller).to receive(:params)
         .and_return(params)

data/spec/spec_helper.rb

@@ -18,6 +18,8 @@ require File.expand_path('spec/dummy/db/schema.rb')
 require 'rspec/rails'
 require 'active_support/railtie'
 require 'sinclair/matchers'
+require 'shoulda-matchers'
+require 'rspec/collection_matchers'
 
 support_files = File.expand_path('spec/support/**/*.rb')
 Dir[support_files].sort.each { |file| require file }

data/spec/support/shared_examples/request_handler.rb

@@ -25,7 +25,7 @@ shared_examples 'a request handler' do |status: :ok|
   end
 
   before do
-    documents_count.times { create(:document) }
+    create_list(:document, documents_count)
 
     allow(controller).to receive(:params)
       .and_return(params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,6 +234,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -346,6 +360,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.6.1
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -431,6 +459,7 @@ files:
 - lib/azeroth/decorator.rb
 - lib/azeroth/decorator/hash_builder.rb
 - lib/azeroth/decorator/key_value_extractor.rb
+- lib/azeroth/decorator/method_builder.rb
 - lib/azeroth/decorator/options.rb
 - lib/azeroth/dummy_decorator.rb
 - lib/azeroth/model.rb
@@ -452,6 +481,7 @@ files:
 - spec/controllers/documents_controller_spec.rb
 - spec/controllers/documents_with_error_controller_spec.rb
 - spec/controllers/index_documents_controller_spec.rb
+- spec/controllers/paginated_documents_controller_spec.rb
 - spec/controllers/pokemon_masters_controller_spec.rb
 - spec/controllers/pokemons_controller_spec.rb
 - spec/dummy/.ruby-version
@@ -470,6 +500,7 @@ files:
 - spec/dummy/app/controllers/documents_with_error_controller.rb
 - spec/dummy/app/controllers/games_controller.rb
 - spec/dummy/app/controllers/index_documents_controller.rb
+- spec/dummy/app/controllers/paginated_documents_controller.rb
 - spec/dummy/app/controllers/pokemon_masters_controller.rb
 - spec/dummy/app/controllers/pokemons_controller.rb
 - spec/dummy/app/controllers/publishers_controller.rb
@@ -554,6 +585,7 @@ files:
 - spec/integration/yard/controllers/games_controller_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
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
@@ -614,6 +646,7 @@ test_files:
 - spec/controllers/documents_controller_spec.rb
 - spec/controllers/documents_with_error_controller_spec.rb
 - spec/controllers/index_documents_controller_spec.rb
+- spec/controllers/paginated_documents_controller_spec.rb
 - spec/controllers/pokemon_masters_controller_spec.rb
 - spec/controllers/pokemons_controller_spec.rb
 - spec/dummy/.ruby-version
@@ -632,6 +665,7 @@ test_files:
 - spec/dummy/app/controllers/documents_with_error_controller.rb
 - spec/dummy/app/controllers/games_controller.rb
 - spec/dummy/app/controllers/index_documents_controller.rb
+- spec/dummy/app/controllers/paginated_documents_controller.rb
 - spec/dummy/app/controllers/pokemon_masters_controller.rb
 - spec/dummy/app/controllers/pokemons_controller.rb
 - spec/dummy/app/controllers/publishers_controller.rb
@@ -716,6 +750,7 @@ test_files:
 - spec/integration/yard/controllers/games_controller_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
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb