azeroth 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b05d8bcf76fadc6b48d87c98c5523a21e5cdb68857d0ba42d99e5e2b1c3ec41b
-  data.tar.gz: f3e65b23e171f6c63ae143bb2a47aa7100a11ee29fdde85dd7938d5ba2a62408
+  metadata.gz: 72a4e7c837a4053e850b9479d42cfccd2e279ac028f57da2c5d3baed6c6babfa
+  data.tar.gz: 84591492fc859555d87b86704a61e68c0b8171e42a8fd77d1f4e502216516fc0
 SHA512:
-  metadata.gz: 1807ceb2a7450f2d469d9232d3c3fb36ebcb7b8942b1309a7ba8686a30bebc1074598b649820d94553be4917ce15aeb2b0a919b7f2eb1a4e361bd159a50751fa
-  data.tar.gz: 76992063fb6218ef13ebbf38416b8165b7f79bb69bb1f56330dc0c5d66cb8186394509e8b52fa7aa4c3d6f950db031692139f315cd126aa2c44b1c57ab511894
+  metadata.gz: ad6ca16b03b7b99b051bf9bfd25e25d1d522fa89e5b5ff31e495fa1af4fbb193dd269b062d8a87205aa8eeea84bd8a405b84de5d1663d7a1636239d4dd6b973f
+  data.tar.gz: 3eec0d1c24bb260dab5fb3ccccf5deedc8ae2eeff7378084fd501c82e740f776f1e3a14e32cee939155f5f833c4c1affdd3ca19f6636681f664be3deca36ed23

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.2.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.2.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.2.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.2.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/1.0.0](https://www.rubydoc.info/gems/azeroth/1.0.0)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -131,6 +131,36 @@ It accepts options
   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
+  # }
+```
+
 ## Azeroth::Decorator
 
 [Decorators](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator) are

data/azeroth.gemspec

@@ -18,21 +18,21 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'activesupport',       '~> 5.2.x'
+  gem.add_runtime_dependency 'activesupport',       '~> 7.0.x'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'jace',                '>= 0.0.3'
-  gem.add_runtime_dependency 'sinclair',            '>= 1.6.7'
+  gem.add_runtime_dependency 'jace',                '>= 0.1.1'
+  gem.add_runtime_dependency 'sinclair',            '>= 2.0.0'
 
-  gem.add_development_dependency 'actionpack',                '~> 5.2.x'
-  gem.add_development_dependency 'activerecord',              '~> 5.2.x'
-  gem.add_development_dependency 'bundler',                   '~> 2.3.14'
+  gem.add_development_dependency 'actionpack',                '7.0.4.3'
+  gem.add_development_dependency 'activerecord',              '7.0.4.3'
+  gem.add_development_dependency 'bundler',                   '~> 2.4.8'
   gem.add_development_dependency 'factory_bot',               '6.2.1'
-  gem.add_development_dependency 'minitest',                  '~> 5.15.0'
-  gem.add_development_dependency 'nokogiri',                  '1.13.6'
+  gem.add_development_dependency 'minitest',                  '5.16.2'
+  gem.add_development_dependency 'nokogiri',                  '1.13.8'
   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',                     '7.0.4.3'
+  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,9 +44,10 @@ 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 'sprockets-rails',           '3.4.2'
   gem.add_development_dependency 'sqlite3',                   '1.4.2'
   gem.add_development_dependency 'tzinfo-data',               '~> 1.2022.1'
   gem.add_development_dependency 'yard',                      '0.9.27'

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/decorator/hash_builder.rb

@@ -25,7 +25,9 @@ module Azeroth
       # @return [Hash]
       def as_json
         attributes_map.inject({}) do |hash, (method, options)|
-          new_hash = KeyValueExtractor.new(decorator, method, options).as_json
+          new_hash = KeyValueExtractor.new(
+            decorator: decorator, attribute: method, options: options
+          ).as_json
           hash.merge!(new_hash)
         end
       end

data/lib/azeroth/decorator/key_value_extractor.rb

@@ -11,18 +11,14 @@ module Azeroth
     #
     # A decorator is infered for the value / attribute
     # or used from the options given
-    class KeyValueExtractor
+    class KeyValueExtractor < Sinclair::Model
+      initialize_with(:decorator, :attribute, :options)
       # @param decorator [Decorator] decorator object
       # @param attribute [Symbol] attribute to be used on output hash
       # @param options [Decorator::Options] decoration options
       # @option options if [Proc,Symbol] conditional to be
       #   checked when exposing field
       #   (see {Decorator::Options#if})
-      def initialize(decorator, attribute, options)
-        @decorator = decorator
-        @attribute = attribute
-        @options = options
-      end
 
       # Return hash for attribute
       #
@@ -38,9 +34,8 @@ module Azeroth
         }
       end
 
-      # private
+      private
 
-      attr_reader :decorator, :attribute, :options
       # @method decorator
       # @api private
       # @private

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,83 @@
+# frozen_string_literal: true
+
+module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Class responsible for adding params handling methods to a controller
+  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
+    #
+    # @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
+
+    private
+
+    # @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/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
       #
@@ -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
       #
@@ -97,50 +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
-        add_method("#{name}_id", 'params.require(:id)')
-        add_method(
-          "#{name}_params",
-          <<-CODE
-            params.require(:#{name})
-              .permit(:#{permitted_attributes.join(', :')})
-          CODE
-        )
+        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)
-      end
-
-      # Returns all updatable attributes
-      #
-      # @return [Array<String>]
-      def permitted_attributes
-        @permitted_attributes ||= klass.attribute_names - ['id']
+        klass.public_send(:helper_method, model.name)
+        klass.public_send(:helper_method, model.plural)
       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)