azeroth 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a4e7c837a4053e850b9479d42cfccd2e279ac028f57da2c5d3baed6c6babfa
-  data.tar.gz: 84591492fc859555d87b86704a61e68c0b8171e42a8fd77d1f4e502216516fc0
+  metadata.gz: 7c8e0229917b320108b25371d2c30ca48f83663288d50d2e767b8cf45c037c95
+  data.tar.gz: 2e6fe774d10fa5b5ca3f22c0b4deac4828a28480ebd3ebb1cce370c84c0f359c
 SHA512:
-  metadata.gz: ad6ca16b03b7b99b051bf9bfd25e25d1d522fa89e5b5ff31e495fa1af4fbb193dd269b062d8a87205aa8eeea84bd8a405b84de5d1663d7a1636239d4dd6b973f
-  data.tar.gz: 3eec0d1c24bb260dab5fb3ccccf5deedc8ae2eeff7378084fd501c82e740f776f1e3a14e32cee939155f5f833c4c1affdd3ca19f6636681f664be3deca36ed23
+  metadata.gz: b517e33573aa729a94fee810f0f4cea17a39533359332017e1dea8a3d80c74aacaac1010754739d8ba312d42353c57bb93d0c172aa640453450383ea1ff99328
+  data.tar.gz: 7bdfbfce3bdc6f40c2c82ea904a5778b5d0e7cc037f4fbf73f2e7d5fe8a449b7dacbac41f55523afea298bea5de998cc5d442e395fbf4949e555775aeabccff4

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/1.0.0](https://www.rubydoc.info/gems/azeroth/1.0.0)
+[https://www.rubydoc.info/gems/azeroth/1.1.0](https://www.rubydoc.info/gems/azeroth/1.1.0)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -25,6 +25,10 @@ does not perform database operations
 Future versions will enable `html` rendering to also perform
 database operations.
 
+Current Release: [1.1.0](https://github.com/darthjee/azeroth/tree/1.1.0)
+
+[Next release](https://github.com/darthjee/azeroth/compare/1.1.0...master)
+
 Installation
 ---------------
 
@@ -167,6 +171,14 @@ It accepts options
 used to define how an object is exposed as json on controller responses
 defining which and how fields will be exposed
 
+Exposing options:
+
+- as: custom key to expose the value as
+- if: method/block to be called checking if an attribute should or should not be exposed
+- decorator: flag to use or not a decorator or decorator class to be used
+- reader: Flag indicating if a reader to access the attribute should be created. usefull if you want method_missing to take over
+- override: Flag indicating if an existing method should be overriden. This is useful when a method acessor was included from another module
+
 ```ruby
   # pokemon/decorator.rb
 

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/azeroth/decorator/class_methods.rb
   - lib/azeroth/decorator/options.rb
   - lib/azeroth/resourceable/class_methods.rb
   - lib/azeroth/resourceable.rb

data/lib/azeroth/decorator/class_methods.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class Decorator
+    # @api private
+    # @author Darthjee
+    #
+    # Class methods added by {Decorator}
+    #
+    # @see ClassMethods#expose
+    module ClassMethods
+      # @api private
+      #
+      # All attributes exposed
+      #
+      # @return [Hash<Symbol,Hash>]
+      def attributes_map
+        @attributes_map ||= build_attributes_map
+      end
+
+      private
+
+      # @api private
+      # @private
+      #
+      # Initialize attributes to be exposed map
+      #
+      # When the class inherity from another
+      # decorator, the new class should expose the
+      # same attributes.
+      #
+      # @return [Hash<Symbol,Hash>]
+      def build_attributes_map
+        superclass.try(:attributes_map).dup || {}
+      end
+
+      # @visibility public
+      # @api (see Decorator.expose)
+      # @private
+      #
+      # Expose attributes on json decorated
+      #
+      # @param (see Decorator.expose)
+      # @option (see Decorator.expose)
+      #
+      # @return (see Decorator.expose)
+      #
+      # @example Simple usage
+      #   class DummyModel
+      #     include ActiveModel::Model
+      #
+      #     attr_accessor :id, :first_name, :last_name, :age,
+      #                   :favorite_pokemon
+      #
+      #     class Decorator < Azeroth::Decorator
+      #       expose :name
+      #       expose :age
+      #       expose :favorite_pokemon, as: :pokemon
+      #
+      #       def name
+      #         [object.first_name, object.last_name].join(' ')
+      #       end
+      #     end
+      #   end
+      #
+      # @example With relations
+      #   # pokemon/decorator.rb
+      #
+      #   class Pokemon::Decorator < Azeroth::Decorator
+      #     expose :name
+      #     expose :previous_form_name, as: :evolution_of, if: :evolution?
+      #
+      #     def evolution?
+      #       previous_form
+      #     end
+      #
+      #     def previous_form_name
+      #       previous_form.name
+      #     end
+      #   end
+      #
+      #   # pokemon/favorite_decorator.rb
+      #
+      #   class Pokemon::FavoriteDecorator < Pokemon::Decorator
+      #     expose :nickname
+      #   end
+      #
+      #   # pokemon_master/decorator.rb
+      #
+      #   class PokemonMaster < ActiveRecord::Base
+      #     has_one :favorite_pokemon, -> { where(favorite: true) },
+      #             class_name: 'Pokemon'
+      #     has_many :pokemons
+      #   end
+      #
+      #   # pokemon.rb
+      #
+      #   class Pokemon < ActiveRecord::Base
+      #     belongs_to :pokemon_master
+      #     has_one :previous_form,
+      #             class_name: 'Pokemon',
+      #             foreign_key: :previous_form_id
+      #   end
+      #
+      #   # pokemon_master.rb
+      #
+      #   class PokemonMaster::Decorator < Azeroth::Decorator
+      #     expose :name
+      #     expose :age
+      #     expose :favorite_pokemon, decorator: Pokemon::FavoriteDecorator
+      #     expose :pokemons
+      #
+      #     def name
+      #       [
+      #         first_name,
+      #         last_name
+      #       ].compact.join(' ')
+      #     end
+      #   end
+      #
+      #   # schema.rb
+      #
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #      create_table :pokemon_masters, force: true do |t|
+      #       t.string :first_name, null: false
+      #       t.string :last_name
+      #       t.integer :age, null: false
+      #     end
+      #
+      #     create_table :pokemons, force: true do |t|
+      #       t.string :name, null: false
+      #       t.string :nickname
+      #       t.integer :pokemon_master_id
+      #       t.boolean :favorite
+      #       t.integer :previous_form_id
+      #       t.index %i[pokemon_master_id favorite], unique: true
+      #     end
+      #
+      #     add_foreign_key 'pokemons', 'pokemon_masters'
+      #   end
+      #
+      #   # test.rb
+      #
+      #   master = PokemonMaster.create(
+      #     first_name: 'Ash',
+      #     last_name: 'Ketchum',
+      #     age: 10
+      #   )
+      #
+      #   master.create_favorite_pokemon(
+      #     name: 'pikachu',
+      #     nickname: 'Pikachu'
+      #   )
+      #
+      #   metapod = Pokemon.create(name: :metapod)
+      #
+      #   master.pokemons.create(
+      #     name: 'butterfree', previous_form: metapod
+      #   )
+      #   master.pokemons.create(name: 'squirtle')
+      #
+      #   decorator = PokemonMaster::Decorator.new(master)
+      #
+      #   decorator.as_json
+      #   # returns
+      #   # {
+      #   #   'age' => 10,
+      #   #   'name' => 'Ash Ketchum',
+      #   #   'favorite_pokemon' => {
+      #   #     'name' => 'pikachu',
+      #   #     'nickname' => 'Pikachu'
+      #   #   },
+      #   #   'pokemons' => [{
+      #   #     'name' => 'butterfree',
+      #   #     'evolution_of' => 'metapod'
+      #   #   }, {
+      #   #     'name' => 'squirtle'
+      #   #   }, {
+      #   #     'name' => 'pikachu'
+      #   #   }]
+      #   # }
+      #
+      # @example With method building options
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #     create_table :websites, force: true do |t|
+      #       t.string :domain, null: false
+      #       t.integer :port, limit: 2, unsigned: true
+      #       t.string :protocol, limit: 5
+      #     end
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #     module WithLocation
+      #       def location
+      #         "#{protocol}://#{domain}:#{port}"
+      #       end
+      #
+      #       def protocol
+      #         website.protocol || '*'
+      #       end
+      #
+      #       def domain
+      #         website.domain || '*'
+      #       end
+      #
+      #       def port
+      #         website.port || '*'
+      #       end
+      #     end
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #     class Decorator < Azeroth::Decorator
+      #       include WithLocation
+      #
+      #       expose :location, override: false
+      #
+      #       alias website object
+      #     end
+      #   end
+      #
+      #   website = Website.create(
+      #     protocol: :http,
+      #     domain: 'google.com'
+      #   )
+      #
+      #   decorator = Website::Decorator.new(website)
+      #
+      #   decorator.as_json
+      #
+      #   # returns
+      #   # { 'location' => 'http://google.com:*' }
+      def expose(attribute, **options_hash)
+        options = Decorator::Options.new(options_hash)
+
+        MethodBuilder.build_reader(self, attribute, options)
+
+        attributes_map[attribute] = options
+      end
+    end
+  end
+end

data/lib/azeroth/decorator/method_builder.rb

@@ -7,20 +7,36 @@ module Azeroth
     # Responsible for building readers for attributes
     # @api private
     class MethodBuilder < Sinclair
-      # Builds reader
-      #
-      # reaader delegate method calls to @object
-      #
-      # @return [Array<Sinclair::MethodDefinition>]
-      def self.build_reader(klass, attribute)
-        new(klass).build_reader(attribute)
+      class << self
+        # Builds reader
+        #
+        # reaader delegate method calls to @object
+        #
+        # @return [Array<Sinclair::MethodDefinition>]
+        def build_reader(klass, attribute, options)
+          new(klass, options).build_reader(attribute)
+        end
+      end
+
+      def initialize(klass, options)
+        super(klass)
+        @options = options
       end
 
       # (see MethodBuilder.build_reader)
       def build_reader(attribute)
+        return if skip_creation?(attribute)
+
         add_method(attribute, "@object.#{attribute}")
         build
       end
+
+      def skip_creation?(attribute)
+        return true unless options.reader
+        return false unless klass.method_defined?(attribute)
+
+        !options.override
+      end
     end
   end
 end

data/lib/azeroth/decorator/options.rb

@@ -13,7 +13,9 @@ module Azeroth
       DEFAULT_OPTIONS = {
         as: nil,
         if: nil,
-        decorator: true
+        decorator: true,
+        override: true,
+        reader: true
       }.freeze
 
       with_options DEFAULT_OPTIONS

data/lib/azeroth/decorator.rb

@@ -40,200 +40,42 @@ module Azeroth
   #                     #   'pokemon' => 'Arcanine'
   #                     # }
   class Decorator
+    autoload :ClassMethods,      'azeroth/decorator/class_methods'
     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
-      # @api private
-      #
-      # All attributes exposed
-      #
-      # @return [Hash<Symbol,Hash>]
-      def attributes_map
-        @attributes_map ||= build_attributes_map
-      end
-
-      private
-
-      # @api private
-      # @private
-      #
-      # Initialize attributes to be exposed map
-      #
-      # When the class inherity from another
-      # decorator, the new class should expose the
-      # same attributes.
-      #
-      # @return [Hash<Symbol,Hash>]
-      def build_attributes_map
-        superclass.try(:attributes_map).dup || {}
-      end
-
-      # @visibility public
-      # @api public
-      # @private
-      #
-      # Expose attributes on json decorated
-      #
-      # @param attribute [Symbol,String] attribute to be exposed
-      # @param options_hash [Hash] exposing options
-      # @option options_hash as [Symbol,String] custom key
-      #   to expose
-      # @option options_hash if [Symbol,Proc] method/block
-      #   to be called
-      #   checking if an attribute should or should not
-      #   be exposed
-      # @option options_hash decorator [FalseClass,TrueClass,Class]
-      #   flag to use or not a decorator or decorator class to be used
-      #
-      # @return [Array<Symbol>]
-      #
-      # @example
-      #   class DummyModel
-      #     include ActiveModel::Model
-      #
-      #     attr_accessor :id, :first_name, :last_name, :age,
-      #                   :favorite_pokemon
-      #
-      #     class Decorator < Azeroth::Decorator
-      #       expose :name
-      #       expose :age
-      #       expose :favorite_pokemon, as: :pokemon
-      #
-      #       def name
-      #         [object.first_name, object.last_name].join(' ')
-      #       end
-      #     end
-      #   end
-      #
-      # @example With relations
-      #   # pokemon/decorator.rb
-      #
-      #   class Pokemon::Decorator < Azeroth::Decorator
-      #     expose :name
-      #     expose :previous_form_name, as: :evolution_of, if: :evolution?
-      #
-      #     def evolution?
-      #       previous_form
-      #     end
-      #
-      #     def previous_form_name
-      #       previous_form.name
-      #     end
-      #   end
-      #
-      #   # pokemon/favorite_decorator.rb
-      #
-      #   class Pokemon::FavoriteDecorator < Pokemon::Decorator
-      #     expose :nickname
-      #   end
-      #
-      #   # pokemon_master/decorator.rb
-      #
-      #   class PokemonMaster < ActiveRecord::Base
-      #     has_one :favorite_pokemon, -> { where(favorite: true) },
-      #             class_name: 'Pokemon'
-      #     has_many :pokemons
-      #   end
-      #
-      #   # pokemon.rb
-      #
-      #   class Pokemon < ActiveRecord::Base
-      #     belongs_to :pokemon_master
-      #     has_one :previous_form,
-      #             class_name: 'Pokemon',
-      #             foreign_key: :previous_form_id
-      #   end
-      #
-      #   # pokemon_master.rb
-      #
-      #   class PokemonMaster::Decorator < Azeroth::Decorator
-      #     expose :name
-      #     expose :age
-      #     expose :favorite_pokemon, decorator: Pokemon::FavoriteDecorator
-      #     expose :pokemons
-      #
-      #     def name
-      #       [
-      #         first_name,
-      #         last_name
-      #       ].compact.join(' ')
-      #     end
-      #   end
-      #
-      #   # schema.rb
-      #
-      #   ActiveRecord::Schema.define do
-      #     self.verbose = false
-      #
-      #      create_table :pokemon_masters, force: true do |t|
-      #       t.string :first_name, null: false
-      #       t.string :last_name
-      #       t.integer :age, null: false
-      #     end
-      #
-      #     create_table :pokemons, force: true do |t|
-      #       t.string :name, null: false
-      #       t.string :nickname
-      #       t.integer :pokemon_master_id
-      #       t.boolean :favorite
-      #       t.integer :previous_form_id
-      #       t.index %i[pokemon_master_id favorite], unique: true
-      #     end
-      #
-      #     add_foreign_key 'pokemons', 'pokemon_masters'
-      #   end
-      #
-      #   # test.rb
-      #
-      #   master = PokemonMaster.create(
-      #     first_name: 'Ash',
-      #     last_name: 'Ketchum',
-      #     age: 10
-      #   )
-      #
-      #   master.create_favorite_pokemon(
-      #     name: 'pikachu',
-      #     nickname: 'Pikachu'
-      #   )
-      #
-      #   metapod = Pokemon.create(name: :metapod)
-      #
-      #   master.pokemons.create(
-      #     name: 'butterfree', previous_form: metapod
-      #   )
-      #   master.pokemons.create(name: 'squirtle')
-      #
-      #   decorator = PokemonMaster::Decorator.new(master)
-      #
-      #   decorator.as_json
-      #   # returns
-      #   # {
-      #   #   'age' => 10,
-      #   #   'name' => 'Ash Ketchum',
-      #   #   'favorite_pokemon' => {
-      #   #     'name' => 'pikachu',
-      #   #     'nickname' => 'Pikachu'
-      #   #   },
-      #   #   'pokemons' => [{
-      #   #     'name' => 'butterfree',
-      #   #     'evolution_of' => 'metapod'
-      #   #   }, {
-      #   #     'name' => 'squirtle'
-      #   #   }, {
-      #   #     'name' => 'pikachu'
-      #   #   }]
-      #   # }
-      def expose(attribute, **options_hash)
-        options = Decorator::Options.new(options_hash)
+    extend ClassMethods
 
-        MethodBuilder.build_reader(self, attribute)
-
-        attributes_map[attribute] = options
-      end
-    end
+    # @method self.expose(attribute, **options_hash)
+    # @visibility public
+    # @api public
+    # @private
+    #
+    # Expose attributes on json decorated
+    #
+    # @param attribute [Symbol,String] attribute to be exposed
+    # @param options_hash [Hash] exposing options
+    # @option options_hash as [Symbol,String] custom key
+    #   to expose the value as
+    # @option options_hash if [Symbol,Proc] method/block
+    #   to be called
+    #   checking if an attribute should or should not
+    #   be exposed
+    # @option options_hash decorator [FalseClass,TrueClass,Class]
+    #   flag to use or not a decorator or decorator class to be used
+    # @option options_hash reader [Boolean] Flag indicating if a reader
+    #   to access the attribute should be created. usefull if you want
+    #   method_missing to take over
+    # @option options_hash override [Boolean] Flag indicating if an
+    #   existing method should be overriden.
+    #   This is useful when a method acessor was included from another module
+    #
+    # @return [Array<Symbol>]
+    #
+    # @see Decorator::ClassMethods#expose Decorator::ClassMethods#expose
+    #   for examples
 
     # @api private
     #

data/lib/azeroth/request_handler/index.rb

@@ -8,7 +8,13 @@ module Azeroth
     class Index < RequestHandler
       private
 
-      delegate :paginated?, :per_page, to: :options
+      delegate :per_page, :offset, :limit,
+               :current_page, to: :pagination
+      delegate :paginated?, to: :options
+
+      def pagination
+        @pagination ||= Pagination.new(params, options)
+      end
 
       # @private
       #
@@ -45,29 +51,6 @@ module Azeroth
         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
-        (current_page - 1) * 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
@@ -77,15 +60,6 @@ module Azeroth
         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

data/lib/azeroth/request_handler/pagination.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # Wrapper for request finding pagination attributes
+    class Pagination
+      def initialize(params, options)
+        @params = params
+        @options = options
+      end
+
+      delegate :per_page, to: :options
+
+      # @private
+      #
+      # offest used in pagination
+      #
+      # offset is retrieved from +params[:per_page]+
+      # or +options.per_page+
+      #
+      # @return [Integer]
+      def offset
+        (current_page - 1) * 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
+      #
+      # calculates current page
+      #
+      # @return [Integer]
+      def current_page
+        (params[:page] || 1).to_i
+      end
+
+      private
+
+      attr_reader :params, :options
+    end
+  end
+end

data/lib/azeroth/request_handler.rb

@@ -8,13 +8,14 @@ module Azeroth
   # Request handler sends messages to the controller
   # in order to get the resource and rendering the response
   class RequestHandler
-    autoload :Create,  'azeroth/request_handler/create'
-    autoload :Destroy, 'azeroth/request_handler/destroy'
-    autoload :Edit,    'azeroth/request_handler/edit'
-    autoload :Index,   'azeroth/request_handler/index'
-    autoload :New,     'azeroth/request_handler/new'
-    autoload :Show,    'azeroth/request_handler/show'
-    autoload :Update,  'azeroth/request_handler/update'
+    autoload :Create,     'azeroth/request_handler/create'
+    autoload :Destroy,    'azeroth/request_handler/destroy'
+    autoload :Edit,       'azeroth/request_handler/edit'
+    autoload :Index,      'azeroth/request_handler/index'
+    autoload :New,        'azeroth/request_handler/new'
+    autoload :Pagination, 'azeroth/request_handler/pagination'
+    autoload :Show,       'azeroth/request_handler/show'
+    autoload :Update,     'azeroth/request_handler/update'
 
     # @param controller [ApplicationController]
     # @param model [Azeroth::Model]

data/lib/azeroth/version.rb

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

data/spec/dummy/app/models/website/decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Website < ActiveRecord::Base
+  class Decorator < Azeroth::Decorator
+    include WithLocation
+
+    expose :location, override: false
+
+    alias website object
+  end
+end

data/spec/dummy/app/models/website/with_location.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Website < ActiveRecord::Base
+  module WithLocation
+    def location
+      "#{protocol}://#{domain}:#{port}"
+    end
+
+    def protocol
+      website.protocol || '*'
+    end
+
+    def domain
+      website.domain || '*'
+    end
+
+    def port
+      website.port || '*'
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Website < ActiveRecord::Base
+end

data/spec/dummy/db/schema.rb

@@ -51,4 +51,10 @@ ActiveRecord::Schema.define do
     t.string :name, null: false
     t.string :director, null: false
   end
+
+  create_table :websites, force: true do |t|
+    t.string :domain, null: false
+    t.integer :port, limit: 2, unsigned: true
+    t.string :protocol, limit: 5
+  end
 end

data/spec/integration/yard/azeroth/decorator_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spec_helper'
+
 describe Azeroth::Decorator do
   describe 'yard' do
     describe '#as_json' do
@@ -60,6 +62,19 @@ describe Azeroth::Decorator do
           }
         )
       end
+
+      it 'example without override' do
+        website = Website.create(
+          protocol: :http,
+          domain: 'google.com'
+        )
+
+        decorator = Website::Decorator.new(website)
+
+        expect(decorator.as_json).to eq(
+          'location' => 'http://google.com:*'
+        )
+      end
     end
   end
 end

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

@@ -3,21 +3,80 @@
 require 'spec_helper'
 
 describe Azeroth::Decorator::MethodBuilder do
+  subject(:build_reader) do
+    described_class.build_reader(decorator_class, :age, options)
+  end
+
   let(:decorator_class) { Class.new(Azeroth::Decorator) }
   let(:decorator)       { decorator_class.new(object) }
   let(:model)           { build(:dummy_model) }
   let(:object)          { model }
+  let(:options)         { Azeroth::Decorator::Options.new(options_hash) }
+  let(:options_hash)    { {} }
 
   describe '.build_reader' do
     it do
-      expect { described_class.build_reader(decorator_class, :age) }
+      expect { build_reader }
         .to add_method(:age).to(decorator)
     end
 
     it do
-      described_class.build_reader(decorator_class, :age)
+      build_reader
 
       expect(decorator.age).to eq(model.age)
     end
+
+    context 'when passing reader option' do
+      context 'when passing true' do
+        let(:options_hash) { { reader: true } }
+
+        it do
+          expect { build_reader }
+            .to add_method(:age).to(decorator)
+        end
+      end
+
+      context 'when passing false' do
+        let(:options_hash) { { reader: false } }
+
+        it do
+          expect { build_reader }
+            .not_to add_method(:age).to(decorator)
+        end
+      end
+    end
+
+    context 'when passing override option as true' do
+      let(:options_hash) { { override: false } }
+
+      it do
+        expect { build_reader }
+          .to add_method(:age).to(decorator)
+      end
+    end
+
+    context 'when method already existed' do
+      before do
+        decorator_class.define_method(:age) { 1 }
+      end
+
+      context 'when passing override option as true' do
+        let(:options_hash) { { override: true } }
+
+        it do
+          expect { build_reader }
+            .to change_method(:age).on(decorator)
+        end
+      end
+
+      context 'when passing override option as false' do
+        let(:options_hash) { { override: false } }
+
+        it do
+          expect { build_reader }
+            .not_to change_method(:age).on(decorator)
+        end
+      end
+    end
   end
 end

data/spec/lib/azeroth/decorator_spec.rb

@@ -5,14 +5,16 @@ require 'spec_helper'
 describe Azeroth::Decorator do
   subject(:decorator) { DummyModel::Decorator.new(object) }
 
-  let(:model)  { build(:dummy_model) }
-  let(:object) { model }
+  let(:model)    { build(:dummy_model) }
+  let(:object)   { model }
+  let(:instance) { decorator.new(object) }
 
   describe '.expose' do
     subject(:decorator) { Class.new(described_class) }
 
+    let(:options_hash) { {} }
     let(:expected_options) do
-      Azeroth::Decorator::Options.new
+      Azeroth::Decorator::Options.new(options_hash)
     end
 
     it do
@@ -59,6 +61,97 @@ describe Azeroth::Decorator do
           .and raise_error(Sinclair::Exception::InvalidOptions)
       end
     end
+
+    context 'when decorator already has the method' do
+      before do
+        decorator.define_method(:name) do
+          'some name'
+        end
+      end
+
+      context 'when not passing override' do
+        it do
+          expect { decorator.send(:expose, :name) }
+            .to change(decorator, :attributes_map)
+            .from({})
+            .to({ name: expected_options })
+        end
+
+        it do
+          expect { decorator.send(:expose, :name) }
+            .to change_method(:name)
+            .on(instance)
+        end
+      end
+
+      context 'when passing override as true' do
+        let(:options_hash) { { override: true } }
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to change(decorator, :attributes_map)
+            .from({})
+            .to({ name: expected_options })
+        end
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to change_method(:name)
+            .on(instance)
+        end
+      end
+
+      context 'when passing override as false' do
+        let(:options_hash) { { override: false } }
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to change(decorator, :attributes_map)
+            .from({})
+            .to({ name: expected_options })
+        end
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .not_to change_method(:name)
+            .on(instance)
+        end
+      end
+    end
+
+    context 'when passing reader option' do
+      context 'when option is true' do
+        let(:options_hash) { { reader: true } }
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to change(decorator, :attributes_map)
+            .from({})
+            .to({ name: expected_options })
+        end
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to add_method(:name).to(decorator)
+        end
+      end
+
+      context 'when option is false' do
+        let(:options_hash) { { reader: false } }
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .to change(decorator, :attributes_map)
+            .from({})
+            .to({ name: expected_options })
+        end
+
+        it do
+          expect { decorator.send(:expose, :name, **options_hash) }
+            .not_to add_method(:name).to(decorator)
+        end
+      end
+    end
   end
 
   describe '#as_json' do

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::RequestHandler::Pagination do
+  subject(:pagination) { described_class.new(params, options) }
+
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
+  let(:params)       { ActionController::Parameters.new(parameters) }
+  let(:parameters)   { {} }
+
+  describe '#offset' do
+    context 'when nothing was defined' do
+      it do
+        expect(pagination.offset).to be_zero
+      end
+    end
+
+    context 'when parameters has page value' do
+      let(:parameters)        { { page: page } }
+      let(:page)              { Random.rand(1..10) }
+      let(:expected_offset)   { (page - 1) * expected_per_page }
+      let(:expected_per_page) { 20 }
+
+      it 'returns value from request using default per_page' do
+        expect(pagination.offset).to eq(expected_offset)
+      end
+    end
+
+    context 'when parameters has per_page value' do
+      let(:parameters)        { { per_page: per_page } }
+      let(:per_page)          { Random.rand(1..10) }
+
+      it do
+        expect(pagination.offset).to be_zero
+      end
+    end
+
+    context 'when parameters has page and per page values' do
+      let(:parameters)        { { page: page, per_page: per_page } }
+      let(:page)              { Random.rand(1..10) }
+      let(:per_page)          { Random.rand(1..10) }
+      let(:expected_offset)   { (page - 1) * expected_per_page }
+      let(:expected_per_page) { per_page }
+
+      it 'returns value from request' do
+        expect(pagination.offset).to eq(expected_offset)
+      end
+    end
+
+    context 'when parameters has page and options per page values' do
+      let(:parameters)        { { page: page } }
+      let(:options_hash)      { { per_page: per_page } }
+      let(:page)              { Random.rand(1..10) }
+      let(:per_page)          { Random.rand(1..10) }
+      let(:expected_offset)   { (page - 1) * expected_per_page }
+      let(:expected_per_page) { per_page }
+
+      it 'returns value from request and options' do
+        expect(pagination.offset).to eq(expected_offset)
+      end
+    end
+
+    context 'when params has page and per_page and options per page values' do
+      let(:parameters)        { { page: page, per_page: per_page } }
+      let(:options_hash)      { { per_page: options_per_page } }
+      let(:page)              { Random.rand(1..10) }
+      let(:options_per_page)  { Random.rand(1..10) }
+      let(:per_page)          { Random.rand(1..10) }
+      let(:expected_offset)   { (page - 1) * expected_per_page }
+      let(:expected_per_page) { per_page }
+
+      it 'returns value from request' do
+        expect(pagination.offset).to eq(expected_offset)
+      end
+    end
+  end
+
+  describe '#limit' do
+    context 'when nothing was defined' do
+      it 'returns default value' do
+        expect(pagination.limit).to eq(20)
+      end
+    end
+
+    context 'when parameters has per_page' do
+      let(:parameters) { { per_page: per_page } }
+      let(:per_page)   { Random.rand(1..10) }
+
+      it 'returns value from request' do
+        expect(pagination.limit).to eq(per_page)
+      end
+    end
+
+    context 'when options has per_page' do
+      let(:options_hash) { { per_page: per_page } }
+      let(:per_page)     { Random.rand(1..10) }
+
+      it 'returns value from options' do
+        expect(pagination.limit).to eq(per_page)
+      end
+    end
+
+    context 'when params and options have per_page' do
+      let(:parameters)       { { per_page: per_page } }
+      let(:per_page)         { Random.rand(1..10) }
+      let(:options_hash)     { { per_page: options_per_page } }
+      let(:options_per_page) { Random.rand(1..10) }
+
+      it 'returns value from request' do
+        expect(pagination.limit).to eq(per_page)
+      end
+    end
+  end
+
+  describe '#current_page' do
+    context 'when nothing was defined' do
+      it 'returns first page' do
+        expect(pagination.current_page).to eq(1)
+      end
+    end
+
+    context 'when parameters has page' do
+      let(:parameters) { { page: page } }
+      let(:page)       { Random.rand(1..10) }
+
+      it 'returns value from request' do
+        expect(pagination.current_page).to eq(page)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -500,6 +500,7 @@ files:
 - lib/azeroth.rb
 - lib/azeroth/controller_interface.rb
 - lib/azeroth/decorator.rb
+- lib/azeroth/decorator/class_methods.rb
 - lib/azeroth/decorator/hash_builder.rb
 - lib/azeroth/decorator/key_value_extractor.rb
 - lib/azeroth/decorator/method_builder.rb
@@ -514,6 +515,7 @@ files:
 - lib/azeroth/request_handler/edit.rb
 - lib/azeroth/request_handler/index.rb
 - lib/azeroth/request_handler/new.rb
+- lib/azeroth/request_handler/pagination.rb
 - lib/azeroth/request_handler/show.rb
 - lib/azeroth/request_handler/update.rb
 - lib/azeroth/resource_builder.rb
@@ -578,6 +580,9 @@ files:
 - spec/dummy/app/models/product/decorator_with_factory.rb
 - spec/dummy/app/models/publisher.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/models/website.rb
+- spec/dummy/app/models/website/decorator.rb
+- spec/dummy/app/models/website/with_location.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
 - spec/dummy/app/views/documents/new.html
@@ -648,6 +653,7 @@ files:
 - spec/lib/azeroth/request_handler/edit_spec.rb
 - spec/lib/azeroth/request_handler/index_spec.rb
 - spec/lib/azeroth/request_handler/new_spec.rb
+- spec/lib/azeroth/request_handler/pagination_spec.rb
 - spec/lib/azeroth/request_handler/show_spec.rb
 - spec/lib/azeroth/request_handler/update_spec.rb
 - spec/lib/azeroth/request_handler_spec.rb
@@ -754,6 +760,9 @@ test_files:
 - spec/dummy/app/models/product/decorator_with_factory.rb
 - spec/dummy/app/models/publisher.rb
 - spec/dummy/app/models/user.rb
+- spec/dummy/app/models/website.rb
+- spec/dummy/app/models/website/decorator.rb
+- spec/dummy/app/models/website/with_location.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
 - spec/dummy/app/views/documents/new.html
@@ -824,6 +833,7 @@ test_files:
 - spec/lib/azeroth/request_handler/edit_spec.rb
 - spec/lib/azeroth/request_handler/index_spec.rb
 - spec/lib/azeroth/request_handler/new_spec.rb
+- spec/lib/azeroth/request_handler/pagination_spec.rb
 - spec/lib/azeroth/request_handler/show_spec.rb
 - spec/lib/azeroth/request_handler/update_spec.rb
 - spec/lib/azeroth/request_handler_spec.rb