apollo-federation 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b636d94aed7966b85bb9b0b682fc534b7d1f4ef85b3c81255a4565bbbd779e36
-  data.tar.gz: 4148abf8ba0f446c63e8fd41b0f77671ec37e1a713968d7c0e9f40e0b4298698
+  metadata.gz: 2c2b2d12a9e6be8b64cbd27aa7f0188975a49398538acab0bbb2881e9919651c
+  data.tar.gz: 614b16aed66cfdb99ee667647f020a33a537517cd4a9691e873b449b31aea57d
 SHA512:
-  metadata.gz: 5707a70a369a96f0c401bf538969450ef6cb223dca7b0fa62f6d4a9bea4071c0a366122980e9521d9e3d84abf708b1a44151817343389917b5bcffa48dbd32e8
-  data.tar.gz: dacb441ae9c79f41652d48e472e00bbee4dd947c8aa04f58ec10c3fa8e4eb69216edc62b8685a8119ddd9c4c0050103b893c2b33e26240d94e173c194ae2e660
+  metadata.gz: 7c0f879370628f7377b1b9646536c945974e494eb6602eb0f1adbc7d9471cd69641430b682f7892da330d32ec9d5a9e984518be5c7830ee0d4ae2c8e97cc94e8
+  data.tar.gz: bcbae55863980b44a39a8ba62d0eee3ead96052a2245a5a6c28105754b18e7c55e45deb6e04e1907fdd58bd00c6612eb9176b40ffd0ad883295076533facf084

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.1.0](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.3...v2.1.0) (2022-02-02)
+
+
+### Features
+
+* snake case field references ([f5506ae](https://github.com/Gusto/apollo-federation-ruby/commit/f5506aecd10ea0c4a72744be07e0a9ad5cd45b16))
+
 ## [2.0.3](https://github.com/Gusto/apollo-federation-ruby/compare/v2.0.2...v2.0.3) (2022-02-02)
 
 

data/README.md

@@ -105,10 +105,20 @@ Call `key` within your class definition:
 
 ```ruby
 class User < BaseObject
-  key fields: 'id'
+  key fields: :id
 end
 ```
 
+Compound keys are also supported:
+
+```ruby
+class User < BaseObject
+  key fields: [:id, { organization: :id }]
+end
+```
+
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
 ### The `@external` directive
 
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/core-concepts/#referencing-external-types)
@@ -131,10 +141,12 @@ Pass the `requires:` option to your field definition:
 class Product < BaseObject
   field :price, Int, null: true, external: true
   field :weight, Int, null: true, external: true
-  field :shipping_estimate, Int, null: true, requires: { fields: "price weight"}
+  field :shipping_estimate, Int, null: true, requires: { fields: [:price, :weight] }
 end
 ```
 
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
 ### The `@provides` directive
 
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/advanced-features/#using-denormalized-data)
@@ -143,9 +155,25 @@ Pass the `provides:` option to your field definition:
 
 ```ruby
 class Review < BaseObject
-  field :author, 'User', null: true, provides: { fields: 'username' }
+  field :author, 'User', null: true, provides: { fields: :username }
 end
 ```
+See [field set syntax](#field-set-syntax) for more details on the format of the `fields` option.
+
+### Field set syntax
+
+Field sets can be either strings encoded with the Apollo Field Set [syntax]((https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#scalar-_fieldset)) or arrays, hashes and snake case symbols that follow the graphql-ruby conventions:
+
+```ruby
+# Equivalent to the "organizationId" field set
+:organization_id
+
+# Equivalent to the "price weight" field set
+[:price, :weight]
+
+# Equivalent to the "id organization { id }" field set
+[:id, { organization: :id }]
+```
 
 ### Reference resolvers
 

data/lib/apollo-federation/field.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -15,7 +16,7 @@ module ApolloFederation
           name: 'requires',
           arguments: [
             name: 'fields',
-            values: requires[:fields],
+            values: ApolloFederation::FieldSetSerializer.serialize(requires[:fields]),
           ],
         )
       end
@@ -24,7 +25,7 @@ module ApolloFederation
           name: 'provides',
           arguments: [
             name: 'fields',
-            values: provides[:fields],
+            values: ApolloFederation::FieldSetSerializer.serialize(provides[:fields]),
           ],
         )
       end

data/lib/apollo-federation/field_set_serializer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module ApolloFederation
+  module FieldSetSerializer
+    extend self
+
+    def serialize(fields)
+      case fields
+      when Hash
+        fields.map do |field, nested_selections|
+          "#{camelize(field)} { #{serialize(nested_selections)} }"
+        end.join(' ')
+      when Array
+        fields.map do |field|
+          serialize(field)
+        end.join(' ')
+      when String
+        fields
+      when Symbol
+        camelize(fields)
+      else
+        raise ArgumentError, "Unexpected field set type: #{fields.class}"
+      end
+    end
+
+    private
+
+    def camelize(field)
+      GraphQL::Schema::Member::BuildType.camelize(field.to_s)
+    end
+  end
+end

data/lib/apollo-federation/interface.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -22,7 +23,7 @@ module ApolloFederation
           name: 'key',
           arguments: [
             name: 'fields',
-            values: fields,
+            values: ApolloFederation::FieldSetSerializer.serialize(fields),
           ],
         )
       end

data/lib/apollo-federation/object.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'apollo-federation/field_set_serializer'
 require 'apollo-federation/has_directives'
 
 module ApolloFederation
@@ -20,7 +21,7 @@ module ApolloFederation
           name: 'key',
           arguments: [
             name: 'fields',
-            values: fields,
+            values: ApolloFederation::FieldSetSerializer.serialize(fields),
           ],
         )
       end

data/lib/apollo-federation/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Noa Elad
@@ -198,6 +198,7 @@ files:
 - lib/apollo-federation/entity.rb
 - lib/apollo-federation/federated_document_from_schema_definition.rb
 - lib/apollo-federation/field.rb
+- lib/apollo-federation/field_set_serializer.rb
 - lib/apollo-federation/has_directives.rb
 - lib/apollo-federation/interface.rb
 - lib/apollo-federation/object.rb