graphiti 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32e852f2ca9612b4aa23f76b56407c6630dfdedc3f92dd796e15371a328e07c
-  data.tar.gz: ad997863f7a4f3ead3d184e3568a42743b2bdbb517f2f7b6f64969923d2b83c4
+  metadata.gz: d55ad609644e718abecd160c32841a49fd66123c901a17c809279df9edc47e01
+  data.tar.gz: eb67647f916696ee9664619076335eaa5e19407b63b2a504b582e9fee9cf6e17
 SHA512:
-  metadata.gz: 17acf0e59cb4bbda082f8a977c6689fc24bb4889f96cb1978fd89954100cfdaf4143f6a38cb4c0ad16a74b42a40c81d2ce0e7e2d23337846dba178d3bc953059
-  data.tar.gz: f3eaab52d8880e40c915f743ff65049416181dfd80e73a2d6c6b443b050dd4e92ba4d3a93f71c416e1a6901ecfcc16d035aad604449caad868819a0d43e70358
+  metadata.gz: 92c82864cf79cc8e2bed3d87b1add842a5ac5f70aaf2fe130f2e03e9c44bc7a78e473121564f4bb7c7dca1617aba1df90b529d5724df4d61378ee27848bd4047
+  data.tar.gz: eb049661cd88e8636c658566d3c4fc882e13bbe6de33aa50744c4561404d4aef937bcbad66406886940d8dec388655b674fcab0efac9ac01fecbe35bc4d08cd1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Unreleased
+
+Features:
+
+- [158](https://github.com/graphiti-api/graphiti/pull/158) Filters options `allow_nil: true`
+  Option can be set at the resource level `Resource.filters_accept_nil_by_default = true`. 
+  By default this is set to false. (@zeisler)
+- [157](https://github.com/graphiti-api/graphiti/pull/157) Using attribute option schema: false.
+  This option is default true and is not effected by only and except options. (@zeisler)
+
 ## 1.1.0
 
 Features:
@@ -36,6 +46,11 @@ Fixes:
 
 ### master (unreleased)
 
+Features:
+
+- [#153](https://github.com/graphiti-api/graphiti/pull/153) Add after_graph_persist hook.
+  This hook fires after the graph of resources is persisted and before validation. (@A-Boudi)
+
 <!-- ### [version (YYYY-MM-DD)](diff_link) -->
 <!-- Breaking changes:-->
 <!-- Features:-->

data/graphiti.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "jsonapi-serializable", "~> 0.3.0"
   spec.add_dependency "jsonapi-renderer", "0.2.0"
-  spec.add_dependency "dry-types", "~> 0.15"
+  spec.add_dependency "dry-types", ">= 0.15.0", "< 2.0"
   spec.add_dependency "graphiti_errors", "~> 1.1.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
   spec.add_dependency "activesupport", ">= 4.1"

data/lib/graphiti/resource.rb

@@ -112,6 +112,13 @@ module Graphiti
       adapter.resolve(scope)
     end
 
+    def after_graph_persist(model, metadata)
+      hooks = self.class.config[:after_graph_persist][metadata[:method]] || []
+      hooks.each do |hook|
+        instance_exec(model, metadata, &hook)
+      end
+    end
+
     def before_commit(model, metadata)
       hooks = self.class.config[:before_commit][metadata[:method]] || []
       hooks.each do |hook|

data/lib/graphiti/resource/configuration.rb

@@ -78,8 +78,10 @@ module Graphiti
           :attributes_writable_by_default,
           :attributes_sortable_by_default,
           :attributes_filterable_by_default,
+          :attributes_schema_by_default,
           :relationships_readable_by_default,
-          :relationships_writable_by_default
+          :relationships_writable_by_default,
+          :filters_accept_nil_by_default
 
         class << self
           prepend Overrides
@@ -97,8 +99,10 @@ module Graphiti
           default(klass, :attributes_writable_by_default, true)
           default(klass, :attributes_sortable_by_default, true)
           default(klass, :attributes_filterable_by_default, true)
+          default(klass, :attributes_schema_by_default, true)
           default(klass, :relationships_readable_by_default, true)
           default(klass, :relationships_writable_by_default, true)
+          default(klass, :filters_accept_nil_by_default, false)
 
           unless klass.config[:attributes][:id]
             klass.attribute :id, :integer_id
@@ -186,6 +190,7 @@ module Graphiti
               sort_all: nil,
               sorts: {},
               pagination: nil,
+              after_graph_persist: {},
               before_commit: {},
               after_commit: {},
               attributes: {},

data/lib/graphiti/resource/dsl.rb

@@ -32,6 +32,7 @@ module Graphiti
               dependencies: opts[:dependent],
               required: required,
               operators: operators.to_hash,
+              allow_nil: opts.fetch(:allow_nil, filters_accept_nil_by_default)
             }
           elsif (type = args[0])
             attribute name, type, only: [:filterable], allow: opts[:allow]
@@ -81,6 +82,13 @@ module Graphiti
           }
         end
 
+        def after_graph_persist(only: [:create, :update, :destroy], &blk)
+          Array(only).each do |verb|
+            config[:after_graph_persist][verb] ||= []
+            config[:after_graph_persist][verb] << blk
+          end
+        end
+
         def before_commit(only: [:create, :update, :destroy], &blk)
           Array(only).each do |verb|
             config[:before_commit][verb] ||= []
@@ -101,6 +109,7 @@ module Graphiti
           attribute_option(options, :writable)
           attribute_option(options, :sortable)
           attribute_option(options, :filterable)
+          attribute_option(options, :schema, true)
           options[:type] = type
           options[:proc] = blk
           config[:attributes][name] = options
@@ -151,11 +160,11 @@ module Graphiti
           Util::SerializerAttributes.new(self, extra_attributes, true).apply
         end
 
-        def attribute_option(options, name)
+        def attribute_option(options, name, exclusive = false)
           if options[name] != false
-            default = if (only = options[:only])
+            default = if (only = options[:only]) && !exclusive
               Array(only).include?(name) ? true : false
-            elsif (except = options[:except])
+            elsif (except = options[:except]) && !exclusive
               Array(except).include?(name) ? false : true
             else
               send(:"attributes_#{name}_by_default")

data/lib/graphiti/resource_proxy.rb

@@ -121,6 +121,7 @@ module Graphiti
         metadata = {method: :destroy}
         model = @resource.destroy(@query.filters[:id], metadata)
         model.instance_variable_set(:@__serializer_klass, @resource.serializer)
+        @resource.after_graph_persist(model, metadata)
         validator = ::Graphiti::Util::ValidationResponse.new \
           model, @payload
         validator.validate!
@@ -161,6 +162,7 @@ module Graphiti
       transaction_response = @resource.transaction do
         ::Graphiti::Util::TransactionHooksRecorder.record do
           model = yield
+          ::Graphiti::Util::TransactionHooksRecorder.run_graph_persist_hooks
           validator = ::Graphiti::Util::ValidationResponse.new \
             model, @payload
           validator.validate!

data/lib/graphiti/schema.rb

@@ -131,7 +131,7 @@ module Graphiti
     def attributes(resource)
       {}.tap do |attrs|
         resource.attributes.each_pair do |name, config|
-          if config.values_at(:readable, :writable).any?
+          if config.values_at(:readable, :writable).any? && config[:schema]
             attrs[name] = {
               type: config[:type].to_s,
               readable: flag(config[:readable]),
@@ -166,6 +166,8 @@ module Graphiti
     def sorts(resource)
       {}.tap do |s|
         resource.sorts.each_pair do |name, sort|
+          next unless resource.attributes[name][:schema]
+
           config = {}
           config[:only] = sort[:only] if sort[:only]
           attr = resource.attributes[name]
@@ -180,6 +182,8 @@ module Graphiti
     def filters(resource)
       {}.tap do |f|
         resource.filters.each_pair do |name, filter|
+          next unless resource.attributes[name][:schema]
+
           config = {
             type: filter[:type].to_s,
             operators: filter[:operators].keys.map(&:to_s),

data/lib/graphiti/scoping/filter.rb

@@ -54,6 +54,7 @@ module Graphiti
           unless type[:canonical_name] == :hash || !value.is_a?(String)
             value = parse_string_value(filter.values[0], value)
           end
+          value = parse_string_null(filter.values[0], value)
           validate_singular(resource, filter, value)
           value = coerce_types(filter.values[0], param_name.to_sym, value)
           validate_allowlist(resource, filter, value)
@@ -150,8 +151,6 @@ module Graphiti
     # JSON of
     # {{{ "id": 1 }}} becomes { 'id' => 1 }
     def parse_string_value(filter, value)
-      return value if !!filter[:single]
-
       type = Graphiti::Types[filter[:type]]
       array_or_string = [:string, :array].include?(type[:canonical_name])
       if (arr = value.scan(/\[.*?\]/)).present? && array_or_string
@@ -164,12 +163,12 @@ module Graphiti
         }
         value = value[0] if value.length == 1
       else
-        value = parse_string_arrays(value)
+        value = parse_string_arrays(value, !!filter[:single])
       end
       value
     end
 
-    def parse_string_arrays(value)
+    def parse_string_arrays(value, singular_filter)
       # Find the quoted strings
       quotes = value.scan(/{{.*?}}/)
       # remove them from the rest
@@ -177,11 +176,21 @@ module Graphiti
       # remove the quote characters from the quoted strings
       quotes.each { |q| q.gsub!("{{", "").gsub!("}}", "") }
       # merge everything back together into an array
-      value = Array(value.split(",")) + quotes
+      if singular_filter
+        value = Array(value) + quotes
+      else
+        value = Array(value.split(",")) + quotes
+      end
       # remove any blanks that are left
       value.reject! { |v| v.length.zero? }
       value = value[0] if value.length == 1
       value
     end
+
+    def parse_string_null(filter, value)
+      return if value == "null" && filter[:allow_nil]
+
+      value
+    end
   end
 end

data/lib/graphiti/types.rb

@@ -13,7 +13,7 @@ module Graphiti
           ::DateTime.parse(input.to_s)
         end
       end
-      input = Dry::Types["json.date_time"][input]
+      input = Dry::Types["json.date_time"][input] if input.is_a?(::String)
       Dry::Types["strict.date_time"][input] if input
     }
 
@@ -25,7 +25,8 @@ module Graphiti
           ::DateTime.parse(input.to_s)
         end
       end
-      input = Dry::Types["json.date_time"][input]
+
+      input = Dry::Types["json.date_time"][input] if input.is_a?(::String)
       Dry::Types["strict.date_time"][input].iso8601 if input
     }
 
@@ -36,13 +37,13 @@ module Graphiti
 
     Date = create(::Date) { |input|
       input = ::Date.parse(input.to_s) if input.is_a?(::Time)
-      input = Dry::Types["json.date"][input]
+      input = Dry::Types["json.date"][input] if input.is_a?(::String)
       Dry::Types["strict.date"][input] if input
     }
 
     PresentDate = create(::Date) { |input|
       input = ::Date.parse(input.to_s) if input.is_a?(::Time)
-      input = Dry::Types["json.date"][input]
+      input = Dry::Types["json.date"][input] if input.is_a?(::String)
       Dry::Types["strict.date"][input]
     }
 

data/lib/graphiti/util/persistence.rb

@@ -60,6 +60,8 @@ class Graphiti::Util::Persistence
 
     post_process(persisted, parents)
     post_process(persisted, children)
+    after_graph_persist = -> { @resource.after_graph_persist(persisted, metadata) }
+    add_hook(after_graph_persist, :after_graph_persist)
     before_commit = -> { @resource.before_commit(persisted, metadata) }
     add_hook(before_commit, :before_commit)
     after_commit = -> { @resource.after_commit(persisted, metadata) }

data/lib/graphiti/util/transaction_hooks_recorder.rb

@@ -41,6 +41,10 @@ module Graphiti
           end
         end
 
+        def run_graph_persist_hooks
+          run(:after_graph_persist)
+        end
+
         # Because hooks will be added from the outer edges of
         # the graph, working inwards
         def add(prc, lifecycle_event)
@@ -59,6 +63,7 @@ module Graphiti
 
         def reset_hooks
           Thread.current[:_graphiti_hooks] = {
+            after_graph_persist: [],
             before_commit: [],
             after_commit: [],
           }

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -42,16 +42,22 @@ dependencies:
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: graphiti_errors
   requirement: !ruby/object:Gem::Requirement
@@ -338,8 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Easily build jsonapi.org-compatible APIs