azeroth 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b37d53edb3f9b83aca0a7b121040c8db535da8b40d1bbc863c4d0b368dabe65d
-  data.tar.gz: 567d011f2f370e24d4b182182cfed7d08e46e344e533f6caccc1529c1c318643
+  metadata.gz: fef3f6d11872a3a25c77900028239d743c809aa1aae8d59526df351a1c47e97c
+  data.tar.gz: ae58f2737c72e939067a86061dbc3ab20f1da0ef0d27615c753aacbebb0591d1
 SHA512:
-  metadata.gz: 8c89d250bf8825965909dcc57aac1adb333cc06995cc27e381a78a442fd3c0ce187d33f6b39b2f3a002eeb97e9ca5462a44d2f81ca957d3aa8810bd1441b8081
-  data.tar.gz: 0eb7564aa351c821bf88cf25d7ca3991eb239089b492dc31587526b437067f9436fdb175c86a7ca937fc457d76fb546e4c8cc5159236cc88145ed06ac215e3f6
+  metadata.gz: ed3b96c2b672b737239713899bfb8ef5546dd1e66d28327fb3a7a66540eede50e93f5e73a3890dcea0474eda4f4bceaaa6804da47a1ea174606430eac14afe93
+  data.tar.gz: ce7d30afc6594731f31aa0591c6747dd110db2f485557d51fffd14cb4f7199e1ab4ebbfb748109dc42da72bda1764de48bd25821461f1ddf15fc49c607a971be

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.9.0](https://www.rubydoc.info/gems/azeroth/0.9.0)
 
 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
 

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
@@ -110,6 +111,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
     #

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,33 @@ 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, 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/version.rb

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

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

@@ -30,6 +30,118 @@ describe Azeroth::RequestHandler::Update do
       end
     end
 
+    context 'when update_with option is given ' do
+      context 'with block' do
+        it_behaves_like 'a request handler' do
+          let(:block) do
+            proc do
+              document.assign_attributes(document_params)
+              document.name = "#{document.name}!"
+              document.save
+            end
+          end
+
+          let(:options_hash) do
+            {
+              update_with: block
+            }
+          end
+
+          let(:expected_resource) { document }
+
+          let(:extra_params) do
+            {
+              id: document.id,
+              document: {
+                name: 'New Name'
+              }
+            }
+          end
+
+          let(:expected_json) do
+            {
+              'name' => 'New Name!'
+            }
+          end
+
+          it 'updates the values given by request' do
+            expect { handler.process }
+              .to change { document.reload.name }
+              .from(document.name)
+              .to('New Name!')
+          end
+        end
+      end
+
+      context 'with symbol' do
+        it_behaves_like 'a request handler' do
+          let(:options_hash) do
+            {
+              update_with: :add_bang_name
+            }
+          end
+
+          let(:expected_resource) { document }
+
+          let(:extra_params) do
+            {
+              id: document.id,
+              document: {
+                name: 'New Name'
+              }
+            }
+          end
+
+          let(:expected_json) do
+            {
+              'name' => 'New Name!'
+            }
+          end
+
+          it 'updates the values given by request' do
+            expect { handler.process }
+              .to change { document.reload.name }
+              .from(document.name)
+              .to('New Name!')
+          end
+        end
+      end
+
+      context 'with string' do
+        it_behaves_like 'a request handler' do
+          let(:options_hash) do
+            {
+              update_with: 'add_bang_name'
+            }
+          end
+
+          let(:expected_resource) { document }
+
+          let(:extra_params) do
+            {
+              id: document.id,
+              document: {
+                name: 'New Name'
+              }
+            }
+          end
+
+          let(:expected_json) do
+            {
+              'name' => 'New Name!'
+            }
+          end
+
+          it 'updates the values given by request' do
+            expect { handler.process }
+              .to change { document.reload.name }
+              .from(document.name)
+              .to('New Name!')
+          end
+        end
+      end
+    end
+
     context 'with before_save block option' do
       it_behaves_like 'a request handler' do
         let(:block) do

data/spec/support/app/controllers/request_handler_controller.rb

@@ -28,4 +28,10 @@ class RequestHandlerController < ActionController::Base
     documents.where(reference: 'X-MAGIC-15')
              .build(document_params)
   end
+
+  def add_bang_name
+    document.assign_attributes(document_params)
+    document.name = "#{document.name}!"
+    document.save
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport