jsonapi_compliable 0.11.22 → 0.11.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a39b1b919948cf402b0d9d0bbeedd2fac003f78
-  data.tar.gz: 27f32e6407b6630a9d10d6f7881f6b309f3aa130
+  metadata.gz: 48d259ac76e47a2e25542f5131358558e150d4a9
+  data.tar.gz: a23b4c69617f2751d8a6715cd94864564683ea27
 SHA512:
-  metadata.gz: 79556dc3d297f38e5be9d4f8e462ccf5d3cf1928d64299c2da9eac72b1fb729c52b04a76f7d388917c791c6f2b82f684289f65dc5a40c5d2a402e5d8042722ec
-  data.tar.gz: 1d999e08ebbf82e359d9481c1d4deb167c589ef9db460bd0d191b29a30ee0a6204fc6f50be8cdfe5be62c5d4359a2c89afa66019989f2e923ac14485c005ff01
+  metadata.gz: 5a6776c91e370adabf118580498abeaaae607c0dd7ad07c4205fa895da978d2ffac0b85a154cb3e58f0f5d72316c3d27ef1042e8c96754494f67d229e527f3eb
+  data.tar.gz: 373820d5666c3afec279519198b3e58fdffdfe3d87363e6172339cdf57d1cb2041c29acb7389ab1b148f3785f3b381e9f7975f18bc21658b1381d80a62e3de1a

data/lib/jsonapi_compliable.rb

@@ -24,6 +24,7 @@ require "jsonapi_compliable/util/relationship_payload"
 require "jsonapi_compliable/util/persistence"
 require "jsonapi_compliable/util/validation_response"
 require "jsonapi_compliable/util/sideload"
+require "jsonapi_compliable/util/hooks"
 
 # require correct jsonapi-rb before extensions
 if defined?(Rails)

data/lib/jsonapi_compliable/adapters/active_record_sideloading.rb

@@ -99,8 +99,7 @@ module JsonapiCompliable
               .class.reflections[through.to_s].klass.table_name
 
             _scope.call
-              .joins(through)
-              .preload(through) # otherwise n+1 as we reference in #assign
+              .includes(through)
               .where(table_name => { fk => parent_ids })
               .distinct
           end

data/lib/jsonapi_compliable/base.rb

@@ -253,9 +253,20 @@ module JsonapiCompliable
       end
     end
 
+    # Delete the model
+    # Any error, including validation errors, will roll back the transaction.
+    #
+    # Note: +before_commit+ hooks still run unless excluded
+    #
+    # @return [Util::ValidationResponse]
     def jsonapi_destroy
-      _persist do
-        jsonapi_resource.destroy(params[:id])
+      jsonapi_resource.transaction do
+        model = jsonapi_resource.destroy(params[:id])
+        validator = ::JsonapiCompliable::Util::ValidationResponse.new \
+          model, deserialized_params
+        validator.validate!
+        jsonapi_resource.before_commit(model, :destroy)
+        validator
       end
     end
 
@@ -321,6 +332,18 @@ module JsonapiCompliable
 
     private
 
+    def _persist
+      jsonapi_resource.transaction do
+        ::JsonapiCompliable::Util::Hooks.record do
+          model = yield
+          validator = ::JsonapiCompliable::Util::ValidationResponse.new \
+            model, deserialized_params
+          validator.validate!
+          validator
+        end
+      end
+    end
+
     def force_includes?
       not deserialized_params.data.nil?
     end
@@ -330,16 +353,5 @@ module JsonapiCompliable
       JSONAPI::Serializable::Renderer.new
         .render(opts.delete(:jsonapi), opts).to_json
     end
-
-    def _persist
-      validation_response = nil
-      jsonapi_resource.transaction do
-        object = yield
-        validation_response = Util::ValidationResponse.new \
-          object, deserialized_params
-        raise Errors::ValidationError unless validation_response.to_a[1]
-      end
-      validation_response
-    end
   end
 end

data/lib/jsonapi_compliable/errors.rb

@@ -1,7 +1,48 @@
 module JsonapiCompliable
   module Errors
     class BadFilter < StandardError; end
-    class ValidationError < StandardError; end
+
+    class ValidationError < StandardError
+      attr_reader :validation_response
+
+      def initialize(validation_response)
+        @validation_response = validation_response
+      end
+    end
+
+    class MissingSerializer < StandardError
+      def initialize(class_name, serializer_name)
+        @class_name = class_name
+        @serializer_name = serializer_name
+      end
+
+      def message
+        <<-MSG
+Could not find serializer for class '#{@class_name}'!
+
+Looked for '#{@serializer_name}' but doesn't appear to exist.
+
+Use a custom Inferrer if you'd like different lookup logic.
+        MSG
+      end
+    end
+
+    class MissingSerializer < StandardError
+      def initialize(class_name, serializer_name)
+        @class_name = class_name
+        @serializer_name = serializer_name
+      end
+
+      def message
+        <<-MSG
+Could not find serializer for class '#{@class_name}'!
+
+Looked for '#{@serializer_name}' but doesn't appear to exist.
+
+Use a custom Inferrer if you'd like different lookup logic.
+        MSG
+      end
+    end
 
     class UnsupportedPageSize < StandardError
       def initialize(size, max)

data/lib/jsonapi_compliable/resource.rb

@@ -257,6 +257,29 @@ module JsonapiCompliable
       config[:model] = klass
     end
 
+    # Register a hook that fires AFTER all validation logic has run -
+    # including validation of nested objects - but BEFORE the transaction
+    # has closed.
+    #
+    # Helpful for things like "contact this external service after persisting
+    # data, but roll everything back if there's an error making the service call"
+    #
+    # @param [Hash] +only: [:create, :update, :destroy]+
+    def self.before_commit(only: [:create, :update, :destroy], &blk)
+      Array(only).each do |verb|
+        config[:before_commit][verb] = blk
+      end
+    end
+
+    # Actually fire the before commit hooks
+    #
+    # @see .before_commit
+    # @api private
+    def before_commit(model, method)
+      hook = self.class.config[:before_commit][method]
+      hook.call(model) if hook
+    end
+
     # Define custom sorting logic
     #
     # @example Sort on alternate table
@@ -391,6 +414,7 @@ module JsonapiCompliable
           sorting: nil,
           pagination: nil,
           model: nil,
+          before_commit: {},
           adapter: Adapters::Abstract.new
         }
       end
@@ -705,7 +729,8 @@ module JsonapiCompliable
         adapter.transaction(model) do
           response = yield
         end
-      rescue Errors::ValidationError
+      rescue Errors::ValidationError => e
+        response = e.validation_response
       end
       response
     end

data/lib/jsonapi_compliable/util/hooks.rb

@@ -0,0 +1,33 @@
+module JsonapiCompliable
+  module Util
+    class Hooks
+      def self.record
+        self.hooks = []
+        begin
+          yield.tap { run }
+        ensure
+          self.hooks = []
+        end
+      end
+
+      def self._hooks
+        Thread.current[:_compliable_hooks] ||= []
+      end
+      private_class_method :_hooks
+
+      def self.hooks=(val)
+        Thread.current[:_compliable_hooks] = val
+      end
+
+      # Because hooks will be added from the outer edges of
+      # the graph, working inwards
+      def self.add(prc)
+        _hooks.unshift(prc)
+      end
+
+      def self.run
+        _hooks.each { |h| h.call }
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/persistence.rb

@@ -27,10 +27,11 @@ class JsonapiCompliable::Util::Persistence
   # * associate parent objects with current object
   # * process children
   # * associate children
+  # * record hooks for later playback
   # * run post-process sideload hooks
   # * return current object
   #
-  # @return the persisted model instance
+  # @return a model instance
   def run
     parents = process_belongs_to(@relationships)
     update_foreign_key_for_parents(parents)
@@ -45,13 +46,20 @@ class JsonapiCompliable::Util::Persistence
     end
 
     associate_children(persisted, children) unless @meta[:method] == :destroy
+
     post_process(persisted, parents)
     post_process(persisted, children)
+    before_commit = -> { @resource.before_commit(persisted, @meta[:method]) }
+    add_hook(before_commit)
     persisted
   end
 
   private
 
+  def add_hook(prc)
+    ::JsonapiCompliable::Util::Hooks.add(prc)
+  end
+
   # The child's attributes should be modified to nil-out the
   # foreign_key when the parent is being destroyed or disassociated
   #
@@ -147,7 +155,8 @@ class JsonapiCompliable::Util::Persistence
     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)
+        hook = -> { sideload.fire_hooks!(caller_model, objects, method) }
+        add_hook(hook)
       end
     end
   end

data/lib/jsonapi_compliable/util/render_options.rb

@@ -6,12 +6,6 @@ module JsonapiCompliable
       def self.generate(object, query_hash, overrides = {})
         resolved = object.respond_to?(:resolve) ? object.resolve : object
 
-        inferrer = ::Hash.new do |h, k|
-          names = k.to_s.split('::')
-          klass = names.pop
-          h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
-        end
-
         fields = query_hash[:fields].dup
         extra_fields = query_hash[:extra_fields]
 
@@ -37,6 +31,21 @@ module JsonapiCompliable
 
         options
       end
+
+      def self.inferrer
+        ::Hash.new do |h, k|
+          names = k.to_s.split('::')
+          klass = names.pop
+          serializer_name = [*names, "Serializable#{klass}"].join('::')
+          serializer = serializer_name.safe_constantize
+          if serializer
+            h[k] = serializer
+          else
+            raise Errors::MissingSerializer.new(k, serializer_name)
+          end
+        end
+      end
+      private_class_method :inferrer
     end
   end
 end

data/lib/jsonapi_compliable/util/validation_response.rb

@@ -30,6 +30,13 @@ class JsonapiCompliable::Util::ValidationResponse
     [object, success?]
   end
 
+  def validate!
+    unless success?
+      raise ::JsonapiCompliable::Errors::ValidationError.new(self)
+    end
+    self
+  end
+
   private
 
   def valid_object?(object)

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.11.22"
+  VERSION = "0.11.23"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.11.22
+  version: 0.11.23
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -245,6 +245,7 @@ files:
 - lib/jsonapi_compliable/stats/payload.rb
 - lib/jsonapi_compliable/util/field_params.rb
 - lib/jsonapi_compliable/util/hash.rb
+- lib/jsonapi_compliable/util/hooks.rb
 - lib/jsonapi_compliable/util/include_params.rb
 - lib/jsonapi_compliable/util/persistence.rb
 - lib/jsonapi_compliable/util/relationship_payload.rb