apollo-federation 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cffb53f08806faf67b0cb6859070ba9713e2a4041853ca085ed60e53544881a
-  data.tar.gz: 49d268d70116760b61aa7c7edb9ed6cccf62fa15ae690a85e938714d39bd5ded
+  metadata.gz: 93e41c85366169cb54514dc0803b1a92c26ad684520ba328ff108ab67d20474c
+  data.tar.gz: 53b7ef86f0cf1e65849aed13cd4bfd625647eba6607efa08f2a566d450e5afd2
 SHA512:
-  metadata.gz: f049907664be9ecb42f482af571799171e8d6156439fc816e3384bfbdae42709a289d1b25c7b6c42ad6a07afc7d3754b55b98eb2f03c9c72932e0f63a72f12c6
-  data.tar.gz: 98e8fdb620d9f5007f2c690203372a3fb89dc5325aecdfd91f8287a160cf12d3793f24cf5c3f38b7fb80757fe2995e2d3135d7510ac9ab354faf4ffea24b2990
+  metadata.gz: 24e88953a0bbdc57273f82d05def242266e7368acd8962fb2648ef954c4379fc431b680fba853ee0ddca668fc8f39400e609d3fca8e9bf9248ed8dbf7e2971dd
+  data.tar.gz: ffd6c899084c8d26d30602ab34e80bfe343c2c6f847daa339130ab4272ccd04aa028b24e41725e1d1acbb00d132f9b81d9129ee8a9a79f0351e037dcb1a9ffc6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.5.0](https://github.com/Gusto/apollo-federation-ruby/compare/v3.4.1...v3.5.0) (2023-03-08)
+
+
+### Features
+
+* add tag directive from federation v2 ([#210](https://github.com/Gusto/apollo-federation-ruby/issues/210)) ([8c6e112](https://github.com/Gusto/apollo-federation-ruby/commit/8c6e11251b7bc7d6888a7a2b6e0feeea70171cb0))
+
 ## [3.4.1](https://github.com/Gusto/apollo-federation-ruby/compare/v3.4.0...v3.4.1) (2023-02-21)
 
 

data/README.md

@@ -222,6 +222,26 @@ class Product < BaseObject
 end
 ```
 
+### The `@tag` directive (Apollo Federation v2)
+
+[Apollo documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives/#tag)
+
+Call `tag` within your class definition:
+
+```ruby
+class User < BaseObject
+  tag name: 'private'
+end
+```
+
+Pass the `tags:` option to your field definition:
+
+```ruby
+class User < BaseObject
+  field :id, ID, null: false, tags: [{ name: 'private' }]
+end
+```
+
 ### 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:

data/lib/apollo-federation/argument.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module Argument
+    include HasDirectives
+
+    VERSION_2_DIRECTIVES = %i[tags].freeze
+
+    def initialize(*args, **kwargs, &block)
+      add_v2_directives(**kwargs)
+
+      # Remove the custom kwargs
+      kwargs = kwargs.delete_if do |k, _|
+        VERSION_2_DIRECTIVES.include?(k)
+      end
+
+      # Pass on the default args:
+      super(*args, **kwargs, &block)
+    end
+
+    private
+
+    def add_v2_directives(tags: [], **_kwargs)
+      tags.each do |tag|
+        add_directive(
+          name: 'tag',
+          arguments: [
+            name: 'name',
+            values: tag[:name],
+          ],
+        )
+      end
+    end
+  end
+end

data/lib/apollo-federation/enum.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module Enum
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include HasDirectives
+
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+    end
+  end
+end

data/lib/apollo-federation/enum_value.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module EnumValue
+    include HasDirectives
+
+    VERSION_2_DIRECTIVES = %i[tags].freeze
+
+    def initialize(*args, **kwargs, &block)
+      add_v2_directives(**kwargs)
+
+      # Remove the custom kwargs
+      kwargs = kwargs.delete_if do |k, _|
+        VERSION_2_DIRECTIVES.include?(k)
+      end
+
+      # Pass on the default args:
+      super(*args, **kwargs, &block)
+    end
+
+    private
+
+    def add_v2_directives(tags: [], **_kwargs)
+      tags.each do |tag|
+        add_directive(
+          name: 'tag',
+          arguments: [
+            name: 'name',
+            values: tag[:name],
+          ],
+        )
+      end
+    end
+  end
+end

data/lib/apollo-federation/federated_document_from_schema_definition.rb

@@ -14,7 +14,6 @@ module ApolloFederation
       '_entities',
       '_service',
     ].freeze
-    INACCESSIBLE_DIRECTIVE = 'inaccessible'
 
     def build_object_type_node(object_type)
       object_node = super
@@ -28,8 +27,38 @@ module ApolloFederation
     end
 
     def build_interface_type_node(interface_type)
-      field_node = super
-      merge_directives(field_node, interface_type)
+      interface_node = super
+      merge_directives(interface_node, interface_type)
+    end
+
+    def build_union_type_node(union_type)
+      union_node = super
+      merge_directives(union_node, union_type)
+    end
+
+    def build_enum_type_node(enum_type)
+      enum_node = super
+      merge_directives(enum_node, enum_type)
+    end
+
+    def build_enum_value_node(enum_value_type)
+      enum_value_node = super
+      merge_directives(enum_value_node, enum_value_type)
+    end
+
+    def build_scalar_type_node(scalar_type)
+      scalar_node = super
+      merge_directives(scalar_node, scalar_type)
+    end
+
+    def build_input_object_node(input_object_type)
+      input_object_node = super
+      merge_directives(input_object_node, input_object_type)
+    end
+
+    def build_argument_node(argument_type)
+      argument_node = super
+      merge_directives(argument_node, argument_type)
     end
 
     def build_field_node(field_type)
@@ -71,7 +100,7 @@ module ApolloFederation
     end
 
     def directive_name(directive)
-      if schema.federation_2? && directive[:name] != INACCESSIBLE_DIRECTIVE
+      if schema.federation_2? && !Schema::IMPORTED_DIRECTIVES.include?(directive[:name])
         "#{schema.link_namespace}__#{directive[:name]}"
       else
         directive[:name]

data/lib/apollo-federation/field.rb

@@ -8,7 +8,7 @@ module ApolloFederation
     include HasDirectives
 
     VERSION_1_DIRECTIVES = %i[external requires provides].freeze
-    VERSION_2_DIRECTIVES = %i[shareable inaccessible override].freeze
+    VERSION_2_DIRECTIVES = %i[shareable inaccessible override tags].freeze
 
     def initialize(*args, **kwargs, &block)
       add_v1_directives(**kwargs)
@@ -59,7 +59,7 @@ module ApolloFederation
       nil
     end
 
-    def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, **_kwargs)
+    def add_v2_directives(shareable: nil, inaccessible: nil, override: nil, tags: [], **_kwargs)
       if shareable
         add_directive(name: 'shareable')
       end
@@ -78,6 +78,16 @@ module ApolloFederation
         )
       end
 
+      tags.each do |tag|
+        add_directive(
+          name: 'tag',
+          arguments: [
+            name: 'name',
+            values: tag[:name],
+          ],
+        )
+      end
+
       nil
     end
   end

data/lib/apollo-federation/input_object.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module InputObject
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include HasDirectives
+
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+    end
+  end
+end

data/lib/apollo-federation/interface.rb

@@ -22,6 +22,10 @@ module ApolloFederation
         add_directive(name: 'inaccessible')
       end
 
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+
       def key(fields:, camelize: true)
         add_directive(
           name: 'key',

data/lib/apollo-federation/object.rb

@@ -28,6 +28,10 @@ module ApolloFederation
         add_directive(name: 'interfaceObject')
       end
 
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+
       def key(fields:, camelize: true)
         add_directive(
           name: 'key',

data/lib/apollo-federation/scalar.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module Scalar
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include HasDirectives
+
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+    end
+  end
+end

data/lib/apollo-federation/schema.rb

@@ -7,6 +7,8 @@ require 'apollo-federation/federated_document_from_schema_definition.rb'
 
 module ApolloFederation
   module Schema
+    IMPORTED_DIRECTIVES = ['inaccessible', 'tag'].freeze
+
     def self.included(klass)
       klass.extend(CommonMethods)
     end
@@ -61,7 +63,7 @@ module ApolloFederation
 
         <<~SCHEMA
           extend schema
-            @link(url: "https://specs.apollo.dev/federation/v2.3"#{federation_namespace}, import: ["@inaccessible"])
+            @link(url: "https://specs.apollo.dev/federation/v2.3"#{federation_namespace}, import: [#{(IMPORTED_DIRECTIVES.map { |directive| "\"@#{directive}\"" }).join(', ')}])
 
         SCHEMA
       end

data/lib/apollo-federation/union.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apollo-federation/has_directives'
+
+module ApolloFederation
+  module Union
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include HasDirectives
+
+      def tag(name:)
+        add_directive(name: 'tag', arguments: [name: 'name', values: name])
+      end
+    end
+  end
+end

data/lib/apollo-federation/version.rb

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

data/lib/apollo-federation.rb

@@ -4,7 +4,13 @@ require 'apollo-federation/version'
 require 'apollo-federation/schema'
 require 'apollo-federation/object'
 require 'apollo-federation/interface'
+require 'apollo-federation/union'
+require 'apollo-federation/enum'
+require 'apollo-federation/enum_value'
 require 'apollo-federation/field'
+require 'apollo-federation/scalar'
+require 'apollo-federation/input_object'
+require 'apollo-federation/argument'
 require 'apollo-federation/tracing/proto'
 require 'apollo-federation/tracing/node_map'
 require 'apollo-federation/tracing/tracer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -194,14 +194,19 @@ files:
 - bin/rspec
 - lib/apollo-federation.rb
 - lib/apollo-federation/any.rb
+- lib/apollo-federation/argument.rb
 - lib/apollo-federation/entities_field.rb
 - lib/apollo-federation/entity.rb
+- lib/apollo-federation/enum.rb
+- lib/apollo-federation/enum_value.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/input_object.rb
 - lib/apollo-federation/interface.rb
 - lib/apollo-federation/object.rb
+- lib/apollo-federation/scalar.rb
 - lib/apollo-federation/schema.rb
 - lib/apollo-federation/service.rb
 - lib/apollo-federation/service_field.rb
@@ -211,6 +216,7 @@ files:
 - lib/apollo-federation/tracing/proto/apollo.proto
 - lib/apollo-federation/tracing/proto/apollo_pb.rb
 - lib/apollo-federation/tracing/tracer.rb
+- lib/apollo-federation/union.rb
 - lib/apollo-federation/version.rb
 homepage: https://github.com/Gusto/apollo-federation-ruby
 licenses: