azeroth 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b05d8bcf76fadc6b48d87c98c5523a21e5cdb68857d0ba42d99e5e2b1c3ec41b
-  data.tar.gz: f3e65b23e171f6c63ae143bb2a47aa7100a11ee29fdde85dd7938d5ba2a62408
+  metadata.gz: bcc284d1b166fec28f03e31cd42642ad09a86c85a81718ba401531443b1bbc08
+  data.tar.gz: 335851aa5d9a160cf387971e904248c2f89041594ccdaec57fa9ab130624558f
 SHA512:
-  metadata.gz: 1807ceb2a7450f2d469d9232d3c3fb36ebcb7b8942b1309a7ba8686a30bebc1074598b649820d94553be4917ce15aeb2b0a919b7f2eb1a4e361bd159a50751fa
-  data.tar.gz: 76992063fb6218ef13ebbf38416b8165b7f79bb69bb1f56330dc0c5d66cb8186394509e8b52fa7aa4c3d6f950db031692139f315cd126aa2c44b1c57ab511894
+  metadata.gz: 7ef7afcbd3282d181339fa6f154d1b4dcb6c6bad00f7c4e33e5c0b912b55eecc7de9876e44d2d54e7709a006a7cef487ee6c057dc0645bc0e336ff2b70629fdf
+  data.tar.gz: d37ba6ffdfe83b55fd51f103fd9ba3f35a3edf5eb0121c5aab424da29ffcce3e7850d52acdb4c41097c773d2f5b56692dc5f0e6c751ebce1651153bde42f2e1d

data/.circleci/config.yml

@@ -22,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:1.0.0
+      - image: darthjee/circleci_rails_gems:1.1.0
         environment:
           PROJECT: azeroth
     steps:
@@ -41,7 +41,7 @@ jobs:
           command: cc-test-reporter after-build --exit-code $?
   checks:
     docker:
-      - image: darthjee/circleci_rails_gems:1.0.0
+      - image: darthjee/circleci_rails_gems:1.1.0
         environment:
           PROJECT: azeroth
     steps:
@@ -66,7 +66,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:1.0.0
+      - image: darthjee/circleci_rails_gems:1.1.0
         environment:
           PROJECT: azeroth
     steps:

data/Dockerfile

@@ -1,12 +1,14 @@
-FROM darthjee/rails_gems:1.0.0 as base
-FROM darthjee/scripts:0.1.8 as scripts
+FROM darthjee/scripts:0.3.1 as scripts
+
+FROM darthjee/rails_gems:1.1.0 as base
+
+COPY --chown=app:app ./ /home/app/app/
 
 ######################################
 
 FROM base as builder
 
-COPY --chown=app ./ /home/app/app/
-COPY --chown=app:app --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/
+COPY --chown=app:app --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/bundle_builder.sh
 
 ENV HOME_DIR /home/app
 RUN bundle_builder.sh
@@ -14,11 +16,6 @@ RUN bundle_builder.sh
 #######################
 #FINAL IMAGE
 FROM base
-RUN mkdir lib/azeroth -p
 
 COPY --chown=app:app --from=builder /home/app/bundle/ /usr/local/bundle/
-
-COPY --chown=app ./*.gemspec ./Gemfile /home/app/app/
-COPY --chown=app ./lib/azeroth/version.rb /home/app/app/lib/azeroth/
-
 RUN bundle install

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.10.0](https://www.rubydoc.info/gems/azeroth/0.10.0)
+[https://www.rubydoc.info/gems/azeroth/0.10.1](https://www.rubydoc.info/gems/azeroth/0.10.1)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -172,6 +172,35 @@ defining which and how fields will be exposed
   end
 ```
 
+```ruby
+  class PaginatedDocumentsController < ApplicationController
+    include Azeroth::Resourceable
+
+    resource_for :document, only: 'index', paginated: true
+  end
+
+  30.times { create(:document) }
+
+  get '/paginated_documents.json'
+
+  # returns Array with 20 first documents
+  # returns in the headers pagination headers
+  {
+    'pages' => 2,
+    'per_page' => 20,
+    'page' => 1
+  }
+
+  get '/paginated_documents.json?page=2'
+
+  # returns Array with 10 next documents
+  # returns in the headers pagination headers
+  {
+    'pages' => 2,
+    'per_page' => 20,
+    'page' => 2
+  }
+```
 Exposing is done through the class method
 [expose](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator#expose-class_method)
 which accepts several options:

data/azeroth.gemspec

@@ -20,19 +20,19 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport',       '~> 5.2.x'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'jace',                '>= 0.0.3'
+  gem.add_runtime_dependency 'jace',                '>= 0.1.1'
   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 'actionpack',                '5.2.8.1'
+  gem.add_development_dependency 'activerecord',              '5.2.8.1'
   gem.add_development_dependency 'bundler',                   '~> 2.3.14'
   gem.add_development_dependency 'factory_bot',               '6.2.1'
-  gem.add_development_dependency 'minitest',                  '~> 5.15.0'
+  gem.add_development_dependency 'minitest',                  '5.16.2'
   gem.add_development_dependency 'nokogiri',                  '1.13.6'
   gem.add_development_dependency 'pry',                       '0.14.1'
   gem.add_development_dependency 'pry-nav',                   '1.0.0'
-  gem.add_development_dependency 'rails',                     '~> 5.2.x'
-  gem.add_development_dependency 'rails-controller-testing',  '1.0.4'
+  gem.add_development_dependency 'rails',                     '5.2.8.1'
+  gem.add_development_dependency 'rails-controller-testing',  '1.0.5'
   gem.add_development_dependency 'rake',                      '13.0.6'
   gem.add_development_dependency 'reek',                      '6.0.3'
   gem.add_development_dependency 'rspec',                     '3.11.0'
@@ -44,7 +44,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-support',             '3.11.0'
   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 'rubycritic',                '4.7.0'
   gem.add_development_dependency 'shoulda-matchers',          '4.3.0'
   gem.add_development_dependency 'simplecov',                 '0.21.2'
   gem.add_development_dependency 'sqlite3',                   '1.4.2'

data/config/yardstick.yml

@@ -31,6 +31,7 @@ rules:
       - Azeroth::Exception::InvalidOptions#initialize
       - Azeroth::Model#initialize
       - Azeroth::Options#initialize
+      - Azeroth::ParamsBuilder#initialize
       - Azeroth::RequestHandler#initialize
       - Azeroth::ResourceBuilder#initialize
       - Azeroth::ResourceRouteBuilder#initialize

data/docker-compose.yml

@@ -21,11 +21,3 @@ services:
     <<: *base
     depends_on: [base_build]
     command: /bin/bash -c 'rspec && yard && rake yardstick_measure && rake verify_measurements'
-
-  circleci:
-    image: azeroth_circleci
-    build:
-      context: ./
-      dockerfile: Dockerfile.circleci
-    volumes:
-      - .:/home/circleci/project

data/lib/azeroth/options.rb

@@ -35,18 +35,13 @@ module Azeroth
       [only].flatten.map(&:to_sym) - [except].flatten.map(&:to_sym)
     end
 
-    # Returns event dispatcher
-    #
-    # Event dispatcher is responsible for
-    # sending events such as +before_save+
-    # to it's correct calling point
-    #
-    # @return [Jace::Dispatcher]
-    def event_dispatcher(event)
-      Jace::Dispatcher.new(
-        before: try("before_#{event}"),
-        after: try("after_#{event}")
-      )
+    # Returns the event registry
+    #
+    # Event registry is used to handle events within the request
+    #
+    # @return [Jace::Registry]
+    def event_registry
+      @event_registry ||= build_event_registry
     end
 
     alias paginated? paginated
@@ -131,5 +126,22 @@ module Azeroth
     # Number of elements when pagination is active
     #
     # @return [Integer]
+
+    private
+
+    # private
+    #
+    # Builds the event registr
+    #
+    # The event registry is build using the before
+    # and after actions defined in optionsy
+    #
+    # @return [Jace::Registry]
+    def build_event_registry
+      Jace::Registry.new.tap do |registry|
+        registry.register(:save, :after, &after_save)
+        registry.register(:save, :before, &before_save)
+      end
+    end
   end
 end

data/lib/azeroth/params_builder.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Class responsible for adding params handling methods to a controller
+  class ParamsBuilder
+    # @param model [Model] resource interface
+    # @param builder [Sinclair] methods builder
+    def initialize(model, builder)
+      @model = model
+      @builder = builder
+    end
+
+    # Append the params methods to be built
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+    def append
+      method_name = name
+      allowed_attributes = permitted_attributes.map(&:to_sym)
+
+      add_method("#{name}_id") { params.require(:id) }
+      add_method("#{name}_params") do
+        params.require(method_name)
+              .permit(*allowed_attributes)
+      end
+    end
+
+    attr_reader :model, :builder
+    # @method model
+    # @api private
+    # @private
+    #
+    # Resource interface
+    #
+    # @return [Model]
+
+    # @method builder
+    # @api private
+    # @private
+    #
+    # Methods builder
+    #
+    # @return [Sinclair]
+
+    delegate :add_method, to: :builder
+    # @method add_method
+    # @api private
+    # @private
+    #
+    # Appends a method
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+
+    delegate :name, :klass, to: :model
+    # @method name
+    # @api private
+    # @private
+    #
+    # Resource name
+    #
+    # @return [Symbol,String]
+
+    # @method klass
+    # @api private
+    # @private
+    #
+    # Controller to be changed
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+
+    # Returns all updatable attributes
+    #
+    # @return [Array<String>]
+    def permitted_attributes
+      @permitted_attributes ||= klass.attribute_names - ['id']
+    end
+  end
+end

data/lib/azeroth/request_handler/update.rb

@@ -36,7 +36,9 @@ module Azeroth
 
       # @private
       #
-      # Update the resource, either by running update_with
+      # Update the resource
+      #
+      # This update happens by either by running update_with
       # or directly updating the attributes in the object
       #
       # @return [Object] updated resource

data/lib/azeroth/request_handler.rb

@@ -119,8 +119,7 @@ module Azeroth
     #
     # @return [Object] Result of given block
     def trigger_event(event, &block)
-      options.event_dispatcher(event)
-             .dispatch(controller, &block)
+      options.event_registry.trigger(event, controller, &block)
     end
 
     # @private

data/lib/azeroth/resourceable/builder.rb

@@ -71,7 +71,7 @@ module Azeroth
       #
       # @return [Array<Sinclair::MethodDefinition>]
 
-      delegate :name, :klass, to: :model
+      delegate :name, to: :model
       # @method name
       # @api private
       # @private
@@ -80,14 +80,6 @@ module Azeroth
       #
       # @return [Symbol,String]
 
-      # @method klass
-      # @api private
-      # @private
-      #
-      # Controller to be changed
-      #
-      # @return [Array<Sinclair::MethodDefinition>]
-
       # @api private
       # @private
       #
@@ -104,14 +96,7 @@ module Azeroth
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_params
-        add_method("#{name}_id", 'params.require(:id)')
-        add_method(
-          "#{name}_params",
-          <<-CODE
-            params.require(:#{name})
-              .permit(:#{permitted_attributes.join(', :')})
-          CODE
-        )
+        ParamsBuilder.new(model, builder).append
       end
 
       # Add methods for resource fetching
@@ -135,13 +120,6 @@ module Azeroth
         clazz.public_send(:helper_method, model.name)
         clazz.public_send(:helper_method, model.plural)
       end
-
-      # Returns all updatable attributes
-      #
-      # @return [Array<String>]
-      def permitted_attributes
-        @permitted_attributes ||= klass.attribute_names - ['id']
-      end
     end
   end
 end

data/lib/azeroth/resourceable/class_methods.rb

@@ -14,136 +14,7 @@ module Azeroth
       # @return (see Resourceable.resource_for)
       #
       # @see (see Resourceable.resource_for)
-      #
-      # @example Controller without delete
-      #   class DocumentsController < ApplicationController
-      #     include Azeroth::Resourceable
-      #
-      #     resource_for :document, except: :delete
-      #   end
-      #
-      # @example Controller with only create, show and list
-      #   class DocumentsController < ApplicationController
-      #     include Azeroth::Resourceable
-      #
-      #     resource_for :document, only: %w[create index show]
-      #   end
-      #
-      # @example complete example gmaes and publishers
-      #   class PublishersController < ApplicationController
-      #     include Azeroth::Resourceable
-      #     skip_before_action :verify_authenticity_token
-      #
-      #     resource_for :publisher, only: %i[create index]
-      #   end
-      #
-      #   class GamesController < ApplicationController
-      #     include Azeroth::Resourceable
-      #     skip_before_action :verify_authenticity_token
-      #
-      #     resource_for :game, except: :delete
-      #
-      #     private
-      #
-      #     def games
-      #       publisher.games
-      #     end
-      #
-      #     def publisher
-      #       @publisher ||= Publisher.find(publisher_id)
-      #     end
-      #
-      #     def publisher_id
-      #       params.require(:publisher_id)
-      #     end
-      #   end
-      #
-      #   ActiveRecord::Schema.define do
-      #     self.verbose = false
-      #
-      #     create_table :publishers, force: true do |t|
-      #       t.string :name
-      #     end
-      #
-      #     create_table :games, force: true do |t|
-      #       t.string :name
-      #       t.integer :publisher_id
-      #     end
-      #    end
-      #
-      #   class Publisher < ActiveRecord::Base
-      #     has_many :games
-      #   end
-      #
-      #   class Game < ActiveRecord::Base
-      #     belongs_to :publisher
-      #   end
-      #
-      #   class Game::Decorator < Azeroth::Decorator
-      #     expose :id
-      #     expose :name
-      #     expose :publisher, decorator: NameDecorator
-      #   end
-      #
-      # @example requesting games and publishers
-      #   post "/publishers.json", params: {
-      #     publisher: {
-      #       name: 'Nintendo'
-      #     }
-      #   }
-      #
-      #   publisher = JSON.parse(response.body)
-      #   # returns
-      #   # {
-      #   #   'id' => 11,
-      #   #   'name' => 'Nintendo'
-      #   # }
-      #
-      #   publisher = Publisher.last
-      #   post "/publishers/#{publisher['id']}/games.json", params: {
-      #     game: {
-      #       name: 'Pokemon'
-      #     }
-      #   }
-      #
-      #   game = Game.last
-      #
-      #   JSON.parse(response.body)
-      #   # returns
-      #   # {
-      #   #   id: game.id,
-      #   #   name: 'Pokemon',
-      #   #   publisher: {
-      #   #     name: 'Nintendo'
-      #   # }
-      #   }
-      #
-      # @example Controller with before_save
-      #   class PokemonsController < ApplicationController
-      #     include Azeroth::Resourceable
-      #
-      #     resource_for :pokemon,
-      #                  only: %i[create update],
-      #                  before_save: :set_favorite
-      #
-      #     private
-      #
-      #     def set_favorite
-      #       pokemon.favorite = true
-      #     end
-      #
-      #     def pokemons
-      #       master.pokemons
-      #     end
-      #
-      #     def master
-      #       @master ||= PokemonMaster.find(master_id)
-      #     end
-      #
-      #     def master_id
-      #       params.require(:pokemon_master_id)
-      #     end
-      #   end
+      # @example (see Resourceable.resource_for)
       def resource_for(name, **options)
         Builder.new(
           self, name, Azeroth::Options.new(options)

data/lib/azeroth/resourceable.rb

@@ -8,8 +8,6 @@ module Azeroth
   #
   # Concern for building controller methods for the routes
   #
-  # @example (see Resourceable::ClassMethods#resource_for)
-  #
   # @see Resourceable::ClassMethods
   module Resourceable
     extend ActiveSupport::Concern
@@ -27,21 +25,190 @@ module Azeroth
       #
       # @param name [String, Symbol] Name of the resource
       # @param options [Hash] resource building options
-      # @option options only [Array<Symbol,String>] List of
+      # @option options only [Array<Symbol,String>,Symbol,String] List of
       #   actions to be built
-      # @option options except [Array<Symbol,String>] List of
+      # @option options except [Array<Symbol,String>,Symbol,String] List of
       #   actions to not to be built
       # @option options decorator [Azeroth::Decorator,TrueClass,FalseClass]
       #   Decorator class or flag allowing/disallowing decorators
       # @option options before_save [Symbol,Proc] method/block
       #   to be ran on the controller before saving the resource
+      # @option options after_save [Symbol,Proc] method/block
+      #   to be ran on the controller after saving the resource
       # @option options build_with [Symbol,Proc] method/block
       #   to be ran when building resource
       #   (default proc { <resource_collection>.build(resource_params) }
+      # @option options update_with [Symbol,Proc] method/block
+      #   to be ran when updating resource
+      #   (default proc { <resource>.update(resource_params) }
+      # @option options paginated [TrueClass,FalseClass] flag defining if index
+      #   endpoint should be paginated
+      # @option options per_page [Integer] number of entries returned per
+      #   page on index
       #
       # @return [Array<MethodDefinition>] list of methods created
       #
       # @see Options::DEFAULT_OPTIONS
+      #
+      # @example Controller without delete
+      #   class DocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document, except: :delete
+      #   end
+      #
+      # @example Controller with only create, show and list
+      #   class DocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document, only: %w[create index show]
+      #   end
+      #
+      # @example complete example gmaes and publishers
+      #   class PublishersController < ApplicationController
+      #     include Azeroth::Resourceable
+      #     skip_before_action :verify_authenticity_token
+      #
+      #     resource_for :publisher, only: %i[create index]
+      #   end
+      #
+      #   class GamesController < ApplicationController
+      #     include Azeroth::Resourceable
+      #     skip_before_action :verify_authenticity_token
+      #
+      #     resource_for :game, except: :delete
+      #
+      #     private
+      #
+      #     def games
+      #       publisher.games
+      #     end
+      #
+      #     def publisher
+      #       @publisher ||= Publisher.find(publisher_id)
+      #     end
+      #
+      #     def publisher_id
+      #       params.require(:publisher_id)
+      #     end
+      #   end
+      #
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #     create_table :publishers, force: true do |t|
+      #       t.string :name
+      #     end
+      #
+      #     create_table :games, force: true do |t|
+      #       t.string :name
+      #       t.integer :publisher_id
+      #     end
+      #    end
+      #
+      #   class Publisher < ActiveRecord::Base
+      #     has_many :games
+      #   end
+      #
+      #   class Game < ActiveRecord::Base
+      #     belongs_to :publisher
+      #   end
+      #
+      #   class Game::Decorator < Azeroth::Decorator
+      #     expose :id
+      #     expose :name
+      #     expose :publisher, decorator: NameDecorator
+      #   end
+      #
+      # @example requesting games and publishers
+      #   post "/publishers.json", params: {
+      #     publisher: {
+      #       name: 'Nintendo'
+      #     }
+      #   }
+      #
+      #   publisher = JSON.parse(response.body)
+      #   # returns
+      #   # {
+      #   #   'id' => 11,
+      #   #   'name' => 'Nintendo'
+      #   # }
+      #
+      #   publisher = Publisher.last
+      #   post "/publishers/#{publisher['id']}/games.json", params: {
+      #     game: {
+      #       name: 'Pokemon'
+      #     }
+      #   }
+      #
+      #   game = Game.last
+      #
+      #   JSON.parse(response.body)
+      #   # returns
+      #   # {
+      #   #   id: game.id,
+      #   #   name: 'Pokemon',
+      #   #   publisher: {
+      #   #     name: 'Nintendo'
+      #   #   }
+      #   # }
+      #
+      # @example Controller with before_save
+      #   class PokemonsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :pokemon,
+      #                  only: %i[create update],
+      #                  before_save: :set_favorite
+      #
+      #     private
+      #
+      #     def set_favorite
+      #       pokemon.favorite = true
+      #     end
+      #
+      #     def pokemons
+      #       master.pokemons
+      #     end
+      #
+      #     def master
+      #       @master ||= PokemonMaster.find(master_id)
+      #     end
+      #
+      #     def master_id
+      #       params.require(:pokemon_master_id)
+      #     end
+      #   end
+      #
+      # @example Controller with paginated index response
+      #
+      #   class PaginatedDocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document, only: 'index', paginated: true
+      #   end
+      #
+      #   30.times { create(:document) }
+      #
+      #   get '/paginated_documents.json'
+      #
+      #   # returns Array with 20 first documents
+      #   # returns in the headers pagination headers
+      #   {
+      #     'pages' => 2,
+      #     'per_page' => 20,
+      #     'page' => 1
+      #   }
+      #
+      #   get '/paginated_documents.json?page=2'
+      #
+      #   # returns Array with 10 next documents
+      #   # returns in the headers pagination headers
+      #   {
+      #     'pages' => 2,
+      #     'per_page' => 20,
+      #     'page' => 2
+      #   }
     end
 
     private

data/lib/azeroth/version.rb

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

data/lib/azeroth.rb

@@ -15,6 +15,7 @@ module Azeroth
   autoload :Decorator,           'azeroth/decorator'
   autoload :DummyDecorator,      'azeroth/dummy_decorator'
   autoload :Model,               'azeroth/model'
+  autoload :ParamsBuilder,       'azeroth/params_builder'
   autoload :RequestHandler,      'azeroth/request_handler'
   autoload :Resourceable,        'azeroth/resourceable'
   autoload :ResourceBuilder,     'azeroth/resource_builder'

data/spec/dummy/app/models/movie/simple_decorator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Movie
+  class SimpleDecorator < Azeroth::Decorator
+    expose :name
+  end
+end

data/spec/dummy/app/models/movie.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Movie < ActiveRecord::Base
+  validates :name, :director, presence: true
+end

data/spec/dummy/db/schema.rb

@@ -47,5 +47,10 @@ ActiveRecord::Schema.define do
     t.index %i[pokemon_master_id favorite], unique: true
   end
 
+  create_table :movies, force: true do |t|
+    t.string :name, null: false
+    t.string :director, null: false
+  end
+
   add_foreign_key 'pokemons', 'pokemon_masters'
 end

data/spec/integration/yard/controllers/paginated_documents_controller_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaginatedDocumentsController, controller: true do
+  describe 'yard' do
+    describe 'GET index' do
+      before { create_list(:document, 30) }
+
+      it 'list documents with pagination page' do
+        get '/paginated_documents.json'
+
+        documents = JSON.parse(response.body)
+        expect(documents)
+          .to have(20).items
+
+        expect(response.headers['pages']).to eq(2)
+        expect(response.headers['per_page']).to eq(20)
+        expect(response.headers['page']).to eq(1)
+
+        get '/paginated_documents.json?page=2'
+
+        documents = JSON.parse(response.body)
+        expect(documents)
+          .to have(10).items
+
+        expect(response.headers['pages']).to eq(2)
+        expect(response.headers['per_page']).to eq(20)
+        expect(response.headers['page']).to eq(2)
+      end
+    end
+  end
+end

data/spec/lib/azeroth/params_builder_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::ParamsBuilder do
+  subject(:params_builder) { described_class.new(model, builder) }
+
+  let(:model)   { Azeroth::Model.new(:document, options) }
+  let(:options) { Azeroth::Options.new }
+  let(:builder) { Sinclair.new(klass) }
+  let(:klass)   { Class.new(ParamsBuilderController) }
+
+  before do
+    params_builder.append
+  end
+
+  describe '#append' do
+    it 'adds id method' do
+      expect { builder.build }
+        .to add_method(:document_id).to(klass)
+    end
+
+    it 'adds params method' do
+      expect { builder.build }
+        .to add_method(:document_params).to(klass)
+    end
+
+    describe 'after the build' do
+      let(:controller) { klass.new(id, attributes) }
+      let(:document)   { create(:document) }
+      let(:attributes) { document.attributes }
+      let(:id)         { Random.rand(10..100) }
+      let(:expected_attributes) do
+        {
+          'name' => document.name,
+          'reference' => document.reference
+        }
+      end
+
+      before { builder.build }
+
+      context 'when requesting id' do
+        it 'returns id from request path' do
+          expect(controller.document_id).to eq(id)
+        end
+      end
+
+      context 'when requesting params' do
+        it 'returns payload' do
+          expect(controller.document_params.to_h)
+            .to eq(expected_attributes)
+        end
+      end
+    end
+  end
+end

data/spec/lib/azeroth/resourceable_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Resourceable do
+  let(:controller_class) do
+    Class.new(Controller) do
+      include Azeroth::Resourceable
+    end
+  end
+
+  describe '.resource_for' do
+    let(:params)     { { id: model.id, format: :json } }
+    let(:model_name) { :document }
+    let(:model)      { create(model_name) }
+    let(:controller) { controller_class.new(params) }
+    let(:decorator)  { Document::Decorator }
+
+    context 'when no special option is given' do
+      %i[index show new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing the only option' do
+      let(:options) { { only: %i[index show] } }
+
+      %i[index show].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+
+      %i[new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .not_to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing the except option' do
+      let(:options) { { except: %i[index show] } }
+
+      %i[index show].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .not_to add_method(method_name).to(controller_class)
+        end
+      end
+
+      %i[new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing decorator option' do
+      let(:model_name) { :movie }
+      let(:decorator)  { Movie::SimpleDecorator }
+      let(:rendered)   { {} }
+
+      before do
+        controller_class.resource_for(model_name, decorator: decorator)
+
+        allow(controller).to receive(:render) do |args|
+          rendered.merge!(args[:json])
+        end
+      end
+
+      it 'decorates the model' do
+        controller.show
+        expect(rendered).to eq(decorator.new(model).as_json)
+      end
+    end
+
+    context 'when the method is called' do
+      let(:rendered) { {} }
+
+      before do
+        controller_class.resource_for(model_name)
+        allow(controller).to receive(:render) do |args|
+          rendered.merge!(args[:json])
+        end
+      end
+
+      it 'decorates the model' do
+        controller.show
+        expect(rendered).to eq(decorator.new(model).as_json)
+      end
+
+      context 'when the model does not have a decorator' do
+        let(:model_name) { :movie }
+
+        it 'renders model as json' do
+          controller.show
+          expect(rendered).to eq(model.as_json)
+        end
+      end
+    end
+  end
+end

data/spec/support/app/controllers/controller.rb

@@ -2,7 +2,7 @@
 
 require 'action_controller'
 
-class Controller
+class Controller < ActionController::Base
   def initialize(params = {})
     @params = ActionController::Parameters.new(params)
   end

data/spec/support/app/controllers/params_builder_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ParamsBuilderController
+  def initialize(id, attributes)
+    @params = ActionController::Parameters.new(
+      id: id,
+      document: attributes
+    )
+  end
+
+  private
+
+  attr_reader :params
+end

data/spec/support/factories/movie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :movie, class: '::Movie' do
+    sequence(:name)     { |n| "Name-#{n}" }
+    sequence(:director) { |n| "Director-#{n}" }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: sinclair
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +70,30 @@ dependencies:
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.16.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.16.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -182,30 +182,30 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
   name: rails-controller-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -366,14 +366,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.6.1
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.6.1
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -471,7 +471,6 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Dockerfile
-- Dockerfile.circleci
 - Gemfile
 - LICENSE
 - README.md
@@ -494,6 +493,7 @@ files:
 - lib/azeroth/dummy_decorator.rb
 - lib/azeroth/model.rb
 - lib/azeroth/options.rb
+- lib/azeroth/params_builder.rb
 - lib/azeroth/request_handler.rb
 - lib/azeroth/request_handler/create.rb
 - lib/azeroth/request_handler/destroy.rb
@@ -551,6 +551,8 @@ files:
 - spec/dummy/app/models/game.rb
 - spec/dummy/app/models/game/decorator.rb
 - spec/dummy/app/models/id_decorator.rb
+- spec/dummy/app/models/movie.rb
+- spec/dummy/app/models/movie/simple_decorator.rb
 - spec/dummy/app/models/name_decorator.rb
 - spec/dummy/app/models/pokemon.rb
 - spec/dummy/app/models/pokemon/decorator.rb
@@ -617,6 +619,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/integration/yard/controllers/paginated_documents_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
@@ -625,6 +628,7 @@ files:
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/options_spec.rb
+- spec/lib/azeroth/params_builder_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb
 - spec/lib/azeroth/request_handler/destroy_spec.rb
 - spec/lib/azeroth/request_handler/edit_spec.rb
@@ -635,9 +639,11 @@ files:
 - spec/lib/azeroth/request_handler_spec.rb
 - spec/lib/azeroth/resource_builder_spec.rb
 - spec/lib/azeroth/resourceable/builder_spec.rb
+- spec/lib/azeroth/resourceable_spec.rb
 - spec/lib/azeroth/routes_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/app/controllers/controller.rb
+- spec/support/app/controllers/params_builder_controller.rb
 - spec/support/app/controllers/request_handler_controller.rb
 - spec/support/app/controllers/resource_builder_controller.rb
 - spec/support/app/controllers/resource_route_builder_controller.rb
@@ -646,6 +652,7 @@ files:
 - spec/support/factories/dummy_model.rb
 - spec/support/factories/factory.rb
 - spec/support/factories/game.rb
+- spec/support/factories/movie.rb
 - spec/support/factories/pokemon.rb
 - spec/support/factories/pokemon_master.rb
 - spec/support/factories/product.rb
@@ -672,7 +679,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.20
 signing_key: 
 specification_version: 4
 summary: Azeroth
@@ -720,6 +727,8 @@ test_files:
 - spec/dummy/app/models/game.rb
 - spec/dummy/app/models/game/decorator.rb
 - spec/dummy/app/models/id_decorator.rb
+- spec/dummy/app/models/movie.rb
+- spec/dummy/app/models/movie/simple_decorator.rb
 - spec/dummy/app/models/name_decorator.rb
 - spec/dummy/app/models/pokemon.rb
 - spec/dummy/app/models/pokemon/decorator.rb
@@ -786,6 +795,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/integration/yard/controllers/paginated_documents_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
@@ -794,6 +804,7 @@ test_files:
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/options_spec.rb
+- spec/lib/azeroth/params_builder_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb
 - spec/lib/azeroth/request_handler/destroy_spec.rb
 - spec/lib/azeroth/request_handler/edit_spec.rb
@@ -804,9 +815,11 @@ test_files:
 - spec/lib/azeroth/request_handler_spec.rb
 - spec/lib/azeroth/resource_builder_spec.rb
 - spec/lib/azeroth/resourceable/builder_spec.rb
+- spec/lib/azeroth/resourceable_spec.rb
 - spec/lib/azeroth/routes_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/app/controllers/controller.rb
+- spec/support/app/controllers/params_builder_controller.rb
 - spec/support/app/controllers/request_handler_controller.rb
 - spec/support/app/controllers/resource_builder_controller.rb
 - spec/support/app/controllers/resource_route_builder_controller.rb
@@ -815,6 +828,7 @@ test_files:
 - spec/support/factories/dummy_model.rb
 - spec/support/factories/factory.rb
 - spec/support/factories/game.rb
+- spec/support/factories/movie.rb
 - spec/support/factories/pokemon.rb
 - spec/support/factories/pokemon_master.rb
 - spec/support/factories/product.rb

data/Dockerfile.circleci

@@ -1,5 +0,0 @@
-FROM darthjee/circleci_rails_gems:1.0.0 as base
-
-COPY --chown=circleci ./ /home/circleci/project/
-
-RUN bundle install