graphiti-activegraph 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64aa5789f68595122f2d8113a497fa4f822f262bed07cac85da0474cb1ed7d51
-  data.tar.gz: f95a5b41c60d54f43e245c0b0279577b69325fb777e41c526f376e7fed40f1a3
+  metadata.gz: 99c8c00fe58ed3146c7feae681bac89ec82989b09f88dfa97aa6a54ef7e9930b
+  data.tar.gz: c21e632e4fa1a4f6b24315c01c76d89f91158ae9996a73cdf6da83e97805e2ce
 SHA512:
-  metadata.gz: c2d65e132c567d4fcb814389e199a3b4c4c13d53f83f9604d57ddc98b7dd05573b8527eecc67e78294de9cc9e178ef7ab287ad571626f5854efcc8db30de32a2
-  data.tar.gz: 6fdd6b5a5ec1be222a0905bf1877761c1b81342e0d48f19d662e5ae014c3819938e5a72aaf159e65c86b7a58d173fd2e3d65f66071734e7cc90d9e4d83ea08ed
+  metadata.gz: 8942c7a92552d7554cdc78e5183b970bab9c6d9cee23e5d21e23244c84c45491bbd5a3085671cde7919ca3f7e531cd2e7c6388f0ad367cecc430b77597c0db9c
+  data.tar.gz: e31a9631f62d743899851ea815c2158c801f550a5d7ec86eafab260045441fbbd84813f0c5511f9cadc3ad2a7fe8b750d315effc65cbc46866235d31f136731a

data/.github/workflows/specs.yml

@@ -10,11 +10,14 @@ on:
   workflow_dispatch:
 
 permissions:
+  actions: write
   contents: read
 
 jobs:
   test:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     strategy:
       fail-fast: false
       matrix:
@@ -49,3 +52,8 @@ jobs:
 
       - name: Run tests
         run: bundle exec rspec
+
+      - uses: qltysh/qlty-action/coverage@v1
+        with:
+          oidc: true
+          files: coverage/coverage.json

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.1] - 2025-11-5
+### Added
+- **Deserializer: relationship id(s) helpers**: introduced `relationship_id` and `relationship_ids` methods in `Deserializer` to fetch relationship id(s) by association name from request payload. (PR #49)
+
 ## [1.3.0] - 2025-10-13
 ### Added
 - **Extra fields preloading in main query**: Support preloading associations for `extra_fields` for main and sideloaded records. Adds `preload` option to `extra_attribute` in resource classes. Example: `extra_attribute :full_post_title, :string, preload: :author`. (PR #45)

data/README.md

@@ -45,6 +45,11 @@ graphiti-activegraph allows assigning and unassigning relationships via sidepost
 Graphiti stores context using `Thread.current[]`, which does not persist across different fibers within the same thread. In graphiti-activegraph, when running on MRI (non-JRuby environments), the gem uses `thread_variable_get` and `thread_variable_set`. Ensuring the context remains consistent across different fibers in the same thread.
 
 ### New Features in graphiti-activegraph
+For detailed API documentation and helper method behavior, see the [docs](./docs) directory.
+- [Deserializer](./docs/deserializer.md)
+- [Adapter](./docs/adapter.md) *(planned)*
+- [Resource](./docs/resource.md) *(planned)*
+
 #### Rendering Preloaded Objects Without Extra Queries
 graphiti-activegraph introduces two new methods on the Graphiti resource class:
 `with_preloaded_obj(record, params)` – Renders a single preloaded ActiveGraph object without querying the database.
@@ -107,6 +112,8 @@ Currently, this feature does not support preloading for deep sideloads such as `
 
 Check [spec/support/factory_bot_setup.rb](https://github.com/mrhardikjoshi/graphiti-activegraph/blob/master/spec/support/factory_bot_setup.rb) and [spec/active_graph/sideload_resolve_spec.rb](https://github.com/mrhardikjoshi/graphiti-activegraph/blob/master/spec/active_graph/sideload_resolve_spec.rb) for examples of usage.
 
+## [CHANGELOG](CHANGELOG.md)
+
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/mrhardikjoshi/graphiti-activegraph. This project is intended to be a safe, welcoming space for collaboration.
 

data/docs/deserializer.md

@@ -0,0 +1,40 @@
+# Deserializer
+
+### Overview
+Handles incoming JSON:API payloads for Graphiti. Deserializes the request body and provides helper methods to extract and reconcile data, relationships and meta.
+
+### Methods
+
+#### `relationship_id(name)`
+Returns the single related id for the given association name.  
+Used when the relationship is `has_one`.
+
+#### `relationship_ids(name)`
+Returns an array of related ids for the given association name.  
+Used when the relationship is `has_many`.
+
+#### `add_path_id_to_relationships!(params)`
+Ensures that relationship ids passed in the request path are reflected in `params[:data][:relationships]` when missing in the request body.
+If the request body already contains an id for the same relationship, it compares the path and body ids using `detect_conflict` to prevent mismatched identifiers.  
+The method is idempotent per request—subsequent calls are ignored once processed.
+
+**Behavior summary:**
+- Adds missing relationship ids to the request body.
+- Detects and surfaces id mismatches between path and body.
+- Updates the internal `relationships` hash for consistency.
+- Marks the deserializer as updated to avoid repeated execution.
+
+**Parameters:**
+- `params` — Hash (usually the request parameters).
+
+**Returns:**
+- Modified `params` Hash with relationship ids added where necessary.
+
+**Example:**
+```ruby
+# Given a path like /authors/42/books
+path_map = { author: "42" }
+params = { data: { type: "books", attributes: { title: "Graph Databases" } } }
+
+deserializer.add_path_id_to_relationships!(params)
+# => params[:data][:relationships][:author][:data][:id] == "42"

data/graphiti-activegraph.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'standard'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'ffaker'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov_json_formatter'
   spec.add_development_dependency 'factory_bot_rails'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.9.0'

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

@@ -0,0 +1,15 @@
+module Graphiti::ActiveGraph::Concerns
+  module Relationships
+    def relationship?(name)
+      relationships[name.to_sym].present?
+    end
+
+    def relationship_id(name)
+      relationships[name]&.dig(:attributes, :id)
+    end
+
+    def relationship_ids(name)
+      Array.wrap(relationships[name]).pluck(:attributes).pluck(:id)
+    end
+  end
+end

data/lib/graphiti/active_graph/deserializer.rb

@@ -1,6 +1,7 @@
 module Graphiti::ActiveGraph
   class Deserializer < Graphiti::Deserializer
     include Concerns::PathRelationships
+    include Concerns::Relationships
 
     class Conflict < StandardError
       attr_reader :key, :path_value, :body_value
@@ -55,10 +56,6 @@ 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 = {}

data/lib/graphiti/active_graph/extensions/query_dsl/performer.rb

@@ -0,0 +1,38 @@
+module Graphiti::ActiveGraph::Extensions::QueryDsl
+  module Performer
+    attr_accessor :with_vars, :skip_arrow_cypher_rels
+
+    def apply_query_dsl
+      query_param = resource.context&.params&.[](:query)
+      query_param.present? ? apply_query_param(query_param) : scope
+    end
+
+    def apply_query_param(query_param)
+      @scope = query_generator.new(query_param, **query_generator_config).tap do |qg|
+        qg.generate_functions_optional_match
+        qg.generate_with_clause_partition_query
+        qg.generate_match_query
+        qg.generate_with_clause_query
+      end.query
+    end
+
+    private
+
+    def query_generator
+      Graphiti::ActiveGraph::Extensions::QueryDsl::QueryGenerator
+    end
+
+    def query_generator_config
+      {
+        query: scope,
+        with_vars_to_carry:,
+        skip_arrow_cypher_rels: skip_arrow_cypher_rels || [],
+        resource: resource.class
+      }
+    end
+
+    def with_vars_to_carry
+      (query ? with_vars_for_sort : []).push(*with_vars).push(*Graphiti.context[:with_vars]).compact
+    end
+  end
+end

data/lib/graphiti/active_graph/extensions/query_dsl/query_generator.rb

@@ -0,0 +1,20 @@
+module Graphiti::ActiveGraph::Extensions::QueryDsl
+  class QueryGenerator
+    def initialize(query_param, query:, **config)
+      @query_param = query_param
+      @query = query
+    end
+
+    def generate_functions_optional_match
+    end
+
+    def generate_with_clause_partition_query
+    end
+
+    def generate_match_query
+    end
+
+    def generate_with_clause_query
+    end
+  end
+end

data/lib/graphiti/active_graph/scoping/filter.rb

@@ -2,6 +2,15 @@ module Graphiti::ActiveGraph
   module Scoping
     module Filter
       include Filterable
+      include Internal::SortingAliases
+      include Extensions::QueryDsl::Performer
+
+      attr_reader :scope
+
+      def apply
+        super
+        apply_query_dsl
+      end
 
       def each_filter
         filter_param.each_pair do |param_name, param_value|

data/lib/graphiti/active_graph/version.rb

@@ -1,5 +1,5 @@
 module Graphiti
   module ActiveGraph
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: graphiti-activegraph
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Hardik Joshi
 bindir: exe
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphiti
@@ -127,6 +127,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +211,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- docs/deserializer.md
 - graphiti-activegraph.gemspec
 - lib/graphiti-activegraph.rb
 - lib/graphiti/active_graph/adapters/active_graph.rb
@@ -192,9 +221,12 @@ files:
 - 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/concerns/relationships.rb
 - lib/graphiti/active_graph/deserializer.rb
 - lib/graphiti/active_graph/extensions/context.rb
 - lib/graphiti/active_graph/extensions/grouping/params.rb
+- lib/graphiti/active_graph/extensions/query_dsl/performer.rb
+- lib/graphiti/active_graph/extensions/query_dsl/query_generator.rb
 - lib/graphiti/active_graph/extensions/query_params.rb
 - lib/graphiti/active_graph/extensions/resources/authorizationable.rb
 - lib/graphiti/active_graph/extensions/resources/payload_combinable.rb