azeroth 1.0.0 → 2.0.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)
-
-        MethodBuilder.build_reader(self, attribute)
+    extend ClassMethods
 
-        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
     #
@@ -255,10 +97,10 @@ module Azeroth
     # @param args [Hash] options (to be implemented)
     #
     # @return [Hash]
-    def as_json(*args)
+    def as_json(*)
       return nil if object.nil?
 
-      return array_as_json(*args) if enum?
+      return array_as_json(*) if enum?
 
       HashBuilder.new(self).as_json
     end
@@ -266,6 +108,7 @@ module Azeroth
     private
 
     attr_reader :object
+
     # @method object
     # @api private
     #
@@ -307,9 +150,9 @@ module Azeroth
     #   method called
     #
     # @return [Object]
-    def method_missing(method_name, *args)
+    def method_missing(method_name, *)
       if object.respond_to?(method_name)
-        object.public_send(method_name, *args)
+        object.public_send(method_name, *)
       else
         super
       end

data/lib/azeroth/model.rb

@@ -54,6 +54,7 @@ module Azeroth
     private
 
     attr_reader :options
+
     # @method options
     # @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]
@@ -45,6 +46,7 @@ module Azeroth
     private
 
     attr_reader :controller, :model, :options
+
     # @method controller
     # @api private
     # @private
@@ -118,8 +120,8 @@ module Azeroth
     # Run a block triggering the event
     #
     # @return [Object] Result of given block
-    def trigger_event(event, &block)
-      options.event_registry.trigger(event, controller, &block)
+    def trigger_event(event, &)
+      options.event_registry.trigger(event, controller, &)
     end
 
     # @private

data/lib/azeroth/resourceable/builder.rb

@@ -31,6 +31,7 @@ module Azeroth
       private
 
       attr_reader :klass, :model, :options
+
       # @method klass
       # @api private
       # @private
@@ -121,8 +122,8 @@ module Azeroth
       #
       # @return [String]
       def add_helpers
-        klass.public_send(:helper_method, model.name)
-        klass.public_send(:helper_method, model.plural)
+        klass.helper_method(model.name)
+        klass.helper_method(model.plural)
       end
     end
   end

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '1.0.0'
+  VERSION = '2.0.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/config/environments/production.rb

@@ -89,7 +89,7 @@ Rails.application.configure do
   config.active_support.deprecation = :notify
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
-  config.log_formatter = ::Logger::Formatter.new
+  config.log_formatter = Logger::Formatter.new
 
   # Use a different logger for distributed setups.
   # require 'syslog/logger'
@@ -98,7 +98,7 @@ Rails.application.configure do
   # )
 
   if ENV['RAILS_LOG_TO_STDOUT'].present?
-    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger           = ActiveSupport::Logger.new($stdout)
     logger.formatter = config.log_formatter
     config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end

data/spec/dummy/config/puma.rb

@@ -6,17 +6,17 @@
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum; this matches the default thread size of Active Record.
 #
-threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 5)
 threads threads_count, threads_count
 
 # Specifies the `port` that Puma will listen on to receive requests;
 # default is 3000.
 #
-port        ENV.fetch('PORT') { 3000 }
+port        ENV.fetch('PORT', 3000)
 
 # Specifies the `environment` that Puma will run in.
 #
-environment ENV.fetch('RAILS_ENV') { 'development' }
+environment ENV.fetch('RAILS_ENV', 'development')
 
 # Specifies the number of `workers` to boot in clustered mode.
 # Workers are forked webserver processes. If using threads and workers together

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
+    t.string :protocol, limit: 5
+  end
 end

data/spec/integration/readme/controllers/games_controller_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe GamesController, controller: true do
+describe GamesController, :controller do
   describe 'readme' do
     describe 'POST create' do
       it 'create game' do

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/integration/yard/controllers/games_controller_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe GamesController, controller: true do
+describe GamesController, :controller do
   describe 'yard' do
     describe 'POST create' do
       it 'create game' do

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe PaginatedDocumentsController, controller: true do
+describe PaginatedDocumentsController, :controller do
   describe 'yard' do
     describe 'GET index' do
       before { create_list(:document, 30) }

data/spec/lib/azeroth/controller_interface_spec.rb

@@ -11,7 +11,7 @@ describe Azeroth::ControllerInterface do
   describe '#add_headers' do
     let(:controller_headers) do
       {
-        'old_key': 100
+        old_key: 100
       }
     end