azeroth 0.10.1 → 1.1.0

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/params_builder.rb

@@ -5,13 +5,15 @@ module Azeroth
   # @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
+  class ParamsBuilder < Sinclair::Model
+    # @!method initialize(model:, builder:)
+    #   @api private
+    #
+    #   @param model [Model] Resource interface
+    #   @param builder [Sinclair] Methods builder
+    #
+    #   @return [ParamsBuilder]
+    initialize_with(:model, :builder, writter: false)
 
     # Append the params methods to be built
     #
@@ -27,7 +29,8 @@ module Azeroth
       end
     end
 
-    attr_reader :model, :builder
+    private
+
     # @method model
     # @api private
     # @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/resource_builder.rb

@@ -9,13 +9,15 @@ module Azeroth
   # The builder adds 2 methods, one for listing all
   # entries of a resource, and one for fetching an specific
   # entry
-  class ResourceBuilder
-    # @param model [Model] Resource model interface
-    # @param builder [Sinclair] method builder
-    def initialize(model, builder)
-      @model = model
-      @builder = builder
-    end
+  class ResourceBuilder < Sinclair::Model
+    # @!method initialize(model:, builder:)
+    #   @api private
+    #
+    #   @param model [Model] Resource model interface
+    #   @param builder [Sinclair] method builder
+    #
+    #   @return [ResourceBuilder]
+    initialize_with(:model, :builder, writter: false)
 
     # Append methods to be built to the builder
     #
@@ -28,9 +30,6 @@ module Azeroth
       add_method(name, "@#{name} ||= #{plural}.find(#{name}_id)")
     end
 
-    private
-
-    attr_reader :model, :builder
     # @method model
     # @api private
     # @private

data/lib/azeroth/resourceable/builder.rb

@@ -13,12 +13,12 @@ module Azeroth
     # @see ResourceRouteBuilder
     # @see RoutesBuilder
     class Builder
-      # @param clazz [ActionController::Base] Controller to
+      # @param klass [ActionController::Base] Controller to
       #   to be changed
       # @param model_name [Symbol,String]
       # @param options [Options]
-      def initialize(clazz, model_name, options)
-        @clazz = clazz
+      def initialize(klass, model_name, options)
+        @klass = klass
         @options = options
         @model = Azeroth::Model.new(model_name, options)
 
@@ -30,8 +30,8 @@ module Azeroth
 
       private
 
-      attr_reader :clazz, :model, :options
-      # @method clazz
+      attr_reader :klass, :model, :options
+      # @method klass
       # @api private
       # @private
       #
@@ -89,36 +89,40 @@ module Azeroth
       #
       # @see https://www.rubydoc.info/gems/sinclair Sinclair
       def builder
-        @builder ||= Sinclair.new(clazz)
+        @builder ||= Sinclair.new(klass)
       end
 
       # Add methods for id and parameters
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_params
-        ParamsBuilder.new(model, builder).append
+        ParamsBuilder.new(
+          model: model, builder: builder
+        ).append
       end
 
       # Add methods for resource fetching
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_resource
-        ResourceBuilder.new(model, builder).append
+        ResourceBuilder.new(model: model, builder: builder).append
       end
 
       # Add metohods for each route
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_routes
-        RoutesBuilder.new(model, builder, options).append
+        RoutesBuilder.new(
+          model: model, builder: builder, options: options
+        ).append
       end
 
       # Add helpers to render objects on template
       #
       # @return [String]
       def add_helpers
-        clazz.public_send(:helper_method, model.name)
-        clazz.public_send(:helper_method, model.plural)
+        klass.public_send(:helper_method, model.name)
+        klass.public_send(:helper_method, model.plural)
       end
     end
   end

data/lib/azeroth/routes_builder.rb

@@ -5,15 +5,14 @@ module Azeroth
   # @author Darthjee
   #
   # Builder resposible for adding routes methods to the controller
-  class RoutesBuilder
-    # @param model [Model] resource interface
-    # @param builder [Sinclair] methods builder
-    # @param options [Option]
-    def initialize(model, builder, options)
-      @model = model
-      @builder = builder
-      @options = options
-    end
+  class RoutesBuilder < Sinclair::Model
+    initialize_with(:model, :builder, :options, writter: false)
+
+    # @method initialize(model:, builder:, options:)
+    #   @param model [Model] resource interface
+    #   @param builder [Sinclair] methods builder
+    #   @param options [Option]
+    #   @return [RoutesBuilder]
 
     # Append the routes methods to be built
     #
@@ -26,7 +25,6 @@ module Azeroth
 
     private
 
-    attr_reader :model, :builder, :options
     # @method model
     # @api private
     # @private

data/lib/azeroth/version.rb

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

data/spec/controllers/documents_with_error_controller_spec.rb

@@ -128,7 +128,9 @@ describe DocumentsWithErrorController do
 
     it 'returns updated document json' do
       patch :update, params: parameters
-      expect(response.body).to eq(expected_body)
+
+      expect(JSON.parse(response.body))
+        .to eq(JSON.parse(expected_body))
     end
 
     it do

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/config/environments/development.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
+  config.hosts << 'www.example.com'
   # Settings specified here will take precedence over
   # those in config/application.rb.
 

data/spec/dummy/db/schema.rb

@@ -52,5 +52,9 @@ ActiveRecord::Schema.define do
     t.string :director, null: false
   end
 
-  add_foreign_key 'pokemons', 'pokemon_masters'
+  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/key_value_extractor_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe Azeroth::Decorator::KeyValueExtractor do
   subject(:extractor) do
-    described_class.new(decorator, attribute, options)
+    described_class.new(
+      decorator: decorator, attribute: attribute, options: options
+    )
   end
 
   let(:decorator_class) { Class.new(Azeroth::Decorator) }