azeroth 0.6.5 → 0.7.4

data/lib/azeroth/resourceable.rb

@@ -21,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,18 +9,11 @@ module Azeroth
     module ClassMethods
       # Adds resource methods for resource
       #
-      # @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
+      # @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
@@ -124,6 +117,33 @@ module Azeroth
       #   #     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.5'
+  VERSION = '0.7.4'
 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

data/spec/controllers/pokemons_controller_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe PokemonsController do
+  let(:master) { create(:pokemon_master) }
+
+  describe 'POST create' do
+    let(:parameters) do
+      {
+        pokemon_master_id: master.id,
+        format: :json,
+        pokemon: { name: 'Bulbasaur' }
+      }
+    end
+
+    it 'creates pokemon' do
+      expect { post :create, params: parameters }
+        .to change(Pokemon, :count)
+        .by(1)
+    end
+
+    it 'updates pokemon to be favorite' do
+      expect { post :create, params: parameters }
+        .to change { master.reload.favorite_pokemon }
+        .from(nil)
+    end
+  end
+
+  describe 'POST update' do
+    let(:pokemon) { create(:pokemon) }
+    let(:master)  { pokemon.pokemon_master }
+
+    let(:parameters) do
+      {
+        pokemon_master_id: master.id,
+        id: pokemon.id,
+        format: :json,
+        pokemon: { name: 'Butterfree' }
+      }
+    end
+
+    it 'updates pokemon' do
+      expect { post :update, params: parameters }
+        .to change { pokemon.reload.name }
+        .from('Bulbasaur')
+        .to('Butterfree')
+    end
+
+    it 'updates pokemon to be favorite' do
+      expect { post :update, params: parameters }
+        .to change { pokemon.reload.favorite }
+        .from(nil)
+    end
+  end
+end

data/spec/dummy/app/controllers/pokemon_masters_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class PokemonMastersController < ApplicationController
+  include Azeroth::Resourceable
+
+  resource_for :pokemon_master,
+               only: %i[create update],
+               before_save: proc { pokemon_master.age = 10 }
+end

data/spec/dummy/app/controllers/pokemons_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+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

data/spec/dummy/config/routes.rb

@@ -8,4 +8,8 @@ Rails.application.routes.draw do
   resources :publishers, only: %i[create index] do
     resources :games, except: :delete
   end
+
+  resources :pokemon_masters, only: %i[create update] do
+    resources :pokemons, only: %i[create update]
+  end
 end

data/spec/lib/azeroth/request_handler/create_spec.rb

@@ -23,6 +23,278 @@ describe Azeroth::RequestHandler::Create do
           .by(1)
       end
     end
+
+    context 'with before_save block option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:block) do
+          value = 10
+          proc do
+            document.reference = "X-MAGIC-#{value}"
+          end
+        end
+
+        let(:options_hash) do
+          {
+            before_save: block
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-10'
+          }
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'changes entry before saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-10')
+        end
+      end
+    end
+
+    context 'with before_save symbol option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:options_hash) do
+          {
+            before_save: :add_magic_reference
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-15'
+          }
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'changes entry before saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-15')
+        end
+      end
+    end
+
+    context 'with after_save block option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:block) do
+          value = 10
+          proc do
+            document.update(reference: "X-MAGIC-#{value}")
+            Worker.perform(document.id)
+          end
+        end
+
+        let(:options_hash) do
+          {
+            after_save: block
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-10'
+          }
+        end
+
+        before do
+          allow(Worker).to receive(:perform)
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'trigger workers after saving' do
+          handler.process
+
+          expect(Worker).to have_received(:perform)
+            .with(Document.last.id)
+        end
+
+        it 'changes entry after saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-10')
+        end
+      end
+    end
+
+    context 'with after_save symbol option' do
+      it_behaves_like 'a request handler', status: :created do
+        let(:options_hash) do
+          {
+            after_save: :add_magic_reference_and_trigger
+          }
+        end
+
+        let(:extra_params) do
+          {
+            document: {
+              name: 'My Document'
+            }
+          }
+        end
+
+        let(:expected_json) do
+          {
+            'name' => 'My Document',
+            'reference' => 'X-MAGIC-15'
+          }
+        end
+
+        before do
+          allow(Worker).to receive(:perform)
+        end
+
+        it 'creates entry' do
+          expect { handler.process }
+            .to change(Document, :count)
+            .by(1)
+        end
+
+        it 'trigger workers after saving' do
+          handler.process
+
+          expect(Worker).to have_received(:perform)
+            .with(Document.last.id)
+        end
+
+        it 'changes entry after saving' do
+          handler.process
+
+          expect(Document.last.reference)
+            .to eq('X-MAGIC-15')
+        end
+      end
+    end
+  end
+
+  context 'with build_with as symbol' do
+    it_behaves_like 'a request handler', status: :created do
+      let(:options_hash) do
+        {
+          build_with: :build_magic_document
+        }
+      end
+
+      let(:extra_params) do
+        {
+          document: {
+            name: 'My Document'
+          }
+        }
+      end
+
+      let(:expected_json) do
+        {
+          'name' => 'My Document',
+          'reference' => 'X-MAGIC-15'
+        }
+      end
+
+      it 'creates entry' do
+        expect { handler.process }
+          .to change(Document, :count)
+          .by(1)
+      end
+
+      it 'builds entity with custom method' do
+        handler.process
+
+        expect(Document.last.reference)
+          .to eq('X-MAGIC-15')
+      end
+    end
+  end
+
+  context 'with build_with as block' do
+    it_behaves_like 'a request handler', status: :created do
+      let(:block) do
+        proc do
+          documents.where(reference: 'X-MAGIC-20')
+                   .build(document_params)
+        end
+      end
+
+      let(:options_hash) do
+        {
+          build_with: block
+        }
+      end
+
+      let(:extra_params) do
+        {
+          document: {
+            name: 'My Document'
+          }
+        }
+      end
+
+      let(:expected_json) do
+        {
+          'name' => 'My Document',
+          'reference' => 'X-MAGIC-20'
+        }
+      end
+
+      it 'creates entry' do
+        expect { handler.process }
+          .to change(Document, :count)
+          .by(1)
+      end
+
+      it 'builds entity with custom method' do
+        handler.process
+
+        expect(Document.last.reference)
+          .to eq('X-MAGIC-20')
+      end
+    end
   end
 
   context 'when payload is invalid' do