graphiti-activegraph 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f43302a065e6583232921abe819bcea82bce10d85893b1cc80d132dd169ebbc0
-  data.tar.gz: 4aa5cd9c5486ac50d4d0f8844433e931ce55998777aa740014e1a9281b797471
+  metadata.gz: 4e2e06c991422f868705fa49e812c51af9c537366fac6246ebfc882969e7bdae
+  data.tar.gz: 7fc80649e1455f255450e00dcf6c66fe0ff889d1d74e16ebe123dc70362e8266
 SHA512:
-  metadata.gz: 5604a91acd31eeeecbe45bd7defa41fd2b24612be053463dec11e48d61cc81ed52005050ebb077d5ba9172e1bb012e2bf6d8354a1d27385aeb4276f66ce92283
-  data.tar.gz: 37ed8852db96fd2dc357afce65069c96ddd664b3c3d33628ab50dfa83aa43d82a5336d779d98d5df59a0f968c20ee7667c4593ce691f95724d548bc146805eba
+  metadata.gz: 3db8cee492d4ac415bddc3a44cf755cfa4f32a0b3865f90821c62a681838776d48c6e12dff4fd30fafce88f204c56884c37bc016bc4b71166fe572ec725ab1df
+  data.tar.gz: 8d7f27a547460a725247b4b28ea629fec384f20e0255f29771c6f805e096063f8bfb5138e576f7ef7d6c7eb1acfe4cfca735940d2852dee41fee3042462ca604

data/.gitignore

@@ -45,7 +45,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+/Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/CHANGELOG.md

@@ -56,6 +56,12 @@ Features:
 
 - Added preliminary support for Sideload backed by function instead of model association
 
+## 0.1.25 (04-12-2024)
+
+Features:
+
+- Added support to preload extra_fields for the main resource, replacing N+1 queries with a single query. This does not apply to sideloaded resources.
+
 <!-- ### [version (DD-MM-YYYY)] -->
 <!-- Breaking changes:-->
 <!-- Features:-->

data/graphiti-activegraph.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "faraday", "~> 0.15"
   spec.add_development_dependency "kaminari", "~> 0.17"
   spec.add_development_dependency "bundler"
+  # dependency conflict introduced during runtime
+  # jar-dependencies is a default gem in JRuby and also a dependency in neo4j-ruby-driver
+  spec.add_development_dependency "jar-dependencies", "~> 0.4.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "graphiti_spec_helpers", "1.0.beta.4"
   spec.add_development_dependency "standard"

data/lib/graphiti/active_graph/concerns/path_relationships.rb

@@ -0,0 +1,44 @@
+module Graphiti::ActiveGraph::Concerns
+  module PathRelationships
+    def add_path_id_to_relationships!(params)
+      return params if path_relationships_updated?
+      detect_conflict(:id, @params[:id]&.to_s, attributes[:id]&.to_s)
+      path_map.each do |rel_name, path_value|
+        body_value = relationships.dig(rel_name, :attributes, :id)
+        if body_value
+          detect_conflict(rel_name, path_value&.to_s, body_value&.to_s)
+        else
+          update_params(params, rel_name, path_value)
+          update_realationships(rel_name, path_value)
+        end
+      end
+      path_relationships_updated!
+      params
+    end
+
+    private
+
+    def path_relationships_updated!
+      @path_relationships_updated = true
+    end
+
+    def path_relationships_updated?
+      @path_relationships_updated.present?
+    end
+
+    def update_params(params, rel_name, path_value)
+      params[:data] ||= {}
+      params[:data][:relationships] ||= {}
+      params[:data][:relationships][rel_name] = {
+        data: {
+          type: derive_resource_type(rel_name),
+          id: path_value
+        }
+      }
+    end
+
+    def update_realationships(rel_name, path_value)
+      relationships[rel_name] = { meta: {}, attributes: { id: path_value } }
+    end
+  end
+end

data/lib/graphiti/active_graph/deserializer.rb

@@ -1,5 +1,7 @@
 module Graphiti::ActiveGraph
-  module Deserializer
+  class Deserializer < Graphiti::Deserializer
+    include Concerns::PathRelationships
+
     class Conflict < StandardError
       attr_reader :key, :path_value, :body_value
 
@@ -14,13 +16,33 @@ module Graphiti::ActiveGraph
       end
     end
 
-    def initialize(payload, env=nil, model=nil, parent_map=nil)
+    def initialize(payload, env = nil, model = nil, parent_map = nil)
       super(payload)
 
       @params = payload
       @model = model
       @parent_map = parent_map || {}
       @env = env
+
+      return unless data.blank? && env && parsable_content?
+
+      raise ArgumentError, "JSON API payload must contain the 'data' key" 
+    end
+
+    def process_relationship_datum(datum)
+      {
+        meta: {
+          jsonapi_type: datum[:type],
+          temp_id: datum[:'temp-id'],
+          method: datum[:method]&.to_sym
+        },
+        attributes: datum[:id] ? { id: datum[:id] } : {},
+        relationships: {}
+      }
+    end
+
+    def meta_params
+      data[:meta] || {}
     end
 
     def process_relationships(relationship_hash)
@@ -33,6 +55,10 @@ module Graphiti::ActiveGraph
       end
     end
 
+    def relationship?(name)
+      relationships[name.to_sym].present?
+    end
+
     # change empty relationship as `disassociate` hash so they will be removed
     def process_nil_relationship(name)
       attributes = {}
@@ -62,45 +88,6 @@ module Graphiti::ActiveGraph
       results
     end
 
-    def add_path_id_to_relationships!(params)
-      return params if path_relationships_updated?
-      detect_conflict(:id, @params[:id]&.to_s, attributes[:id]&.to_s)
-      path_map.each do |rel_name, path_value|
-        body_value = relationships.dig(rel_name, :attributes, :id)
-        if body_value
-          detect_conflict(rel_name, path_value&.to_s, body_value&.to_s)
-        else
-          update_params(params, rel_name, path_value)
-          update_realationships(rel_name, path_value)
-        end
-      end
-      path_relationships_updated!
-      params
-    end
-
-    def path_relationships_updated!
-      @path_relationships_updated = true
-    end
-
-    def path_relationships_updated?
-      @path_relationships_updated.present?
-    end
-
-    def update_params(params, rel_name, path_value)
-      params[:data] ||= {}
-      params[:data][:relationships] ||= {}
-      params[:data][:relationships][rel_name] = {
-        data: {
-          type: derive_resource_type(rel_name),
-          id: path_value
-        }
-      }
-    end
-
-    def update_realationships(rel_name, path_value)
-      relationships[rel_name] = { meta: {}, attributes: { id: path_value } }
-    end
-
     def path_map
       map = @params.select { |key, _| key =~ /_id$/ }.permit!.to_h
       map = filter_keys(map) { |key| key.gsub(/_id$/, '').to_sym }
@@ -127,6 +114,10 @@ module Graphiti::ActiveGraph
 
     private
 
+    def parsable_content?
+      true
+    end
+
     def derive_resource_type(rel_name)
       if @model.include?(ActiveGraph::Node)
         @model.associations[rel_name].target_class.model_name.plural.to_s

data/lib/graphiti/active_graph/extensions/grouping/params.rb

@@ -0,0 +1,52 @@
+module Graphiti::ActiveGraph::Extensions::Grouping
+  class Params
+    attr_reader :params, :grouping_criteria_list, :resource_class
+    def initialize(params, resource_class)
+      @params = params
+      @grouping_criteria_list = params.fetch(:group_by, nil)&.split(',') || []
+      @resource_class = resource_class
+    end
+
+    def single_grouping_criteria?
+      grouping_criteria_list.size < 2
+    end
+
+    def grouping_criteria_on_attribute?
+      grouping_criteria_list.any? { |criteria| ends_with_attribute?(resource_class.model, criteria) }
+    end
+
+    def empty?
+      grouping_criteria_list.empty?
+    end
+
+    def ends_with_attribute?(model, criteria)
+      return false if criteria.blank?
+
+      last_segment_attribute?(model, criteria.split('.'))
+    end
+
+    private
+
+    def last_segment_attribute?(model, segments)
+      last_segment = segments.last
+      intermediate_model = traverse_to_last_associated_model(model, segments[0...-1])
+
+      intermediate_model && attribute?(intermediate_model, last_segment)
+    end
+
+    def traverse_to_last_associated_model(model, intermediate_segments)
+      intermediate_segments.each do |segment|
+        return false unless(model = associated_model(model, segment))
+      end
+      model
+    end
+
+    def attribute?(model, segment)
+      model.attribute_names.include?(segment)
+    end
+
+    def associated_model(model, segment)
+      model.associations[segment.to_sym]&.target_class
+    end
+  end
+end

data/lib/graphiti/active_graph/extensions/query_params.rb

@@ -0,0 +1,27 @@
+module Graphiti::ActiveGraph::Extensions
+  class QueryParams
+    attr_reader :params, :grouping_extra_params, :resource_class
+
+    def initialize(params, resource_class, grouping_extra_params: {})
+      @params = params
+      @resource_class = resource_class
+      @grouping_extra_params = grouping_extra_params
+    end
+
+    def group_by
+      Grouping::Params.new(params, resource_class)
+    end
+
+    def group_by_params
+      group_by_params_hash unless group_by.empty?
+    end
+
+    def group_by_params_hash
+      { group_by: group_by.grouping_criteria_list }.merge(grouping_extra_params)
+    end
+
+    def extra_field?(type, name)
+      params.dig(:extra_fields, type)&.include?(name.to_s)
+    end
+  end
+end

data/lib/graphiti/active_graph/request_validators/validator.rb

@@ -0,0 +1,9 @@
+module Graphiti::ActiveGraph
+  module RequestValidators
+    module Validator
+      def deserialized_payload
+        @deserialized_payload ||= Graphiti::ActiveGraph::Deserializer.new(@params)
+      end
+    end
+  end
+end

data/lib/graphiti/active_graph/resource.rb

@@ -23,6 +23,10 @@ module Graphiti
 
       def guard_nil_id!(params)
       end
+
+      def extra_attribute?(name)
+        extra_attributes.has_key?(name)
+      end
     end
 
     module ResourceInstanceMethods
@@ -30,6 +34,10 @@ module Graphiti
         self.class.relation_resource?
       end
 
+      def extra_attribute?(name)
+        self.class.extra_attribute?(name)
+      end
+
       def sideload_name_arr(query)
         query.sideloads.keys.map(&:to_sym)
       end

data/lib/graphiti/active_graph/sideload_resolve.rb

@@ -1,5 +1,7 @@
 module Graphiti::ActiveGraph
   module SideloadResolve
+    PRELOAD_METHOD_PREFIX = 'preload_'.freeze
+
     def initialize(object, resource, query, opts = {})
       @object = object
       @resource = resource
@@ -15,5 +17,40 @@ module Graphiti::ActiveGraph
 
     def resolve_sideloads(parents)
     end
+
+    def resolve
+      super.tap { |results| preload_extra_fields(results) }
+    end
+
+    private
+
+    def preload_extra_fields(results)
+      requested_extra_fields.each do |extra_field_name|
+        next unless preload_extra_field?(extra_field_name)
+
+        result_map = fetch_preloaded_data(extra_field_name, results)
+        assign_preloaded_data(results, extra_field_name, result_map)
+      end
+    end
+
+    def requested_extra_fields
+      @query.extra_fields[@resource.type] || []
+    end
+
+    def fetch_preloaded_data(extra_field_name, results)
+      @resource.model.public_send(default_preload_method(extra_field_name), results.pluck(:id))
+    end
+
+    def assign_preloaded_data(results, extra_field_name, result_map)
+      results.each { |r| r.public_send("#{extra_field_name}=", result_map[r.id]) }
+    end
+
+    def preload_extra_field?(extra_field_name)
+      @resource.extra_attribute?(extra_field_name) && @resource.model.respond_to?(default_preload_method(extra_field_name))
+    end
+
+    def default_preload_method(extra_field_name)
+      "#{PRELOAD_METHOD_PREFIX}#{extra_field_name}"
+    end
   end
 end

data/lib/graphiti/active_graph/version.rb

@@ -1,5 +1,5 @@
 module Graphiti
   module ActiveGraph
-    VERSION = '0.1.24'
+    VERSION = '0.1.26'
   end
 end

data/lib/graphiti-activegraph.rb

@@ -27,7 +27,6 @@ Graphiti::Scoping::Filter.prepend Graphiti::ActiveGraph::Scoping::Filter
 Graphiti::Util::SerializerRelationship.prepend Graphiti::ActiveGraph::Util::SerializerRelationship
 Graphiti::Util::SerializerAttribute.prepend Graphiti::ActiveGraph::Util::SerializerAttribute
 Graphiti::Util::RelationshipPayload.prepend Graphiti::ActiveGraph::Util::RelationshipPayload
-Graphiti::Deserializer.prepend Graphiti::ActiveGraph::Deserializer
 Graphiti::Query.prepend Graphiti::ActiveGraph::Query
 Graphiti::Resource.prepend Graphiti::ActiveGraph::ResourceInstanceMethods
 Graphiti::Resource.extend Graphiti::ActiveGraph::Resource
@@ -35,6 +34,7 @@ Graphiti::ResourceProxy.prepend Graphiti::ActiveGraph::ResourceProxy
 Graphiti::Runner.prepend Graphiti::ActiveGraph::Runner
 Graphiti::Scope.prepend Graphiti::ActiveGraph::SideloadResolve
 Graphiti::Configuration.include Graphiti::SidepostConfiguration
+Graphiti::RequestValidators::Validator.prepend Graphiti::ActiveGraph::RequestValidators::Validator
 
 # JSONAPI extensions
 JSONAPI::Serializable::Resource.prepend Graphiti::ActiveGraph::JsonapiExt::Serializable::ResourceExt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti-activegraph
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.1.26
 platform: ruby
 authors:
 - Hardik Joshi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  name: jar-dependencies
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -199,9 +213,13 @@ files:
 - lib/graphiti/active_graph/adapters/active_graph/has_one_sideload.rb
 - lib/graphiti/active_graph/adapters/active_graph/polymorphic_belongs_to.rb
 - lib/graphiti/active_graph/adapters/active_graph/sideload.rb
+- lib/graphiti/active_graph/concerns/path_relationships.rb
 - lib/graphiti/active_graph/deserializer.rb
+- lib/graphiti/active_graph/extensions/grouping/params.rb
+- lib/graphiti/active_graph/extensions/query_params.rb
 - lib/graphiti/active_graph/jsonapi_ext/serializable/resource_ext.rb
 - lib/graphiti/active_graph/query.rb
+- lib/graphiti/active_graph/request_validators/validator.rb
 - lib/graphiti/active_graph/resource.rb
 - lib/graphiti/active_graph/resource/interface.rb
 - lib/graphiti/active_graph/resource/persistence.rb