azeroth 0.8.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b37d53edb3f9b83aca0a7b121040c8db535da8b40d1bbc863c4d0b368dabe65d
-  data.tar.gz: 567d011f2f370e24d4b182182cfed7d08e46e344e533f6caccc1529c1c318643
+  metadata.gz: bcc284d1b166fec28f03e31cd42642ad09a86c85a81718ba401531443b1bbc08
+  data.tar.gz: 335851aa5d9a160cf387971e904248c2f89041594ccdaec57fa9ab130624558f
 SHA512:
-  metadata.gz: 8c89d250bf8825965909dcc57aac1adb333cc06995cc27e381a78a442fd3c0ce187d33f6b39b2f3a002eeb97e9ca5462a44d2f81ca957d3aa8810bd1441b8081
-  data.tar.gz: 0eb7564aa351c821bf88cf25d7ca3991eb239089b492dc31587526b437067f9436fdb175c86a7ca937fc457d76fb546e4c8cc5159236cc88145ed06ac215e3f6
+  metadata.gz: 7ef7afcbd3282d181339fa6f154d1b4dcb6c6bad00f7c4e33e5c0b912b55eecc7de9876e44d2d54e7709a006a7cef487ee6c057dc0645bc0e336ff2b70629fdf
+  data.tar.gz: d37ba6ffdfe83b55fd51f103fd9ba3f35a3edf5eb0121c5aab424da29ffcce3e7850d52acdb4c41097c773d2f5b56692dc5f0e6c751ebce1651153bde42f2e1d

data/.circleci/config.yml

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

data/.gitignore

@@ -11,3 +11,4 @@ rubycritic/
 spec/dummy/log/*
 spec/dummy/tmp/*
 spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal

data/Dockerfile

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

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.8.2](https://www.rubydoc.info/gems/azeroth/0.8.2)
+[https://www.rubydoc.info/gems/azeroth/0.10.1](https://www.rubydoc.info/gems/azeroth/0.10.1)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -61,6 +61,7 @@ It accepts options
 - before_save: Method/Proc to be ran before saving the resource on create or update
 - after_save: Method/Proc to be ran after saving the resource on create or update
 - build_with: Method/Block to be ran when building the reource on create
+- update_with: Method/Block to be ran when updating the reource on update
 - paginated: Flag when pagination should be applied
 - per_page: Number of items returned when pagination is active
 
@@ -171,6 +172,35 @@ defining which and how fields will be exposed
   end
 ```
 
+```ruby
+  class PaginatedDocumentsController < ApplicationController
+    include Azeroth::Resourceable
+
+    resource_for :document, only: 'index', paginated: true
+  end
+
+  30.times { create(:document) }
+
+  get '/paginated_documents.json'
+
+  # returns Array with 20 first documents
+  # returns in the headers pagination headers
+  {
+    'pages' => 2,
+    'per_page' => 20,
+    'page' => 1
+  }
+
+  get '/paginated_documents.json?page=2'
+
+  # returns Array with 10 next documents
+  # returns in the headers pagination headers
+  {
+    'pages' => 2,
+    'per_page' => 20,
+    'page' => 2
+  }
+```
 Exposing is done through the class method
 [expose](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator#expose-class_method)
 which accepts several options:

data/azeroth.gemspec

@@ -20,33 +20,35 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport',       '~> 5.2.x'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'jace',                '>= 0.0.3'
+  gem.add_runtime_dependency 'jace',                '>= 0.1.1'
   gem.add_runtime_dependency 'sinclair',            '>= 1.6.7'
 
-  gem.add_development_dependency 'actionpack',                '~> 5.2.x'
-  gem.add_development_dependency 'activerecord',              '~> 5.2.x'
-  gem.add_development_dependency 'bundler',                   '1.16.1'
-  gem.add_development_dependency 'factory_bot',               '5.2.0'
-  gem.add_development_dependency 'nokogiri',                  '1.12.5'
-  gem.add_development_dependency 'pry',                       '0.12.2'
-  gem.add_development_dependency 'pry-nav',                   '0.3.0'
-  gem.add_development_dependency 'rails',                     '~> 5.2.x'
-  gem.add_development_dependency 'rails-controller-testing',  '1.0.4'
-  gem.add_development_dependency 'rake',                      '13.0.3'
+  gem.add_development_dependency 'actionpack',                '5.2.8.1'
+  gem.add_development_dependency 'activerecord',              '5.2.8.1'
+  gem.add_development_dependency 'bundler',                   '~> 2.3.14'
+  gem.add_development_dependency 'factory_bot',               '6.2.1'
+  gem.add_development_dependency 'minitest',                  '5.16.2'
+  gem.add_development_dependency 'nokogiri',                  '1.13.6'
+  gem.add_development_dependency 'pry',                       '0.14.1'
+  gem.add_development_dependency 'pry-nav',                   '1.0.0'
+  gem.add_development_dependency 'rails',                     '5.2.8.1'
+  gem.add_development_dependency 'rails-controller-testing',  '1.0.5'
+  gem.add_development_dependency 'rake',                      '13.0.6'
   gem.add_development_dependency 'reek',                      '6.0.3'
-  gem.add_development_dependency 'rspec',                     '3.9.0'
+  gem.add_development_dependency 'rspec',                     '3.11.0'
   gem.add_development_dependency 'rspec-collection_matchers', '1.2.0'
-  gem.add_development_dependency 'rspec-core',                '3.9.3'
-  gem.add_development_dependency 'rspec-expectations',        '3.9.4'
-  gem.add_development_dependency 'rspec-mocks',               '3.9.1'
-  gem.add_development_dependency 'rspec-rails',               '3.9.0'
-  gem.add_development_dependency 'rspec-support',             '3.9.4'
+  gem.add_development_dependency 'rspec-core',                '3.11.0'
+  gem.add_development_dependency 'rspec-expectations',        '3.11.0'
+  gem.add_development_dependency 'rspec-mocks',               '3.11.1'
+  gem.add_development_dependency 'rspec-rails',               '5.1.2'
+  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.17.1'
+  gem.add_development_dependency 'simplecov',                 '0.21.2'
   gem.add_development_dependency 'sqlite3',                   '1.4.2'
-  gem.add_development_dependency 'yard',                      '0.9.26'
+  gem.add_development_dependency 'tzinfo-data',               '~> 1.2022.1'
+  gem.add_development_dependency 'yard',                      '0.9.27'
   gem.add_development_dependency 'yardstick',                 '0.9.9'
 end

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/lib/azeroth/controller_interface.rb

@@ -42,6 +42,21 @@ module Azeroth
       controller.instance_variable_set("@#{variable}", value)
     end
 
+    # Forces a controller to run a block
+    #
+    # When the block is a +Proc+ that is evaluated,
+    # when it is a +Symbol+ or +String+, a method is called
+    #
+    # @return [Object] whatever the block returns
+    def run(block)
+      case block
+      when Proc
+        controller.instance_eval(&block)
+      else
+        controller.send(block)
+      end
+    end
+
     private
 
     attr_reader :controller

data/lib/azeroth/options.rb

@@ -21,6 +21,7 @@ module Azeroth
       before_save: nil,
       after_save: nil,
       build_with: nil,
+      update_with: nil,
       paginated: false,
       per_page: 20
     }.freeze
@@ -34,18 +35,13 @@ module Azeroth
       [only].flatten.map(&:to_sym) - [except].flatten.map(&:to_sym)
     end
 
-    # Returns event dispatcher
+    # Returns the event registry
     #
-    # Event dispatcher is responsible for
-    # sending events such as +before_save+
-    # to it's correct calling point
+    # Event registry is used to handle events within the request
     #
-    # @return [Jace::Dispatcher]
-    def event_dispatcher(event)
-      Jace::Dispatcher.new(
-        before: try("before_#{event}"),
-        after: try("after_#{event}")
-      )
+    # @return [Jace::Registry]
+    def event_registry
+      @event_registry ||= build_event_registry
     end
 
     alias paginated? paginated
@@ -110,6 +106,13 @@ module Azeroth
     #
     # @return [Symbol,Proc]
 
+    # @method update_with
+    # @api private
+    #
+    # Block or method name to be ran when updating the resource
+    #
+    # @return [Symbol,Proc]
+
     # @method paginated
     # @api private
     #
@@ -123,5 +126,22 @@ module Azeroth
     # Number of elements when pagination is active
     #
     # @return [Integer]
+
+    private
+
+    # private
+    #
+    # Builds the event registr
+    #
+    # The event registry is build using the before
+    # and after actions defined in optionsy
+    #
+    # @return [Jace::Registry]
+    def build_event_registry
+      Jace::Registry.new.tap do |registry|
+        registry.register(:save, :after, &after_save)
+        registry.register(:save, :before, &before_save)
+      end
+    end
   end
 end

data/lib/azeroth/params_builder.rb

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

data/lib/azeroth/request_handler/create.rb

@@ -47,12 +47,7 @@ module Azeroth
       def build_resource
         return collection.build(attributes) unless build_with
 
-        case build_with
-        when Proc
-          controller.instance_eval(&build_with)
-        else
-          controller.send(build_with)
-        end
+        controller.run(build_with)
       end
 
       # @private

data/lib/azeroth/request_handler/update.rb

@@ -8,6 +8,8 @@ module Azeroth
     class Update < RequestHandler
       private
 
+      delegate :update_with, to: :options
+
       # @private
       #
       # Updates and return an instance of the model
@@ -17,20 +19,35 @@ module Azeroth
       #
       # @return [Object]
       def resource
-        @resource ||= update_resource
+        @resource ||= perform_update
       end
 
-      # build resource for update
+      # Update a resource saving it to the database
       #
-      # @return [Object]
-      def update_resource
-        controller.send(model.name).tap do |entry|
+      # @return [Object] updated resource
+      def perform_update
+        @resource = controller.send(model.name)
+        resource.tap do
           trigger_event(:save) do
-            entry.update(attributes)
+            update_and_save_resource
           end
         end
       end
 
+      # @private
+      #
+      # Update the resource
+      #
+      # This update happens by either by running update_with
+      # or directly updating the attributes in the object
+      #
+      # @return [Object] updated resource
+      def update_and_save_resource
+        return resource.update(attributes) unless update_with
+
+        controller.run(update_with)
+      end
+
       # @private
       #
       # Response status

data/lib/azeroth/request_handler.rb

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

data/lib/azeroth/resourceable/builder.rb

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

data/lib/azeroth/resourceable/class_methods.rb

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