graphiti 1.0.rc.19 → 1.0.rc.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8967c814b3b30a9726dbba1c4a842678583488b
-  data.tar.gz: da6879ff4f72a21e08ee468473271d6342329d5a
+SHA256:
+  metadata.gz: d9aba6937773f5fccd9d4728c4b9d359e1edc94aa160ec72fab31df0068d1a2c
+  data.tar.gz: 1d39ffdcb8c9ed1c543b2bac2c00ccf4c2814831a237369a2e56bb7ff65d2de2
 SHA512:
-  metadata.gz: 9d30c8a71c22c4e1d9628dd06a5ed14ca42c63bbe727bb0807b6af5e3ae59b0eede5d9cd38c4ad85a9fa62144685e0173f6c98490d72d05a1405489cdb1f3fcd
-  data.tar.gz: 8abc3efc907913886f694e9ab165bf3492955984cf9467b11d757604429dcbccf7faf06d94f2b9096aa17ec4a170eeec23ae081100effe590339489e53ac9b52
+  metadata.gz: e6e646ddf4069ee3563a8500291649fd62763594c54068bf50a2b044ca82696794a0de8aa40e5ea38e398de7808ffc853736a0978c2ccc56030cdadc0965ad4c
+  data.tar.gz: 3e294b2980ca2ab4f117d6e2ef888df7d37a529db9ac1491d44e349f7dd8582f677d2bbb291a40814e0ecc0c2360b2e63a711923ccfe088cd53c631535bd7127

data/.travis.yml

@@ -4,16 +4,16 @@ rvm:
 - 2.4
 - 2.5
 - 2.6
-
-script: bundle exec rspec && bundle exec appraisal install && bundle exec appraisal rails-5 rspec && bundle exec appraisal rails-4 rspec
+script: bundle exec rspec && bundle exec appraisal install && bundle exec appraisal
+  rails-5 rspec && bundle exec appraisal rails-4 rspec
 install: bundle install --retry=3 --jobs=3
-
 before_install:
 - gem install bundler -v '< 2'
-
 deploy:
   provider: rubygems
   api_key:
-    secure: WbnbSdU4Tje9FbrJp/H80vBRvFGU9MpgyOOr8VSZUxOHJxzppaVWNS15luY9RKyai6jCn32az5dkcdatm+ij4bbT5DcEP+JERON6bgMlVQ8H5OJ6WncdN4KzMLAP0nbHbdC6j6rin5v4Ex8hUWEfFb4A4TRjCdRVmXtgPmITGjgdkHKNFp1xpJLGk3ya5T5Ii4sG/HRjJ7KtY6/xOJC/6qR+o7OBNC3lCocfIuqz6mS146n5nAy037Utuf/UatB9l5KX9k543GdKDGoP/MaAgA6PiOn3fF2osboSw1/re1485wVY/EtO/nIvwhBY99HiZFSg7RVxdCvP0LeP9Tug48LFP8zCW2lJIokOH9dAEddk/IDVRqp+Jl/WhXr1QU7en1GuHqtBrWX8CQeYOIU1bQwguzTvWe/4a5DB70iUeSamTRYUvwgkEyD/91QywaFQKNjDBHc0Uo3D+55p/Q4oR2x3jmr8NS0Af1oIPJFCck58UgN1RSln4iUBdaqST0hMbzjhOpa6ZCShbwT/P9qJkkUbE4pY9gB+XY5PFiXkC/KoWWUpjXJ2ZNEDL1vBAVOeT77lAbXczhMmg38aMSRjW312z2o+YjsWs8Ti0U+ie/98UZRR2zoydfr3VmURpaCBpKmK4K+uRbau5h2/G4uOMHR7YmCiiU4dq0bGmb8iM48=
+    secure: aON6EPWgHZXVQs+n/glMjPJ5kMpeR25khDpYlFIM0Ggf2+xuT/yRMtGbNTYnB01v/v2s9tNWK6QlMGARCbKz/W6WS8VNwFxs4DO1IPY3XoyF8QaPlXVKfBLldjUoVx61zL5xtcv8uZqWT1ATY+DjHW3nQ875ss/GW8tw+UASG1uUEuPCE9z+rNa3xYnm2qSZOwhFWqs5bHRQcc3gF3O8Hy8r4aosYTAlYOSeGDToqTUq1Ws21dV4xnIo97Nhmh9SYBQcKpZk1qF9bUz4zqdKsDKAxHMJRShtILmhPxNpIqE5ZV0+Xt+cnwi11AZDhSgfoUqYO9t2uG562luAqTnEZEQl+Lmc+nx4nJTH6tcR3ri301k0O+qDZ3PgSojJvrUuNC8DDLbbsVJNHYycGOLclqQq1aNbgz9HayEE5s+AyklPcprJhngxA5WP80AtONAxxLt4OjrY0X80TvOi2b5nfIN7DowGmcLbRahnms98Yk6/i1vCNV4R9bO0AaqpGLV+L8sVp98Qquk2mpvB3Le4W89qm5int1y2FNJbgInBpY1UOsI3wLENt0npC1X/KVMJKkpHvk80rGccI5FIVRUDZ3YD77hi+s1busPSVQ/+l4QdTFHmWp13Pghf6hNaIwfNwFMHwM2Fkv8YXa4c1mWc1cY5WP1ELS8cEnjtmp/9Iuc=
+  gem: graphiti
   on:
     tags: true
+    repo: graphiti-api/graphiti

data/lib/graphiti.rb

@@ -61,7 +61,7 @@ require "graphiti/util/relationship_payload"
 require "graphiti/util/persistence"
 require "graphiti/util/validation_response"
 require "graphiti/util/sideload"
-require "graphiti/util/hooks"
+require "graphiti/util/transaction_hooks_recorder"
 require "graphiti/util/attribute_check"
 require "graphiti/util/serializer_attributes"
 require "graphiti/util/serializer_relationships"

data/lib/graphiti/resource.rb

@@ -121,6 +121,13 @@ module Graphiti
       end
     end
 
+    def after_commit(model, metadata)
+      hooks = self.class.config[:after_commit][metadata[:method]] || []
+      hooks.each do |hook|
+        instance_exec(model, metadata, &hook)
+      end
+    end
+
     def transaction
       response = nil
       begin
@@ -128,7 +135,7 @@ module Graphiti
           response = yield
         end
       rescue Errors::ValidationError => e
-        response = e.validation_response
+        response = { result: e.validation_response }
       end
       response
     end

data/lib/graphiti/resource/configuration.rb

@@ -181,6 +181,7 @@ module Graphiti
               sorts: {},
               pagination: nil,
               before_commit: {},
+              after_commit: {},
               attributes: {},
               extra_attributes: {},
               sideloads: {},

data/lib/graphiti/resource/dsl.rb

@@ -87,6 +87,13 @@ module Graphiti
           end
         end
 
+        def after_commit(only: [:create, :update, :destroy], &blk)
+          Array(only).each do |verb|
+            config[:after_commit][verb] ||= []
+            config[:after_commit][verb] << blk
+          end
+        end
+
         def attribute(name, type, options = {}, &blk)
           raise Errors::TypeNotFound.new(self, name, type) unless Types[type]
           attribute_option(options, :readable)

data/lib/graphiti/resource_proxy.rb

@@ -114,7 +114,7 @@ module Graphiti
     end
 
     def destroy
-      validator = @resource.transaction do
+      transaction_response = @resource.transaction do
         metadata = { method: :destroy }
         model = @resource.destroy(@query.filters[:id], metadata)
         model.instance_variable_set(:@__serializer_klass, @resource.serializer)
@@ -122,9 +122,10 @@ module Graphiti
           model, @payload
         validator.validate!
         @resource.before_commit(model, metadata)
-        validator
+
+        { result: validator }
       end
-      @data, success = validator.to_a
+      @data, success = transaction_response[:result].to_a
       success
     end
 
@@ -154,8 +155,8 @@ module Graphiti
     private
 
     def persist
-      @resource.transaction do
-        ::Graphiti::Util::Hooks.record do
+      transaction_response = @resource.transaction do
+        ::Graphiti::Util::TransactionHooksRecorder.record do
           model = yield
           validator = ::Graphiti::Util::ValidationResponse.new \
             model, @payload
@@ -163,6 +164,15 @@ module Graphiti
           validator
         end
       end
+
+      data, success = transaction_response[:result].to_a
+      if success
+        transaction_response[:after_commit_hooks].each do |hook|
+          hook.call
+        end
+      end
+
+      transaction_response[:result]
     end
   end
 end

data/lib/graphiti/util/persistence.rb

@@ -63,7 +63,9 @@ class Graphiti::Util::Persistence
     post_process(persisted, parents)
     post_process(persisted, children)
     before_commit = -> { @resource.before_commit(persisted, metadata) }
-    add_hook(before_commit)
+    add_hook(before_commit, :before_commit)
+    after_commit = -> { @resource.after_commit(persisted, metadata) }
+    add_hook(after_commit, :after_commit)
     persisted
   end
 
@@ -83,8 +85,8 @@ class Graphiti::Util::Persistence
     end
   end
 
-  def add_hook(prc)
-    ::Graphiti::Util::Hooks.add(prc)
+  def add_hook(prc, lifecycle_event)
+    ::Graphiti::Util::TransactionHooksRecorder.add(prc, lifecycle_event)
   end
 
   # The child's attributes should be modified to nil-out the
@@ -215,7 +217,7 @@ class Graphiti::Util::Persistence
       group.group_by { |g| g[:sideload] }.each_pair do |sideload, members|
         objects = members.map { |x| x[:object] }
         hook = -> { sideload.fire_hooks!(caller_model, objects, method) }
-        add_hook(hook)
+        add_hook(hook, :before_commit)
       end
     end
   end

data/lib/graphiti/util/transaction_hooks_recorder.rb

@@ -0,0 +1,72 @@
+module Graphiti
+  module Util
+    class TransactionHooksRecorder
+      # This is a thread-global singleton class which is used to capture
+      # the correct hooks to run when before and after transactions are
+      # committed.  Consuming code will call the #record method, which will
+      # yield to the passed block:
+      #
+      # ```ruby
+      # TransactionHooksRecorder.record do
+      #   TransactionHooksRecorder.add(->{ do_stuff() }, :before_commit)
+      #   TransactionHooksRecorder.add(->{ do_more_stuff() }, :after_commit)
+      #   {
+      #     result: do_the_main_thing_and_return_a_result()
+      #   }
+      # end
+      # ```
+      #
+      # before_commit hooks will be executed before the record method returns.
+      # All after_commit hooks will be added to the returned hash so that consumers
+      # can decide when and whether to execute the callbacks.
+      #
+      # Returns a hash with `result` and `after_commit_hooks` keys.
+      class << self
+        def record
+          reset_hooks
+
+          begin
+            result = yield
+            run(:before_commit)
+
+            unless result.kind_of?(::Hash)
+              result = { result: result }
+            end
+
+            result.tap do |r|
+              r[:after_commit_hooks] = hook_set(:after_commit)
+            end
+          ensure
+            reset_hooks
+          end
+        end
+
+        # Because hooks will be added from the outer edges of
+        # the graph, working inwards
+        def add(prc, lifecycle_event)
+          hook_set(lifecycle_event).unshift(prc)
+        end
+
+        def run(lifecycle_event)
+          _hooks[lifecycle_event].each { |h| h.call }
+        end
+
+        private
+        def _hooks
+          Thread.current[:_graphiti_hooks]
+        end
+
+        def reset_hooks
+          Thread.current[:_graphiti_hooks] = {
+            before_commit: [],
+            after_commit: [],
+          }
+        end
+
+        def hook_set(lifecycle_event)
+          _hooks[lifecycle_event]
+        end
+      end
+    end
+  end
+end

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "1.0.rc.19"
+  VERSION = "1.0.rc.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 1.0.rc.19
+  version: 1.0.rc.21
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2019-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -284,7 +284,6 @@ files:
 - lib/graphiti/util/class.rb
 - lib/graphiti/util/field_params.rb
 - lib/graphiti/util/hash.rb
-- lib/graphiti/util/hooks.rb
 - lib/graphiti/util/include_params.rb
 - lib/graphiti/util/link.rb
 - lib/graphiti/util/persistence.rb
@@ -294,6 +293,7 @@ files:
 - lib/graphiti/util/serializer_attributes.rb
 - lib/graphiti/util/serializer_relationships.rb
 - lib/graphiti/util/sideload.rb
+- lib/graphiti/util/transaction_hooks_recorder.rb
 - lib/graphiti/util/validation_response.rb
 - lib/graphiti/version.rb
 homepage: 
@@ -316,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Easily build jsonapi.org-compatible APIs

data/lib/graphiti/util/hooks.rb

@@ -1,33 +0,0 @@
-module Graphiti
-  module Util
-    class Hooks
-      def self.record
-        self.hooks = []
-        begin
-          yield.tap { run }
-        ensure
-          self.hooks = []
-        end
-      end
-
-      def self._hooks
-        Thread.current[:_graphiti_hooks] ||= []
-      end
-      private_class_method :_hooks
-
-      def self.hooks=(val)
-        Thread.current[:_graphiti_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