graphql 0.16.0 → 2.0.15

data/lib/graphql/schema/member/has_ast_node.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Member
+      module HasAstNode
+        # If this schema was parsed from a `.graphql` file (or other SDL),
+        # this is the AST node that defined this part of the schema.
+        def ast_node(new_ast_node = nil)
+          if new_ast_node
+            @ast_node = new_ast_node
+          elsif defined?(@ast_node)
+            @ast_node
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_deprecation_reason.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module HasDeprecationReason
+        # @return [String, nil] Explains why this member was deprecated (if present, this will be marked deprecated in introspection)
+        def deprecation_reason
+          dir = self.directives.find { |d| d.is_a?(GraphQL::Schema::Directive::Deprecated) }
+          dir && dir.arguments[:reason] # rubocop:disable Development/ContextIsPassedCop -- definition-related
+        end
+
+        # Set the deprecation reason for this member, or remove it by assigning `nil`
+        # @param text [String, nil]
+        def deprecation_reason=(text)
+          if text.nil?
+            remove_directive(GraphQL::Schema::Directive::Deprecated)
+          else
+            directive(GraphQL::Schema::Directive::Deprecated, reason: text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_directives.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module HasDirectives
+        # Create an instance of `dir_class` for `self`, using `options`.
+        #
+        # It removes a previously-attached instance of `dir_class`, if there is one.
+        #
+        # @return [void]
+        def directive(dir_class, **options)
+          @own_directives ||= []
+          HasDirectives.add_directive(self, @own_directives, dir_class, options)
+          nil
+        end
+
+        # Remove an attached instance of `dir_class`, if there is one
+        # @param dir_class [Class<GraphQL::Schema::Directive>]
+        # @return [viod]
+        def remove_directive(dir_class)
+          HasDirectives.remove_directive(@own_directives, dir_class)
+          nil
+        end
+
+        NO_DIRECTIVES = [].freeze
+
+        def directives
+          HasDirectives.get_directives(self, @own_directives, :directives)
+        end
+
+        class << self
+          def add_directive(schema_member, directives, directive_class, directive_options)
+            remove_directive(directives, directive_class) unless directive_class.repeatable?
+            directives << directive_class.new(schema_member, **directive_options)
+          end
+
+          def remove_directive(directives, directive_class)
+            directives && directives.reject! { |d| d.is_a?(directive_class) }
+          end
+
+          def get_directives(schema_member, directives, directives_method)
+            case schema_member
+            when Class
+              inherited_directives = if schema_member.superclass.respond_to?(directives_method)
+                get_directives(schema_member.superclass, schema_member.superclass.public_send(directives_method), directives_method)
+              else
+                NO_DIRECTIVES
+              end
+              if inherited_directives.any? && directives
+                dirs = []
+                merge_directives(dirs, inherited_directives)
+                merge_directives(dirs, directives)
+                dirs
+              elsif directives
+                directives
+              elsif inherited_directives.any?
+                inherited_directives
+              else
+                NO_DIRECTIVES
+              end
+            when Module
+              dirs = nil
+              schema_member.ancestors.reverse_each do |ancestor|
+                if ancestor.respond_to?(:own_directives) &&
+                    (anc_dirs = ancestor.own_directives).any?
+                  dirs ||= []
+                  merge_directives(dirs, anc_dirs)
+                end
+              end
+              if directives
+                dirs ||= []
+                merge_directives(dirs, directives)
+              end
+              dirs || NO_DIRECTIVES
+            when HasDirectives
+              directives || NO_DIRECTIVES
+            else
+              raise "Invariant: how could #{schema_member} not be a Class, Module, or instance of HasDirectives?"
+            end
+          end
+
+          private
+
+          # Modify `target` by adding items from `dirs` such that:
+          # - Any name conflict is overriden by the incoming member of `dirs`
+          # - Any other member of `dirs` is appended
+          # @param target [Array<GraphQL::Schema::Directive>]
+          # @param dirs [Array<GraphQL::Schema::Directive>]
+          # @return [void]
+          def merge_directives(target, dirs)
+            dirs.each do |dir|
+              if (idx = target.find_index { |d| d.graphql_name == dir.graphql_name })
+                target.slice!(idx)
+                target.insert(idx, dir)
+              else
+                target << dir
+              end
+            end
+            nil
+          end
+        end
+
+
+        protected
+
+        def own_directives
+          @own_directives
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_fields.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      # Shared code for Objects, Interfaces, Mutations, Subscriptions
+      module HasFields
+        # Add a field to this object or interface with the given definition
+        # @see {GraphQL::Schema::Field#initialize} for method signature
+        # @return [GraphQL::Schema::Field]
+        def field(*args, **kwargs, &block)
+          field_defn = field_class.from_options(*args, owner: self, **kwargs, &block)
+          add_field(field_defn)
+          field_defn
+        end
+
+        # @return [Hash<String => GraphQL::Schema::Field>] Fields on this object, keyed by name, including inherited fields
+        def fields(context = GraphQL::Query::NullContext)
+          warden = Warden.from_context(context)
+          is_object = self.respond_to?(:kind) && self.kind.object?
+          # Local overrides take precedence over inherited fields
+          visible_fields = {}
+          for ancestor in ancestors
+            if ancestor.respond_to?(:own_fields) &&
+                (is_object ? visible_interface_implementation?(ancestor, context, warden) : true)
+
+              ancestor.own_fields.each do |field_name, fields_entry|
+                # Choose the most local definition that passes `.visible?` --
+                # stop checking for fields by name once one has been found.
+                if !visible_fields.key?(field_name) && (f = Warden.visible_entry?(:visible_field?, fields_entry, context, warden))
+                  visible_fields[field_name] = f
+                end
+              end
+            end
+          end
+          visible_fields
+        end
+
+        def get_field(field_name, context = GraphQL::Query::NullContext)
+          warden = Warden.from_context(context)
+          is_object = self.respond_to?(:kind) && self.kind.object?
+          for ancestor in ancestors
+            if ancestor.respond_to?(:own_fields) &&
+                (is_object ? visible_interface_implementation?(ancestor, context, warden) : true) &&
+                (f_entry = ancestor.own_fields[field_name]) &&
+                (f = Warden.visible_entry?(:visible_field?, f_entry, context, warden))
+              return f
+            end
+          end
+          nil
+        end
+
+        # A list of Ruby keywords.
+        #
+        # @api private
+        RUBY_KEYWORDS = [:class, :module, :def, :undef, :begin, :rescue, :ensure, :end, :if, :unless, :then, :elsif, :else, :case, :when, :while, :until, :for, :break, :next, :redo, :retry, :in, :do, :return, :yield, :super, :self, :nil, :true, :false, :and, :or, :not, :alias, :defined?, :BEGIN, :END, :__LINE__, :__FILE__]
+
+        # A list of GraphQL-Ruby keywords.
+        #
+        # @api private
+        GRAPHQL_RUBY_KEYWORDS = [:context, :object, :raw_value]
+
+        # A list of field names that we should advise users to pick a different
+        # resolve method name.
+        #
+        # @api private
+        CONFLICT_FIELD_NAMES = Set.new(GRAPHQL_RUBY_KEYWORDS + RUBY_KEYWORDS + Object.instance_methods)
+
+        # Register this field with the class, overriding a previous one if needed.
+        # @param field_defn [GraphQL::Schema::Field]
+        # @return [void]
+        def add_field(field_defn, method_conflict_warning: field_defn.method_conflict_warning?)
+          # Check that `field_defn.original_name` equals `resolver_method` and `method_sym` --
+          # that shows that no override value was given manually.
+          if method_conflict_warning && CONFLICT_FIELD_NAMES.include?(field_defn.resolver_method) && field_defn.original_name == field_defn.resolver_method && field_defn.original_name == field_defn.method_sym && field_defn.hash_key.nil? && field_defn.dig_keys.nil?
+            warn(conflict_field_name_warning(field_defn))
+          end
+          prev_defn = own_fields[field_defn.name]
+
+          case prev_defn
+          when nil
+            own_fields[field_defn.name] = field_defn
+          when Array
+            prev_defn << field_defn
+          when GraphQL::Schema::Field
+            own_fields[field_defn.name] = [prev_defn, field_defn]
+          else
+            raise "Invariant: unexpected previous field definition for #{field_defn.name.inspect}: #{prev_defn.inspect}"
+          end
+
+          nil
+        end
+
+        # @return [Class] The class to initialize when adding fields to this kind of schema member
+        def field_class(new_field_class = nil)
+          if new_field_class
+            @field_class = new_field_class
+          elsif defined?(@field_class) && @field_class
+            @field_class
+          else
+            find_inherited_value(:field_class, GraphQL::Schema::Field)
+          end
+        end
+
+        def global_id_field(field_name, **kwargs)
+          type = self
+          field field_name, "ID", **kwargs, null: false
+          define_method(field_name) do
+            context.schema.id_from_object(object, type, context)
+          end
+        end
+
+        # @return [Hash<String => GraphQL::Schema::Field, Array<GraphQL::Schema::Field>>] Fields defined on this class _specifically_, not parent classes
+        def own_fields
+          @own_fields ||= {}
+        end
+
+        def all_field_definitions
+          all_fields = {}
+          ancestors.reverse_each do |ancestor|
+            if ancestor.respond_to?(:own_fields)
+              all_fields.merge!(ancestor.own_fields)
+            end
+          end
+          all_fields = all_fields.values
+          all_fields.flatten!
+          all_fields
+        end
+
+        private
+
+        # If `type` is an interface, and `self` has a type membership for `type`, then make sure it's visible.
+        def visible_interface_implementation?(type, context, warden)
+          if type.respond_to?(:kind) && type.kind.interface?
+            implements_this_interface = false
+            implementation_is_visible = false
+            interface_type_memberships.each do |tm|
+              if tm.abstract_type == type
+                implements_this_interface ||= true
+                if warden.visible_type_membership?(tm, context)
+                  implementation_is_visible = true
+                  break
+                end
+              end
+            end
+            # It's possible this interface came by way of `include` in another interface which this
+            # object type _does_ implement, and that's ok
+            implements_this_interface ? implementation_is_visible : true
+          else
+            # If there's no implementation, then we're looking at Ruby-style inheritance instead
+            true
+          end
+        end
+
+        # @param [GraphQL::Schema::Field]
+        # @return [String] A warning to give when this field definition might conflict with a built-in method
+        def conflict_field_name_warning(field_defn)
+          "#{self.graphql_name}'s `field :#{field_defn.original_name}` conflicts with a built-in method, use `resolver_method:` to pick a different resolver method for this field (for example, `resolver_method: :resolve_#{field_defn.resolver_method}` and `def resolve_#{field_defn.resolver_method}`). Or use `method_conflict_warning: false` to suppress this warning."
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_interfaces.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module HasInterfaces
+        def implements(*new_interfaces, **options)
+          new_memberships = []
+          new_interfaces.each do |int|
+            if int.is_a?(Module)
+              unless int.include?(GraphQL::Schema::Interface)
+                raise "#{int} cannot be implemented since it's not a GraphQL Interface. Use `include` for plain Ruby modules."
+              end
+
+              new_memberships << int.type_membership_class.new(int, self, **options)
+
+              # Include the methods here,
+              # `.fields` will use the inheritance chain
+              # to find inherited fields
+              include(int)
+
+              # If this interface has interfaces of its own, add those, too
+              int.interfaces.each do |next_interface|
+                implements(next_interface)
+              end
+            elsif int.is_a?(String) || int.is_a?(GraphQL::Schema::LateBoundType)
+              if options.any?
+                raise ArgumentError, "`implements(...)` doesn't support options with late-loaded types yet. Remove #{options} and open an issue to request this feature."
+              end
+              new_memberships << int
+            else
+              raise ArgumentError, "Unexpected interface definition (expected module): #{int} (#{int.class})"
+            end
+          end
+
+          # Remove any String or late-bound interfaces which are being replaced
+          own_interface_type_memberships.reject! { |old_i_m|
+            if !(old_i_m.respond_to?(:abstract_type) && old_i_m.abstract_type.is_a?(Module))
+              old_int_type = old_i_m.respond_to?(:abstract_type) ? old_i_m.abstract_type : old_i_m
+              old_name = Schema::Member::BuildType.to_type_name(old_int_type)
+
+              new_memberships.any? { |new_i_m|
+                new_int_type = new_i_m.respond_to?(:abstract_type) ? new_i_m.abstract_type : new_i_m
+                new_name = Schema::Member::BuildType.to_type_name(new_int_type)
+
+                new_name == old_name
+              }
+            end
+          }
+          own_interface_type_memberships.concat(new_memberships)
+        end
+
+        def own_interface_type_memberships
+          @own_interface_type_memberships ||= []
+        end
+
+        def interface_type_memberships
+          own_interface_type_memberships + ((self.is_a?(Class) && superclass.respond_to?(:interface_type_memberships)) ? superclass.interface_type_memberships : [])
+        end
+
+        # param context [Query::Context] If omitted, skip filtering.
+        def interfaces(context = GraphQL::Query::NullContext)
+          warden = Warden.from_context(context)
+          visible_interfaces = []
+          own_interface_type_memberships.each do |type_membership|
+            # During initialization, `type_memberships` can hold late-bound types
+            case type_membership
+            when String, Schema::LateBoundType
+              visible_interfaces << type_membership
+            when Schema::TypeMembership
+              if warden.visible_type_membership?(type_membership, context)
+                visible_interfaces << type_membership.abstract_type
+              end
+            else
+              raise "Invariant: Unexpected type_membership #{type_membership.class}: #{type_membership.inspect}"
+            end
+          end
+
+          if self.is_a?(Class) && superclass <= GraphQL::Schema::Object
+            visible_interfaces.concat(superclass.interfaces(context))
+          end
+
+          visible_interfaces.uniq
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_path.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module HasPath
+        # @return [String] A description of this member's place in the GraphQL schema
+        def path
+          path_str = if self.respond_to?(:graphql_name)
+            self.graphql_name
+          elsif self.class.respond_to?(:graphql_name)
+            # Instances of resolvers
+            self.class.graphql_name
+          end
+
+          if self.respond_to?(:owner) && owner.respond_to?(:path)
+            path_str = "#{owner.path}.#{path_str}"
+          end
+
+          path_str
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_unresolved_type_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      # Set up a type-specific error to make debugging & bug tracker integration better
+      module HasUnresolvedTypeError
+        private
+        def add_unresolved_type_error(child_class)
+          child_class.const_set(:UnresolvedTypeError, Class.new(GraphQL::UnresolvedTypeError))
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/has_validators.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Member
+      module HasValidators
+        include Schema::FindInheritedValue::EmptyObjects
+
+        # Build {GraphQL::Schema::Validator}s based on the given configuration
+        # and use them for this schema member
+        # @param validation_config [Hash{Symbol => Hash}]
+        # @return [void]
+        def validates(validation_config)
+          new_validators = GraphQL::Schema::Validator.from_config(self, validation_config)
+          @own_validators ||= []
+          @own_validators.concat(new_validators)
+          nil
+        end
+
+        # @return [Array<GraphQL::Schema::Validator>]
+        def validators
+          own_validators = @own_validators || EMPTY_ARRAY
+          if self.is_a?(Class) && superclass.respond_to?(:validators) && (inherited_validators = superclass.validators).any?
+            inherited_validators + own_validators
+          else
+            own_validators
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/relay_shortcuts.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module RelayShortcuts
+        def edge_type_class(new_edge_type_class = nil)
+          if new_edge_type_class
+            @edge_type_class = new_edge_type_class
+          else
+            # Don't call `ancestor.edge_type_class`
+            # because we don't want a fallback from any ancestors --
+            # only apply the fallback if _no_ ancestor has a configured value!
+            for ancestor in self.ancestors
+              if ancestor.respond_to?(:configured_edge_type_class, true) && (etc = ancestor.configured_edge_type_class)
+                return etc
+              end
+            end
+            Types::Relay::BaseEdge
+          end
+        end
+
+        def connection_type_class(new_connection_type_class = nil)
+          if new_connection_type_class
+            @connection_type_class = new_connection_type_class
+          else
+            # Don't call `ancestor.connection_type_class`
+            # because we don't want a fallback from any ancestors --
+            # only apply the fallback if _no_ ancestor has a configured value!
+            for ancestor in self.ancestors
+              if ancestor.respond_to?(:configured_connection_type_class, true) && (ctc = ancestor.configured_connection_type_class)
+                return ctc
+              end
+            end
+            Types::Relay::BaseConnection
+          end
+        end
+
+        def edge_type
+          @edge_type ||= begin
+            edge_name = self.graphql_name + "Edge"
+            node_type_class = self
+            Class.new(edge_type_class) do
+              graphql_name(edge_name)
+              node_type(node_type_class)
+            end
+          end
+        end
+
+        def connection_type
+          @connection_type ||= begin
+            conn_name = self.graphql_name + "Connection"
+            edge_type_class = self.edge_type
+            Class.new(connection_type_class) do
+              graphql_name(conn_name)
+              edge_type(edge_type_class)
+            end
+          end
+        end
+
+        protected
+
+        def configured_connection_type_class
+          @connection_type_class
+        end
+
+        def configured_edge_type_class
+          @edge_type_class
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/scoped.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module Scoped
+        # This is called when a field has `scope: true`.
+        # The field's return type class receives this call.
+        #
+        # By default, it's a no-op. Override it to scope your objects.
+        #
+        # @param items [Object] Some list-like object (eg, Array, ActiveRecord::Relation)
+        # @param context [GraphQL::Query::Context]
+        # @return [Object] Another list-like object, scoped to the current context
+        def scope_items(items, context)
+          items
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/type_system_helpers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module TypeSystemHelpers
+        # @return [Schema::NonNull] Make a non-null-type representation of this type
+        def to_non_null_type
+          @to_non_null_type ||= GraphQL::Schema::NonNull.new(self)
+        end
+
+        # @return [Schema::List] Make a list-type representation of this type
+        def to_list_type
+          @to_list_type ||= GraphQL::Schema::List.new(self)
+        end
+
+        # @return [Boolean] true if this is a non-nullable type. A nullable list of non-nullables is considered nullable.
+        def non_null?
+          false
+        end
+
+        # @return [Boolean] true if this is a list type. A non-nullable list is considered a list.
+        def list?
+          false
+        end
+
+        def to_type_signature
+          graphql_name
+        end
+
+        # @return [GraphQL::TypeKinds::TypeKind]
+        def kind
+          raise GraphQL::RequiredImplementationMissingError, "No `.kind` defined for #{self}"
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/member/validates_input.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module ValidatesInput
+        def valid_input?(val, ctx)
+          validate_input(val, ctx).valid?
+        end
+
+        def validate_input(val, ctx, max_errors: nil)
+          if val.nil?
+            Query::InputValidationResult::VALID
+          else
+            validate_non_null_input(val, ctx, max_errors: max_errors) || Query::InputValidationResult::VALID
+          end
+        end
+
+        def valid_isolated_input?(v)
+          valid_input?(v, GraphQL::Query::NullContext)
+        end
+
+        def coerce_isolated_input(v)
+          coerce_input(v, GraphQL::Query::NullContext)
+        end
+
+        def coerce_isolated_result(v)
+          coerce_result(v, GraphQL::Query::NullContext)
+        end
+      end
+    end
+  end
+end