apollo-federation 3.7.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4104a6574a535d062fe70d793bfa1b3c9099adfc8a1ecc5eeed79d296f1386b
-  data.tar.gz: d459803bca66e82aa00dc93c86efd63740a5e5531b33b18419bb246846d10a52
+  metadata.gz: ea55be797646c3f816a4f83e134bed0fd3cf3ee1cd7ce30cda45e88513385a75
+  data.tar.gz: 271cb2c2d084ae1499e1974de9d06035701a4d356781a0a7cfc49bf4c0eb88d4
 SHA512:
-  metadata.gz: 64ae19c9756916d3157158866f3a44cfc75644bba283aa9143237ba644c9ea2ffd6e0c91ca17dc558414a61867d04bbe8f379fee3d0a28f1f0b66298d1fb6e5d
-  data.tar.gz: 8c7789e315d9e68bf0c3fb1711c9a6463611bb335cfd970be5eb989a7c6ebf92c15ece86464670301e43c6978d7cb5eae3161a9841f40f0e278e0a7cba234f1f
+  metadata.gz: 58f93ab4cb85ddac1f2e537dd83d25e9fe88e174c43c4c7d864ee6e2b16858d510dd79f36b246ac6bfda27bef7a940ea2840c414f613ca92e5bb7d63f1cec9b1
+  data.tar.gz: 36f9fd3a2259508d896d8bb42f0e187bacfe628bcfdf8d88ac1effc10f62bf465da5c4a6ff38dd5c682527cf1c710becd6f8c5c2d27c6883801b396b04d55725

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.8.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.7.1...v3.8.0) (2023-06-02)
+
+
+### Features
+
+* optionally underscore _Any keys ([#248](https://github.com/Gusto/apollo-federation-ruby/issues/248)) ([f1688e7](https://github.com/Gusto/apollo-federation-ruby/commit/f1688e793ba08195a06ddad74d84f2858dcdfcdf))
+
 ## [3.7.1](https://github.com/Gusto/apollo-federation-ruby/compare/v3.7.0...v3.7.1) (2023-06-01)
 
 

data/README.md

@@ -325,12 +325,39 @@ Define a `resolve_reference` class method on your object. The method will be pas
 
 ```ruby
 class User < BaseObject
+  key fields: :user_id
+  field :user_id, ID, null: false
+  
   def self.resolve_reference(reference, context)
-    USERS.find { |user| user[:id] == reference[:id] }
+    USERS.find { |user| user[:userId] == reference[:userId] }
   end
 end
 ```
 
+To maintain backwards compatibility, by default, reference hash keys are camelcase. They can be underscored by setting `underscore_reference_keys` on your entity class. In order to maintain consistency with GraphQL Ruby, we may change the keys to be underscored by default in a future major release.
+
+```ruby
+class User < BaseObject
+  key fields: :user_id
+  field :user_id, ID, null: false
+  underscore_reference_keys true
+  
+  def self.resolve_reference(reference, context)
+    USERS.find { |user| user[:user_id] == reference[:user_id] }
+  end
+end
+```
+Alternatively you can change the default for your project by setting `underscore_reference_keys` on `BaseObject`:
+
+```ruby
+class BaseObject < GraphQL::Schema::Object
+  include ApolloFederation::Object
+
+  field_class BaseField
+  underscore_reference_keys true
+end
+```
+
 ### Tracing
 
 To support [federated tracing](https://www.apollographql.com/docs/apollo-server/federation/metrics/):

data/lib/apollo-federation/entities_field.rb

@@ -49,6 +49,14 @@ module ApolloFederation
         # TODO: What if the type is an interface?
         type_class = class_of_type(type)
 
+        if type_class.underscore_reference_keys
+          references.map! do |reference|
+            reference.transform_keys do |key|
+              GraphQL::Schema::Member::BuildType.underscore(key.to_s).to_sym
+            end
+          end
+        end
+
         if type_class.respond_to?(:resolve_references)
           results = type_class.resolve_references(references, context)
         elsif type_class.respond_to?(:resolve_reference)

data/lib/apollo-federation/object.rb

@@ -43,6 +43,18 @@ module ApolloFederation
           arguments: arguments,
         )
       end
+
+      def underscore_reference_keys(value = nil)
+        if value.nil?
+          if @underscore_reference_keys.nil?
+            find_inherited_value(:underscore_reference_keys, false)
+          else
+            @underscore_reference_keys
+          end
+        else
+          @underscore_reference_keys = value
+        end
+      end
     end
   end
 end

data/lib/apollo-federation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApolloFederation
-  VERSION = '3.7.1'
+  VERSION = '3.8.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql