graphql-decorate 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eebb3163d3b156e31469281fed745c5512628d8d53bac95d14a482d5973eba3f
-  data.tar.gz: cf29b63e882f792f0b862b311b7dbc1f52b5be1d0685863afeeb0a11e7bb5dd6
+  metadata.gz: e23e910653e03c46982bf8916ab3f15cde1be96a6436cabbf0271c40a11f1b4d
+  data.tar.gz: d71940ac1feabb05b64228812ad1768f8f4f288e2ff105a619ee8cd02b00ce8a
 SHA512:
-  metadata.gz: 1d14eee9d8590363f51582f8d199ea8f89b6f7af6d7391097839c43ac3573830b68eb81937b0e73645bfffc21caa2188ee187d979c2b25637872a171d504b0c9
-  data.tar.gz: 3dd3cfeabf0b687aa4fc80e91779378b113b9b56145f6a172ca0930bc954511fba709266f62f552d257fd65b76d8b66b7bb1e6aaf211ef497ac2fbc8ce066e66
+  metadata.gz: 457e1cd6d2c62e5f463ccfacd8fa62f3e444c4b980d5e1d0b24b7b59aa960bcbf3c38cb0013055c793bafb3af86a5c0c2a68ae687b0c6af66de0b5b24b96d811
+  data.tar.gz: 678fb9bd85a0de6e6f0d336f2e812f91e1a326c7e3bff426159ff2bf2a83af5bc93bdf1b4ff490650f3a851f8d42b0370955d552bf57d22a47f183e8c2335462

data/README.md

@@ -131,7 +131,8 @@ end
 ### Collections
 By default `graphql-decorate` recognizes `Array` and `ActiveRecord::Relation` object types and 
 decorates every element in the collection. If you have other collection types that should have 
-their elements decorated, you can add them in the configuration.
+their elements decorated, you can add them in the configuration. Custom collection classes must 
+respond to `#map`.
 ```ruby
 GraphQL::Decorate.configure do |config|
   config.custom_collection_classes = [Mongoid::Relations::Targets::Enumerable]

data/graphql-decorate.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "graphql-decorate"
   spec.version       = GraphQL::Decorate::VERSION
   spec.authors       = ["Ben Brook"]
-  spec.email         = ["bbrook@truecar.com"]
+  spec.email         = ["bbrook154@gmail.com"]
 
   spec.summary       = 'A decorator integration for the GraphQL gem'
-  spec.homepage      = 'https://git.corp.tc/bbrook/graphql-decorate'
+  spec.homepage      = 'https://www.github.com/TrueCar/graphql-decorate'
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.

data/lib/graphql/decorate.rb

@@ -4,10 +4,14 @@ require_relative 'decorate/configuration'
 require_relative 'decorate/object_integration'
 require_relative 'decorate/field_integration'
 require_relative 'decorate/field_extension'
-require_relative 'decorate/resolution'
+require_relative 'decorate/object'
 require_relative 'decorate/type_attributes'
+require_relative 'decorate/field_context'
+require_relative 'decorate/connection'
 
+# Matching the graphql-ruby namespace
 module GraphQL
+  # Entry point for graphql-decorate. Handles configuration.
   module Decorate
     # @return [Configuration] Returns a new instance of GraphQL::Decorate::Configuration.
     def self.configuration

data/lib/graphql/decorate/configuration.rb

@@ -1,5 +1,6 @@
 module GraphQL
   module Decorate
+    # Allows overriding default decoration and custom collection class behavior.
     class Configuration
       # @return [Proc] Proc that decorates a given object and context with a given decorator class.
       attr_reader :evaluate_decorator

data/lib/graphql/decorate/connection.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module GraphQL
+  module Decorate
+    # Wraps a GraphQL::Pagination::Connection object to decorate values after pagination is applied.
+    class Connection
+      # @return [GraphQL::Pagination::Connection] Connection being decorated
+      attr_reader :connection
+
+      # @return [GraphQL::Decorate::FieldContext] Current field context
+      attr_reader :field_context
+
+      def initialize(connection, field_context)
+        @connection = connection
+        @field_context = field_context
+      end
+
+      # @return [Array] Decorated nodes after pagination is applied
+      def nodes
+        nodes = @connection.nodes
+        nodes.map { |node| GraphQL::Decorate::Object.new(node, field_context).decorate }
+      end
+
+      # @see nodes
+      # @return [Array] Decorated nodes after pagination is applied
+      def edge_nodes
+        nodes
+      end
+
+      class << self
+        private
+
+        def method_missing(symbol, *args, &block)
+          @connection.class.send(symbol, *args, &block)
+        end
+
+        def respond_to_missing?(method, include_private = false)
+          @connection.class.respond_to_missing(method, include_private)
+        end
+      end
+
+      private
+
+      def method_missing(symbol, *args, &block)
+        @connection.send(symbol, *args, &block)
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        @connection.respond_to_missing(method, include_private)
+      end
+    end
+  end
+end

data/lib/graphql/decorate/field_context.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module GraphQL
+  module Decorate
+    # Wraps current GraphQL::Query::Context and options provided to a field for portability.
+    class FieldContext
+      # @return [GraphQL::Query::Context] Current GraphQL query context
+      attr_reader :context
+
+      # @return [Hash] Options provided to the field being decorated
+      attr_reader :options
+
+      def initialize(context, options)
+        @context = context
+        @options = options
+      end
+    end
+  end
+end

data/lib/graphql/decorate/field_extension.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 module GraphQL
   module Decorate
+    # Extension run after fields are resolved to decorate their value.
     class FieldExtension < GraphQL::Schema::FieldExtension
       # Extension to be called after lazy loading.
       # @param context [GraphQL::Query::Context] The current GraphQL query context.
       # @param value [Object, GraphQL::Schema::Object] The object being decorated. Can be a schema object if the field hasn't been resolved yet.
-      # @return [Object] Decorated object.
+      # @return [::Object, GraphQL::Decorate::Connection] Decorated object.
       def after_resolve(context:, value:, **_rest)
         return if value.nil?
 
-        collection = collection_classes.any? { |c| value.is_a?(c) }
-        if collection
-          value.map { |item| decorate(item, context) }
+        field_context = GraphQL::Decorate::FieldContext.new(context, options)
+        if value.is_a?(GraphQL::Pagination::Connection)
+          GraphQL::Decorate::Connection.new(value, field_context)
+        elsif collection_classes.any? { |c| value.is_a?(c) }
+          value.map { |item| decorate(item, field_context) }
         else
-          decorate(value, context)
+          decorate(value, field_context)
         end
       end
 
@@ -25,8 +28,8 @@ module GraphQL
         klasses
       end
 
-      def decorate(object, context)
-        GraphQL::Decorate::Resolution.new(object, context, options).resolve
+      def decorate(object, field_context)
+        GraphQL::Decorate::Object.new(object, field_context).decorate
       end
     end
   end

data/lib/graphql/decorate/field_integration.rb

@@ -1,5 +1,6 @@
 module GraphQL
   module Decorate
+    # Extends default field behavior and adds extension to the field if it should be decorated.
     module FieldIntegration
       # Overridden field initializer
       # @param type [GraphQL::Schema::Object] The type to add the extension to.
@@ -15,6 +16,8 @@ module GraphQL
 
       def get_extension_options(type)
         type_attributes = GraphQL::Decorate::TypeAttributes.new(type)
+        return unless type_attributes.decorator_class
+
         {
           decorator_class: type_attributes.decorator_class,
           decorator_evaluator: type_attributes.decorator_evaluator,
@@ -24,10 +27,11 @@ module GraphQL
       end
 
       def extend_with_decorator(options)
-        ext = GraphQL::Decorate::FieldExtension.new(field: self, options: options)
-        @extensions = @extensions.dup
-        @extensions.unshift(ext)
-        @extensions.freeze
+        extension(GraphQL::Decorate::FieldExtension, options)
+        # ext = GraphQL::Decorate::FieldExtension.new(field: self, options: options)
+        # @extensions = @extensions.dup
+        # @extensions.unshift(ext)
+        # @extensions.freeze
       end
     end
   end

data/lib/graphql/decorate/{resolution.rb → object.rb}

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 module GraphQL
   module Decorate
-    class Resolution
-      # @param object [Object] Object being resolved.
-      # @param graphql_context [GraphQL::Query::Context] CurrentGraphQL query context.
-      # @param extension_options [Hash] Options provided from the field extension.
-      def initialize(object, graphql_context, extension_options)
+    # Handles decorating an object given its current field context.
+    class Object
+      # @param object [Object] Object being decorated.
+      # @param field_context [GraphQL::Decorate::FieldContext] Current GraphQL field context and options.
+      def initialize(object, field_context)
         @object = object
-        @graphql_context = graphql_context
-        @extension_options = extension_options
+        @field_context = field_context
         @default_decorator_context = { graphql: true }
       end
 
       # Resolve the object with decoration.
       # @return [Object] Decorated object if possible, otherwise the original object.
-      def resolve
+      def decorate
         if decorator_class
           GraphQL::Decorate.configuration.evaluate_decorator.call(decorator_class, object, decorator_context)
         else
@@ -24,20 +23,20 @@ module GraphQL
 
       private
 
-      attr_reader :object, :graphql_context, :extension_options, :default_decorator_context
+      attr_reader :object, :field_context, :default_decorator_context
 
       def decorator_class
-        if extension_options[:decorator_class]
-          extension_options[:decorator_class]
-        elsif extension_options[:decorator_evaluator]
-          extension_options[:decorator_evaluator].call(object)
+        if field_context.options[:decorator_class]
+          field_context.options[:decorator_class]
+        elsif field_context.options[:decorator_evaluator]
+          field_context.options[:decorator_evaluator].call(object)
         else
           resolve_decorator_class
         end
       end
 
       def decorator_context_evaluator
-        extension_options[:decorator_context_evaluator] || resolve_decorator_context_evaluator
+        field_context.options[:decorator_context_evaluator] || resolve_decorator_context_evaluator
       end
 
       private
@@ -65,7 +64,7 @@ module GraphQL
       end
 
       def resolve_type
-        extension_options[:unresolved_type]&.resolve_type(object, graphql_context)
+        field_context.options[:unresolved_type]&.resolve_type(object, field_context.context)
       end
     end
   end

data/lib/graphql/decorate/object_integration.rb

@@ -1,5 +1,6 @@
 module GraphQL
   module Decorate
+    # Extends GraphQL::Schema::Object classes with methods to set the desired decorator class and context.
     module ObjectIntegration
       # Decorate the type with a decorator class.
       # @param klass [Class] Class the object should be decorated with.

data/lib/graphql/decorate/type_attributes.rb

@@ -1,37 +1,47 @@
 # frozen_string_literal: true
 module GraphQL
   module Decorate
+    # Extracts configured decorator attributes from a GraphQL::Schema::Object type.
     class TypeAttributes
+      # @return [GraphQL::Schema::Object] type to extract decorator attributes from
       attr_reader :type
 
+      # @param [GraphQL::Schema::Object] type to extract decorator attributes from
       def initialize(type)
         @type = type
       end
 
+      # @return [Class, nil] Decorator class for the type if available
       def decorator_class
         get_attribute(:decorator_class)
       end
 
+      # @return [Proc, nil] Decorator evaluator for the type if available
       def decorator_evaluator
         get_attribute(:decorator_evaluator)
       end
 
+      # @return [Proc, nil] Decorator context evaluator for the type if available
       def decorator_context_evaluator
         get_attribute(:decorator_context_evaluator)
       end
 
+      # @return [GraphQL::Schema::Object, nil] Decorator evaluator for the type if available
       def unresolved_type
         unresolved_type? ? type : nil
       end
 
+      # @return [Boolean] True if type is not yet resolved, false if it is resolved
       def unresolved_type?
         type.respond_to?(:resolve_type)
       end
 
+      # @return [Boolean] True if type is resolved, false if it is not resolved
       def resolved_type?
         !unresolved_type?
       end
 
+      # @return [Boolean] True if type is a connection, false if it is resolved
       def connection?
         resolved_type? && type.respond_to?(:node_type)
       end
@@ -42,7 +52,7 @@ module GraphQL
         if connection?
           type.node_type.respond_to?(name) && type.node_type.public_send(name)
         elsif resolved_type?
-          type.respond_to?(name) && type.public_send(name)
+          type.respond_to?(name) ? type.public_send(name) : nil
         end
       end
     end

data/lib/graphql/decorate/version.rb

@@ -1,5 +1,6 @@
 module GraphQL
   module Decorate
-    VERSION = "0.1.1"
+    # Current version number
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-decorate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ben Brook
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -74,7 +74,7 @@ dependencies:
         version: '3.0'
 description: 
 email:
-- bbrook@truecar.com
+- bbrook154@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,13 +91,15 @@ files:
 - graphql-decorate.gemspec
 - lib/graphql/decorate.rb
 - lib/graphql/decorate/configuration.rb
+- lib/graphql/decorate/connection.rb
+- lib/graphql/decorate/field_context.rb
 - lib/graphql/decorate/field_extension.rb
 - lib/graphql/decorate/field_integration.rb
+- lib/graphql/decorate/object.rb
 - lib/graphql/decorate/object_integration.rb
-- lib/graphql/decorate/resolution.rb
 - lib/graphql/decorate/type_attributes.rb
 - lib/graphql/decorate/version.rb
-homepage: https://git.corp.tc/bbrook/graphql-decorate
+homepage: https://www.github.com/TrueCar/graphql-decorate
 licenses:
 - MIT
 metadata: {}