graphql 0.16.0 → 2.0.15

data/lib/graphql/schema/directive/skip.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class Skip < Schema::Directive
+        description "Directs the executor to skip this field or fragment when the `if` argument is true."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+          GraphQL::Schema::Directive::FRAGMENT_SPREAD,
+          GraphQL::Schema::Directive::INLINE_FRAGMENT
+        )
+
+        argument :if, Boolean,
+          description: "Skipped when true."
+
+        default_directive true
+
+        def self.static_include?(args, ctx)
+          !args[:if]
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive/transform.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      # An example directive to show how you might interact with the runtime.
+      #
+      # This directive takes the return value of the tagged part of the query,
+      # and if the named transform is whitelisted and applies to the return value,
+      # it's applied by calling a method with that name.
+      #
+      # @example Installing the directive
+      #   class MySchema < GraphQL::Schema
+      #     directive(GraphQL::Schema::Directive::Transform)
+      #   end
+      #
+      # @example Transforming strings
+      #   viewer {
+      #     username @transform(by: "upcase")
+      #   }
+      class Transform < Schema::Directive
+        description "Directs the executor to run named transform on the return value."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+        )
+
+        argument :by, String,
+          description: "The name of the transform to run if applicable"
+
+        TRANSFORMS = [
+          "upcase",
+          "downcase",
+          # ??
+        ]
+        # Implement the Directive API
+        def self.resolve(object, arguments, context)
+          path = context.namespace(:interpreter)[:current_path]
+          return_value = yield
+          transform_name = arguments[:by]
+          if TRANSFORMS.include?(transform_name) && return_value.respond_to?(transform_name)
+            return_value = return_value.public_send(transform_name)
+            response = context.namespace(:interpreter_runtime)[:runtime].final_result
+            *keys, last = path
+            keys.each do |key|
+              if response && (response = response[key])
+                next
+              else
+                break
+              end
+            end
+            if response
+              response[last] = return_value
+            end
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # Subclasses of this can influence how {GraphQL::Execution::Interpreter} runs queries.
+    #
+    # - {.include?}: if it returns `false`, the field or fragment will be skipped altogether, as if it were absent
+    # - {.resolve}: Wraps field resolution (so it should call `yield` to continue)
+    class Directive < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::HasArguments
+
+      class << self
+        # Directives aren't types, they don't have kinds.
+        undef_method :kind
+
+        def path
+          "@#{super}"
+        end
+
+        # Return a name based on the class name,
+        # but downcase the first letter.
+        def default_graphql_name
+          @default_graphql_name ||= begin
+            camelized_name = super
+            camelized_name[0] = camelized_name[0].downcase
+            camelized_name
+          end
+        end
+
+        def locations(*new_locations)
+          if new_locations.any?
+            new_locations.each do |new_loc|
+              if !LOCATIONS.include?(new_loc.to_sym)
+                raise ArgumentError, "#{self} (#{self.graphql_name}) has an invalid directive location: `locations #{new_loc}` "
+              end
+            end
+            @locations = new_locations
+          else
+            @locations ||= (superclass.respond_to?(:locations) ? superclass.locations : [])
+          end
+        end
+
+        def default_directive(new_default_directive = nil)
+          if new_default_directive != nil
+            @default_directive = new_default_directive
+          elsif @default_directive.nil?
+            @default_directive = (superclass.respond_to?(:default_directive) ? superclass.default_directive : false)
+          else
+            !!@default_directive
+          end
+        end
+
+        def default_directive?
+          default_directive
+        end
+
+        # If false, this part of the query won't be evaluated
+        def include?(_object, arguments, context)
+          static_include?(arguments, context)
+        end
+
+        # Determines whether {Execution::Lookahead} considers the field to be selected
+        def static_include?(_arguments, _context)
+          true
+        end
+
+        # Continuing is passed as a block; `yield` to continue
+        def resolve(object, arguments, context)
+          yield
+        end
+
+        # Continuing is passed as a block, yield to continue.
+        def resolve_each(object, arguments, context)
+          yield
+        end
+
+        def on_field?
+          locations.include?(FIELD)
+        end
+
+        def on_fragment?
+          locations.include?(FRAGMENT_SPREAD) && locations.include?(INLINE_FRAGMENT)
+        end
+
+        def on_operation?
+          locations.include?(QUERY) && locations.include?(MUTATION) && locations.include?(SUBSCRIPTION)
+        end
+
+        def repeatable?
+          !!@repeatable
+        end
+
+        def repeatable(new_value)
+          @repeatable = new_value
+        end
+      end
+
+      # @return [GraphQL::Schema::Field, GraphQL::Schema::Argument, Class, Module]
+      attr_reader :owner
+
+      # @return [GraphQL::Interpreter::Arguments]
+      attr_reader :arguments
+
+      def initialize(owner, **arguments)
+        @owner = owner
+        assert_valid_owner
+        # It's be nice if we had the real context here, but we don't. What we _would_ get is:
+        # - error handling
+        # - lazy resolution
+        # Probably, those won't be needed here, since these are configuration arguments,
+        # not runtime arguments.
+        @arguments = self.class.coerce_arguments(nil, arguments, Query::NullContext)
+      end
+
+      def graphql_name
+        self.class.graphql_name
+      end
+
+      LOCATIONS = [
+        QUERY =                  :QUERY,
+        MUTATION =               :MUTATION,
+        SUBSCRIPTION =           :SUBSCRIPTION,
+        FIELD =                  :FIELD,
+        FRAGMENT_DEFINITION =    :FRAGMENT_DEFINITION,
+        FRAGMENT_SPREAD =        :FRAGMENT_SPREAD,
+        INLINE_FRAGMENT =        :INLINE_FRAGMENT,
+        SCHEMA =                 :SCHEMA,
+        SCALAR =                 :SCALAR,
+        OBJECT =                 :OBJECT,
+        FIELD_DEFINITION =       :FIELD_DEFINITION,
+        ARGUMENT_DEFINITION =    :ARGUMENT_DEFINITION,
+        INTERFACE =              :INTERFACE,
+        UNION =                  :UNION,
+        ENUM =                   :ENUM,
+        ENUM_VALUE =             :ENUM_VALUE,
+        INPUT_OBJECT =           :INPUT_OBJECT,
+        INPUT_FIELD_DEFINITION = :INPUT_FIELD_DEFINITION,
+        VARIABLE_DEFINITION =    :VARIABLE_DEFINITION,
+      ]
+
+      DEFAULT_DEPRECATION_REASON = 'No longer supported'
+      LOCATION_DESCRIPTIONS = {
+        QUERY:                    'Location adjacent to a query operation.',
+        MUTATION:                 'Location adjacent to a mutation operation.',
+        SUBSCRIPTION:             'Location adjacent to a subscription operation.',
+        FIELD:                    'Location adjacent to a field.',
+        FRAGMENT_DEFINITION:      'Location adjacent to a fragment definition.',
+        FRAGMENT_SPREAD:          'Location adjacent to a fragment spread.',
+        INLINE_FRAGMENT:          'Location adjacent to an inline fragment.',
+        SCHEMA:                   'Location adjacent to a schema definition.',
+        SCALAR:                   'Location adjacent to a scalar definition.',
+        OBJECT:                   'Location adjacent to an object type definition.',
+        FIELD_DEFINITION:         'Location adjacent to a field definition.',
+        ARGUMENT_DEFINITION:      'Location adjacent to an argument definition.',
+        INTERFACE:                'Location adjacent to an interface definition.',
+        UNION:                    'Location adjacent to a union definition.',
+        ENUM:                     'Location adjacent to an enum definition.',
+        ENUM_VALUE:               'Location adjacent to an enum value definition.',
+        INPUT_OBJECT:             'Location adjacent to an input object type definition.',
+        INPUT_FIELD_DEFINITION:   'Location adjacent to an input object field definition.',
+        VARIABLE_DEFINITION:      'Location adjacent to a variable definition.',
+      }
+
+      private
+
+      def assert_valid_owner
+        case @owner
+        when Class
+          if @owner < GraphQL::Schema::Object
+            assert_has_location(OBJECT)
+          elsif @owner < GraphQL::Schema::Union
+            assert_has_location(UNION)
+          elsif @owner < GraphQL::Schema::Enum
+            assert_has_location(ENUM)
+          elsif @owner < GraphQL::Schema::InputObject
+            assert_has_location(INPUT_OBJECT)
+          elsif @owner < GraphQL::Schema::Scalar
+            assert_has_location(SCALAR)
+          elsif @owner < GraphQL::Schema
+            assert_has_location(SCHEMA)
+          else
+            raise "Unexpected directive owner class: #{@owner}"
+          end
+        when Module
+          assert_has_location(INTERFACE)
+        when GraphQL::Schema::Argument
+          if @owner.owner.is_a?(GraphQL::Schema::Field)
+            assert_has_location(ARGUMENT_DEFINITION)
+          else
+            assert_has_location(INPUT_FIELD_DEFINITION)
+          end
+        when GraphQL::Schema::Field
+          assert_has_location(FIELD_DEFINITION)
+        when GraphQL::Schema::EnumValue
+          assert_has_location(ENUM_VALUE)
+        else
+          raise "Unexpected directive owner: #{@owner.inspect}"
+        end
+      end
+
+      def assert_has_location(location)
+        if !self.class.locations.include?(location)
+          raise ArgumentError, <<-MD
+Directive `@#{self.class.graphql_name}` can't be attached to #{@owner.graphql_name} because #{location} isn't included in its locations (#{self.class.locations.join(", ")}).
+
+Use `locations(#{location})` to update this directive's definition, or remove it from #{@owner.graphql_name}.
+MD
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/enum.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module GraphQL
+  # Extend this class to define GraphQL enums in your schema.
+  #
+  # By default, GraphQL enum values are translated into Ruby strings.
+  # You can provide a custom value with the `value:` keyword.
+  #
+  # @example
+  #   # equivalent to
+  #   # enum PizzaTopping {
+  #   #   MUSHROOMS
+  #   #   ONIONS
+  #   #   PEPPERS
+  #   # }
+  #   class PizzaTopping < GraphQL::Enum
+  #     value :MUSHROOMS
+  #     value :ONIONS
+  #     value :PEPPERS
+  #   end
+  class Schema
+    class Enum < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::ValidatesInput
+
+      class UnresolvedValueError < GraphQL::Error
+        def initialize(value:, enum:, context:)
+          fix_message = ", but this isn't a valid value for `#{enum.graphql_name}`. Update the field or resolver to return one of `#{enum.graphql_name}`'s values instead."
+          message = if (cp = context[:current_path]) && (cf = context[:current_field])
+            "`#{cf.path}` returned `#{value.inspect}` at `#{cp.join(".")}`#{fix_message}"
+          else
+            "`#{value.inspect}` was returned for `#{enum.graphql_name}`#{fix_message}"
+          end
+          super(message)
+        end
+      end
+
+      class << self
+        # Define a value for this enum
+        # @param graphql_name [String, Symbol] the GraphQL value for this, usually `SCREAMING_CASE`
+        # @param description [String], the GraphQL description for this value, present in documentation
+        # @param value [Object], the translated Ruby value for this object (defaults to `graphql_name`)
+        # @param deprecation_reason [String] if this object is deprecated, include a message here
+        # @return [void]
+        # @see {Schema::EnumValue} which handles these inputs by default
+        def value(*args, **kwargs, &block)
+          kwargs[:owner] = self
+          value = enum_value_class.new(*args, **kwargs, &block)
+          key = value.graphql_name
+          prev_value = own_values[key]
+          case prev_value
+          when nil
+            own_values[key] = value
+          when GraphQL::Schema::EnumValue
+            own_values[key] = [prev_value, value]
+          when Array
+            prev_value << value
+          else
+            raise "Invariant: Unexpected enum value for #{key.inspect}: #{prev_value.inspect}"
+          end
+          value
+        end
+
+        # @return [Array<GraphQL::Schema::EnumValue>] Possible values of this enum
+        def enum_values(context = GraphQL::Query::NullContext)
+          inherited_values = superclass.respond_to?(:enum_values) ? superclass.enum_values(context) : nil
+          visible_values = []
+          warden = Warden.from_context(context)
+          own_values.each do |key, values_entry|
+            if (v = Warden.visible_entry?(:visible_enum_value?, values_entry, context, warden))
+              visible_values << v
+            end
+          end
+
+          if inherited_values
+            # Local values take precedence over inherited ones
+            inherited_values.each do |i_val|
+              if !visible_values.any? { |v| v.graphql_name == i_val.graphql_name }
+                visible_values << i_val
+              end
+            end
+          end
+
+          visible_values
+        end
+
+        # @return [Array<Schema::EnumValue>] An unfiltered list of all definitions
+        def all_enum_value_definitions
+          all_defns = if superclass.respond_to?(:all_enum_value_definitions)
+            superclass.all_enum_value_definitions
+          else
+            []
+          end
+
+          @own_values && @own_values.each do |_key, value|
+            if value.is_a?(Array)
+              all_defns.concat(value)
+            else
+              all_defns << value
+            end
+          end
+
+          all_defns
+        end
+
+        # @return [Hash<String => GraphQL::Schema::EnumValue>] Possible values of this enum, keyed by name.
+        def values(context = GraphQL::Query::NullContext)
+          enum_values(context).each_with_object({}) { |val, obj| obj[val.graphql_name] = val }
+        end
+
+        # @return [Class] for handling `value(...)` inputs and building `GraphQL::Enum::EnumValue`s out of them
+        def enum_value_class(new_enum_value_class = nil)
+          if new_enum_value_class
+            @enum_value_class = new_enum_value_class
+          elsif defined?(@enum_value_class) && @enum_value_class
+            @enum_value_class
+          else
+            superclass <= GraphQL::Schema::Enum ? superclass.enum_value_class : nil
+          end
+        end
+
+        def kind
+          GraphQL::TypeKinds::ENUM
+        end
+
+        def validate_non_null_input(value_name, ctx, max_errors: nil)
+          allowed_values = ctx.warden.enum_values(self)
+          matching_value = allowed_values.find { |v| v.graphql_name == value_name }
+
+          if matching_value.nil?
+            GraphQL::Query::InputValidationResult.from_problem("Expected #{GraphQL::Language.serialize(value_name)} to be one of: #{allowed_values.map(&:graphql_name).join(', ')}")
+          else
+            nil
+          end
+        end
+
+        def coerce_result(value, ctx)
+          warden = ctx.warden
+          all_values = warden ? warden.enum_values(self) : values.each_value
+          enum_value = all_values.find { |val| val.value == value }
+          if enum_value
+            enum_value.graphql_name
+          else
+            raise self::UnresolvedValueError.new(enum: self, value: value, context: ctx)
+          end
+        end
+
+        def coerce_input(value_name, ctx)
+          all_values = ctx.warden ? ctx.warden.enum_values(self) : values.each_value
+
+          if v = all_values.find { |val| val.graphql_name == value_name }
+            v.value
+          elsif v = all_values.find { |val| val.value == value_name }
+            # this is for matching default values, which are "inputs", but they're
+            # the Ruby value, not the GraphQL string.
+            v.value
+          else
+            nil
+          end
+        end
+
+        def inherited(child_class)
+          child_class.const_set(:UnresolvedValueError, Class.new(Schema::Enum::UnresolvedValueError))
+          super
+        end
+
+        private
+
+        def own_values
+          @own_values ||= {}
+        end
+      end
+
+      enum_value_class(GraphQL::Schema::EnumValue)
+    end
+  end
+end

data/lib/graphql/schema/enum_value.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # A possible value for an {Enum}.
+    #
+    # You can extend this class to customize enum values in your schema.
+    #
+    # @example custom enum value class
+    #   # define a custom class:
+    #   class CustomEnumValue < GraphQL::Schema::EnumValue
+    #     def initialize(*args)
+    #       # arguments to `value(...)` in Enum classes are passed here
+    #       super
+    #     end
+    #   end
+    #
+    #   class BaseEnum < GraphQL::Schema::Enum
+    #     # use it for these enums:
+    #     enum_value_class CustomEnumValue
+    #   end
+    class EnumValue < GraphQL::Schema::Member
+      include GraphQL::Schema::Member::HasPath
+      include GraphQL::Schema::Member::HasAstNode
+      include GraphQL::Schema::Member::HasDirectives
+      include GraphQL::Schema::Member::HasDeprecationReason
+
+      attr_reader :graphql_name
+
+      # @return [Class] The enum type that owns this value
+      attr_reader :owner
+
+      def initialize(graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, value: nil, deprecation_reason: nil, &block)
+        @graphql_name = graphql_name.to_s
+        GraphQL::NameValidator.validate!(@graphql_name)
+        @description = desc || description
+        @value = value.nil? ? @graphql_name : value
+        if deprecation_reason
+          self.deprecation_reason = deprecation_reason
+        end
+        @owner = owner
+        @ast_node = ast_node
+        if directives
+          directives.each do |dir_class, dir_options|
+            directive(dir_class, **dir_options)
+          end
+        end
+
+        if block_given?
+          instance_eval(&block)
+        end
+      end
+
+      def description(new_desc = nil)
+        if new_desc
+          @description = new_desc
+        end
+        @description
+      end
+
+      def value(new_val = nil)
+        unless new_val.nil?
+          @value = new_val
+        end
+        @value
+      end
+
+      def inspect
+        "#<#{self.class} #{path} @value=#{@value.inspect}#{description ? " @description=#{description.inspect}" : ""}>"
+      end
+
+      def visible?(_ctx); true; end
+      def accessible?(_ctx); true; end
+      def authorized?(_ctx); true; end
+    end
+  end
+end

data/lib/graphql/schema/field/connection_extension.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Field
+      class ConnectionExtension < GraphQL::Schema::FieldExtension
+        def apply
+          field.argument :after, "String", "Returns the elements in the list that come after the specified cursor.", required: false
+          field.argument :before, "String", "Returns the elements in the list that come before the specified cursor.", required: false
+          field.argument :first, "Int", "Returns the first _n_ elements from the list.", required: false
+          field.argument :last, "Int", "Returns the last _n_ elements from the list.", required: false
+        end
+
+        # Remove pagination args before passing it to a user method
+        def resolve(object:, arguments:, context:)
+          next_args = arguments.dup
+          next_args.delete(:first)
+          next_args.delete(:last)
+          next_args.delete(:before)
+          next_args.delete(:after)
+          yield(object, next_args, arguments)
+        end
+
+        def after_resolve(value:, object:, arguments:, context:, memo:)
+          original_arguments = memo
+          # rename some inputs to avoid conflicts inside the block
+          maybe_lazy = value
+          value = nil
+          context.schema.after_lazy(maybe_lazy) do |resolved_value|
+            value = resolved_value
+            if value.is_a? GraphQL::ExecutionError
+              # This isn't even going to work because context doesn't have ast_node anymore
+              context.add_error(value)
+              nil
+            elsif value.nil?
+              nil
+            elsif value.is_a?(GraphQL::Pagination::Connection)
+              # update the connection with some things that may not have been provided
+              value.context ||= context
+              value.parent ||= object.object
+              value.first_value ||= original_arguments[:first]
+              value.after_value ||= original_arguments[:after]
+              value.last_value ||= original_arguments[:last]
+              value.before_value ||= original_arguments[:before]
+              value.arguments ||= original_arguments # rubocop:disable Development/ContextIsPassedCop -- unrelated .arguments method
+              value.field ||= field
+              if field.has_max_page_size? && !value.has_max_page_size_override?
+                value.max_page_size = field.max_page_size
+              end
+              if field.has_default_page_size? && !value.has_default_page_size_override?
+                value.default_page_size = field.default_page_size
+              end
+              if context.schema.new_connections? && (custom_t = context.schema.connections.edge_class_for_field(@field))
+                value.edge_class = custom_t
+              end
+              value
+            elsif context.schema.new_connections?
+              context.namespace(:connections)[:all_wrappers] ||= context.schema.connections.all_wrappers
+              context.schema.connections.wrap(field, object.object, value, original_arguments, context)
+            else
+              if object.is_a?(GraphQL::Schema::Object)
+                object = object.object
+              end
+              connection_class = GraphQL::Relay::BaseConnection.connection_for_nodes(value)
+              connection_class.new(
+                value,
+                original_arguments,
+                field: field,
+                max_page_size: field.max_page_size,
+                default_page_size: field.default_page_size,
+                parent: object,
+                context: context,
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/field/scope_extension.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Field
+      class ScopeExtension < GraphQL::Schema::FieldExtension
+        def after_resolve(object:, arguments:, context:, value:, memo:)
+          if value.nil?
+            value
+          else
+            ret_type = @field.type.unwrap
+            if ret_type.respond_to?(:scope_items)
+              ret_type.scope_items(value, context)
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end