jsonapi_compliable 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10190f5b7e0cd15456e21552f847b9a41d5fae80
-  data.tar.gz: 002b8c3ffb2fe962e682182199519a8182a909a0
+  metadata.gz: f5fedeea577e5f906c540f5a4204450c98d70055
+  data.tar.gz: d38aa664cf50468fab2af7d1761acfa78d54f69c
 SHA512:
-  metadata.gz: 5744a2c7eba2af24ea476210cf9804fdbc16d0c636b6e9d55c586e198a6ddf196122f8e6e27029d7f723cd07670efbea3d6aa21d4368ece68152c212249dd0ca
-  data.tar.gz: dbae4b77df449427b11d0dd5135a722b713a11c8f7fd05d62192dbd13c043ce48fcd3517179fb72afef9a05d460aadc6a4137fda0ef200f1bd1b6f9a99eca2c8
+  metadata.gz: e14232a3b4a4e43ef1945f4ca49358dfb537e80803ef96bc24b84b0b56b020036a6090cd1cd4215445c070ba71f14b3149fb5f420ac71ff42be6b23811626abb
+  data.tar.gz: 0cdcb246386014a2f65074aa9ece19d97c2b575060ea97b74d740ad707937a8dbc1431f66fb311c6d4193f8083db07a2c384d5e72b647c616db0b015176d5139

data/lib/jsonapi_compliable/adapters/active_record_sideloading.rb

@@ -39,9 +39,9 @@ module JsonapiCompliable
               parent.send(:"#{association_name}=", relevant_child)
             end
           end
-        end
 
-        instance_eval(&blk) if blk
+          instance_eval(&blk) if blk
+        end
       end
 
       def has_one(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)

data/lib/jsonapi_compliable/sideload.rb

@@ -191,6 +191,50 @@ module JsonapiCompliable
       resource.disassociate(parent, child, association_name, type)
     end
 
+    HOOK_ACTIONS = [:save, :create, :update, :destroy, :disassociate]
+
+    # Configure post-processing hooks
+    #
+    # In particular, helpful for bulk operations. "after_save" will fire
+    # for any persistence method - +:create+, +:update+, +:destroy+, +:disassociate+.
+    # Use "only" and "except" keyword arguments to fire only for a
+    # specific persistence method.
+    #
+    # @example Bulk Notify Users on Invite
+    #   class ProjectResource < ApplicationResource
+    #     # ... code ...
+    #     allow_sideload :users, resource: UserResource do
+    #       # scope {}
+    #       # assign {}
+    #       after_save only: [:create] do |project, users|
+    #         UserMailer.invite(project, users).deliver_later
+    #       end
+    #     end
+    #   end
+    #
+    # @see #hooks
+    # @see Util::Persistence
+    def after_save(only: [], except: [], &blk)
+      actions = HOOK_ACTIONS - except
+      actions = only & actions
+      actions = [:save] if only.empty? && except.empty?
+      actions.each do |a|
+        hooks[:"after_#{a}"] << blk
+      end
+    end
+
+    # Get the hooks the user has configured
+    # @see #after_save
+    # @return hash of hooks, ie +{ after_create: #<Proc>}+
+    def hooks
+      @hooks ||= {}.tap do |h|
+        HOOK_ACTIONS.each do |a|
+          h[:"after_#{a}"] = []
+          h[:"before_#{a}"] = []
+        end
+      end
+    end
+
     # Define an attribute that groups the parent records. For instance, with
     # an ActiveRecord polymorphic belongs_to there will be a +parent_id+
     # and +parent_type+. We would want to group on +parent_type+:
@@ -340,6 +384,15 @@ module JsonapiCompliable
       end
     end
 
+    def fire_hooks!(parent, objects, method)
+      return unless self.hooks
+
+      hooks = self.hooks[:"after_#{method}"] + self.hooks[:after_save]
+      hooks.compact.each do |hook|
+        resource.instance_exec(parent, objects, &hook)
+      end
+    end
+
     private
 
     def nested_sideload_hash(sideload, processed)

data/lib/jsonapi_compliable/util/persistence.rb

@@ -27,6 +27,7 @@ class JsonapiCompliable::Util::Persistence
   # * associate parent objects with current object
   # * process children
   # * associate children
+  # * run post-process sideload hooks
   # * return current object
   #
   # @return the persisted model instance
@@ -36,14 +37,17 @@ class JsonapiCompliable::Util::Persistence
 
     persisted = persist_object(@meta[:method], @attributes)
     assign_temp_id(persisted, @meta[:temp_id])
+
     associate_parents(persisted, parents)
 
     children = process_has_many(@relationships, persisted) do |x|
       update_foreign_key(persisted, x[:attributes], x)
     end
 
-    associate_children(persisted, children)
-    persisted unless @meta[:method] == :destroy
+    associate_children(persisted, children) unless @meta[:method] == :destroy
+    post_process(persisted, parents)
+    post_process(persisted, children)
+    persisted
   end
 
   private
@@ -76,6 +80,9 @@ class JsonapiCompliable::Util::Persistence
   end
 
   def associate_parents(object, parents)
+    # No need to associate to destroyed objects
+    parents = parents.select { |x| x[:meta][:method] != :destroy }
+
     parents.each do |x|
       if x[:object] && object
         if x[:meta][:method] == :disassociate
@@ -88,6 +95,9 @@ class JsonapiCompliable::Util::Persistence
   end
 
   def associate_children(object, children)
+    # No need to associate destroyed objects
+    return if @meta[:method] == :destroy
+
     children.each do |x|
       if x[:object] && object
         if x[:meta][:method] == :disassociate
@@ -131,6 +141,16 @@ class JsonapiCompliable::Util::Persistence
     end
   end
 
+  def post_process(caller_model, processed)
+    groups = processed.group_by { |x| x[:meta][:method] }
+    groups.each_pair do |method, group|
+      group.group_by { |g| g[:sideload] }.each_pair do |sideload, members|
+        objects = members.map { |x| x[:object] }
+        sideload.fire_hooks!(caller_model, objects, method)
+      end
+    end
+  end
+
   def assign_temp_id(object, temp_id)
     object.instance_variable_set(:@_jsonapi_temp_id, temp_id)
   end

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable