azeroth 0.6.3 → 0.7.2

data/lib/azeroth/decorator/options.rb

@@ -13,7 +13,7 @@ module Azeroth
       DEFAULT_OPTIONS = {
         as: nil,
         if: nil,
-        decorator: nil
+        decorator: true
       }.freeze
 
       with_options DEFAULT_OPTIONS
@@ -62,8 +62,8 @@ module Azeroth
       # #as_json call on value
       #
       # @return [TrueClass,FalseClass]
-      def any_decorator?
-        decorator != false
+      def decorator_defined?
+        decorator.is_a?(Class)
       end
     end
   end

data/lib/azeroth/model.rb

@@ -62,6 +62,8 @@ module Azeroth
     #
     # @return [Azeroth::Options]
 
+    delegate :decorator, to: :options
+
     # @private
     #
     # Returns decorator class for the object
@@ -85,7 +87,7 @@ module Azeroth
     # @return [Azeroth::Decorator,DummyDecorator]
     def calculate_decorator_class
       return DummyDecorator unless options.decorator
-      return options.decorator if options.decorator.is_a?(Class)
+      return decorator if decorator.is_a?(Class)
 
       klass::Decorator
     rescue NameError

data/lib/azeroth/options.rb

@@ -10,10 +10,16 @@ module Azeroth
   #   Sinclair::Options
   class Options < Sinclair::Options
     # Default options
+    #
+    # @api public
+    #
+    # @see Resourceable::ClassMethods#resource_for
     DEFAULT_OPTIONS = {
       only: %i[create destroy edit index new show update],
       except: [],
-      decorator: true
+      decorator: true,
+      before_save: nil,
+      build_with: nil
     }.freeze
 
     with_options DEFAULT_OPTIONS
@@ -25,6 +31,19 @@ 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}")
+      )
+    end
+
     # @method only
     # @api private
     #
@@ -50,5 +69,23 @@ module Azeroth
     # model.as_json
     #
     # @return [Decorator,TrueClass,FalseClass]
+
+    # @method before_save
+    # @api private
+    #
+    # Block or method name to be run before save
+    #
+    # The given method or block will be ran
+    # before committing changes in models
+    # to database
+    #
+    # @return [Symbol,Proc]
+
+    # @method build_with
+    # @api private
+    #
+    # Block or method name to be ran when building the resource
+    #
+    # @return [Symbol,Proc]
   end
 end

data/lib/azeroth/request_handler.rb

@@ -18,9 +18,10 @@ module Azeroth
 
     # @param controller [ApplicationController]
     # @param model [Azeroth::Model]
-    def initialize(controller, model)
+    def initialize(controller, model, options)
       @controller = controller
       @model = model
+      @options = options
     end
 
     # process the request
@@ -44,7 +45,7 @@ module Azeroth
 
     private
 
-    attr_reader :controller, :model
+    attr_reader :controller, :model, :options
     # @method controller
     # @api private
     # @private
@@ -61,6 +62,14 @@ module Azeroth
     #
     # @return [Azeroth::Model]
 
+    # @method options
+    # @api private
+    # @private
+    #
+    # Handling options
+    #
+    # @return [Azeroth::Options]
+
     delegate :params, to: :controller
     # @method params
     # @api private
@@ -104,5 +113,33 @@ module Azeroth
     def status
       :ok
     end
+
+    # @private
+    #
+    # Run a block triggering the event
+    #
+    # @return [Object] Result of given block
+    def trigger_event(event, &block)
+      options.event_dispatcher(event)
+             .dispatch(controller, &block)
+    end
+
+    # @private
+    #
+    # Attributes to be used on resource creating
+    #
+    # @return [Hash]
+    def attributes
+      @attributes ||= controller.send("#{model.name}_params")
+    end
+
+    # @private
+    #
+    # Collection scope of the resource
+    #
+    # @return [ActiveRecord::Relation]
+    def collection
+      @collection = controller.send(model.plural)
+    end
   end
 end

data/lib/azeroth/request_handler/create.rb

@@ -8,6 +8,8 @@ module Azeroth
     class Create < RequestHandler
       private
 
+      delegate :build_with, to: :options
+
       # @private
       #
       # Creates and return an instance of the model
@@ -17,16 +19,40 @@ module Azeroth
       #
       # @return [Object]
       def resource
-        @resource ||= build_resource
+        @resource ||= build_and_save_resource
       end
 
-      # build resource for create
+      # @private
+      #
+      # build resource for create and save it
       #
       # @return [Object]
+      def build_and_save_resource
+        @resource = build_resource
+        controller.instance_variable_set("@#{model.name}", resource)
+
+        trigger_event(:save) do
+          resource.tap(&:save)
+        end
+      end
+
+      # @private
+      #
+      # build resource without saving it
+      #
+      # when +build_with+ option is given, the proc/method
+      # is called instead of collection.build
+      #
+      # @return [Object] resource built
       def build_resource
-        attributes = controller.send("#{model.name}_params")
-        collection = controller.send(model.plural)
-        collection.create(attributes)
+        return collection.build(attributes) unless build_with
+
+        case build_with
+        when Proc
+          controller.instance_eval(&build_with)
+        else
+          controller.send(build_with)
+        end
       end
 
       # @private

data/lib/azeroth/request_handler/update.rb

@@ -24,10 +24,10 @@ module Azeroth
       #
       # @return [Object]
       def update_resource
-        attributes = controller.send("#{model.name}_params")
-
         controller.send(model.name).tap do |entry|
-          entry.update(attributes)
+          trigger_event(:save) do
+            entry.update(attributes)
+          end
         end
       end
 

data/lib/azeroth/resourceable.rb

@@ -7,6 +7,10 @@ module Azeroth
   # @author Darthjee
   #
   # Concern for building controller methods for the routes
+  #
+  # @example (see Resourceable::ClassMethods#resource_for)
+  #
+  # @see Resourceable::ClassMethods
   module Resourceable
     extend ActiveSupport::Concern
 
@@ -17,6 +21,29 @@ module Azeroth
     autoload :Builder, 'azeroth/resourceable/builder'
     autoload :ClassMethods, 'azeroth/resourceable/class_methods'
 
+    class << self
+      # @method self.resource_for(name, **options)
+      # @api public
+      #
+      # @param name [String, Symbol] Name of the resource
+      # @param options [Hash] resource building options
+      # @option options only [Array<Symbol,String>] List of
+      #   actions to be built
+      # @option options except [Array<Symbol,String>] List of
+      #   actions to not to be built
+      # @option options decorator [Azeroth::Decorator,TrueClass,FalseClass]
+      #   Decorator class or flag allowing/disallowing decorators
+      # @option options before_save [Symbol,Proc] method/block
+      #   to be ran on the controller before saving the resource
+      # @option options build_with [Symbol,Proc] method/block
+      #   to be ran when building resource
+      #   (default proc { <resource_collection>.build(resource_params) }
+      #
+      # @return [Array<MethodDefinition>] list of methods created
+      #
+      # @see Options::DEFAULT_OPTIONS
+    end
+
     private
 
     # @api private

data/lib/azeroth/resourceable/class_methods.rb

@@ -9,13 +9,11 @@ module Azeroth
     module ClassMethods
       # Adds resource methods for resource
       #
-      # @param name [String, Symbol] Name of the resource
-      # @param (see Options#initialize)
-      # @option (see Options#initialize)
+      # @param (see Resourceable.resource_for)
+      # @option (see Resourceable.resource_for)
+      # @return (see Resourceable.resource_for)
       #
-      # @return [Array<MethodDefinition>] list of methods created
-      #
-      # @see Options
+      # @see (see Resourceable.resource_for)
       #
       # @example Controller without delete
       #   class DocumentsController < ApplicationController
@@ -30,6 +28,122 @@ module Azeroth
       #
       #     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
       def resource_for(name, **options)
         Builder.new(
           self, name, Azeroth::Options.new(options)

data/lib/azeroth/routes_builder.rb

@@ -62,13 +62,14 @@ module Azeroth
 
     def route_code(route)
       model_interface = model
+      options_object = options
       handler_class = Azeroth::RequestHandler.const_get(
         route.to_s.capitalize
       )
 
       proc do
         handler_class.new(
-          self, model_interface
+          self, model_interface, options_object
         ).process
       end
     end

data/lib/azeroth/version.rb

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

data/spec/controllers/pokemon_masters_controller_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe PokemonMastersController do
+  describe 'POST create' do
+    let(:parameters) do
+      {
+        format: :json,
+        pokemon_master: {
+          first_name: 'Ash'
+        }
+      }
+    end
+
+    it 'creates pokemon master' do
+      expect { post :create, params: parameters }
+        .to change(PokemonMaster, :count)
+        .by(1)
+    end
+
+    it 'updates pokemon master age' do
+      post :create, params: parameters
+
+      expect(PokemonMaster.last.age).to eq(10)
+    end
+  end
+
+  describe 'POST update' do
+    let(:master) do
+      create(:pokemon_master, age: 20, last_name: nil)
+    end
+
+    let(:parameters) do
+      {
+        id: master.id,
+        format: :json,
+        pokemon_master: { last_name: 'Joe' }
+      }
+    end
+
+    it 'updates pokemon master' do
+      expect { post :update, params: parameters }
+        .to change { master.reload.last_name }
+        .from(nil)
+        .to('Joe')
+    end
+
+    it 'updates pokemon master age' do
+      expect { post :update, params: parameters }
+        .to change { master.reload.age }
+        .from(20)
+        .to(10)
+    end
+  end
+end