Merge pull request rmosolgo#1446 from rmosolgo/type-cleanup

Improve 1.8 type inspection

Author: Robert Mosolgo

.rubocop.yml

@@ -10,13 +10,13 @@ AllCops:
 
 # def ...
 # end
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   EnforcedStyleAlignWith: def
 
 # value = if
 #   # ...
 # end
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 Lint/UselessAssignment:

lib/graphql/deprecated_dsl.rb

@@ -24,8 +24,8 @@ module DeprecatedDSL
 
     def self.activate
       TYPE_CLASSES.each { |c| c.extend(Methods) }
-      GraphQL::Schema::Member::ListTypeProxy.include(Methods)
-      GraphQL::Schema::Member::NonNullTypeProxy.include(Methods)
+      GraphQL::Schema::List.include(Methods)
+      GraphQL::Schema::NonNull.include(Methods)
     end
     module Methods
       def !

lib/graphql/schema.rb

@@ -21,6 +21,8 @@
 
 
 require "graphql/schema/member"
+require "graphql/schema/list"
+require "graphql/schema/non_null"
 require "graphql/schema/argument"
 require "graphql/schema/enum_value"
 require "graphql/schema/enum"

lib/graphql/schema/argument.rb

@@ -7,6 +7,7 @@ class Argument
 
       NO_DEFAULT = :__no_default__
 
+      # @return [String] the GraphQL name for this argument, camelized unless `camelize: false` is provided
       attr_reader :name
 
       # @return [GraphQL::Schema::Field, Class] The field or input object this argument belongs to
@@ -20,12 +21,11 @@ class Argument
       # @param default_value [Object]
       # @param camelize [Boolean] if true, the name will be camelized when building the schema
       def initialize(arg_name, type_expr, desc = nil, required:, description: nil, default_value: NO_DEFAULT, camelize: true, owner:, &definition_block)
-        @name = arg_name.to_s
+        @name = camelize ? Member::BuildType.camelize(arg_name.to_s) : arg_name.to_s
         @type_expr = type_expr
         @description = desc || description
         @null = !required
         @default_value = default_value
-        @camelize = camelize
         @owner = owner
 
         if definition_block
@@ -43,7 +43,7 @@ def description(text = nil)
 
       def to_graphql
         argument = GraphQL::Argument.new
-        argument.name = @camelize ? Member::BuildType.camelize(@name) : @name
+        argument.name = @name
         argument.type = -> { type }
         argument.description = @description
         argument.metadata[:type_class] = self

lib/graphql/schema/enum.rb

@@ -68,6 +68,10 @@ def enum_value_class(new_enum_value_class = nil)
           @enum_value_class || (superclass <= GraphQL::Schema::Enum ? superclass.enum_value_class : nil)
         end
 
+        def kind
+          GraphQL::TypeKinds::ENUM
+        end
+
         private
 
         def own_values

lib/graphql/schema/field.rb

@@ -7,7 +7,7 @@ class Field
       include GraphQL::Schema::Member::AcceptsDefinition
       include GraphQL::Schema::Member::HasArguments
 
-      # @return [String]
+      # @return [String] the GraphQL name for this field, camelized unless `camelize: false` is provided
       attr_reader :name
 
       # @return [String]
@@ -67,7 +67,10 @@ def initialize(name, return_type_expr = nil, desc = nil, owner: nil, null: nil,
         if (field || function || resolve || resolve) && extras.any?
           raise ArgumentError, "keyword `extras:` may only be used with method-based resolve, please remove `field:`, `function:`, `resolve:`, or `mutation:`"
         end
-        @name = name.to_s
+        if return_type_expr.is_a?(GraphQL::Field)
+          raise ArgumentError, "A GraphQL::Field was passed as the second argument, use the `field:` keyword for this instead."
+        end
+        @name = camelize ? Member::BuildType.camelize(name.to_s) : name.to_s
         if description && desc
           raise ArgumentError, "Provide description as a positional argument or `description:` keyword, but not both (#{desc.inspect}, #{description.inspect})"
         end
@@ -96,7 +99,6 @@ def initialize(name, return_type_expr = nil, desc = nil, owner: nil, null: nil,
         @max_page_size = max_page_size
         @introspection = introspection
         @extras = extras
-        @camelize = camelize
         @mutation = mutation
         @mutation_class = mutation_class
         # Override the default from HasArguments
@@ -154,7 +156,7 @@ def to_graphql
           GraphQL::Field.new
         end
 
-        field_defn.name = @camelize ? Member::BuildType.camelize(name) : name
+        field_defn.name = @name
         if @return_type_expr
           field_defn.type = -> { type }
         end

lib/graphql/schema/input_object.rb

@@ -70,6 +70,10 @@ def to_graphql
           type_defn.arguments_class = self
           type_defn
         end
+
+        def kind
+          GraphQL::TypeKinds::INPUT_OBJECT
+        end
       end
     end
   end

lib/graphql/schema/interface.rb

@@ -7,6 +7,7 @@ module DefinitionMethods
         include GraphQL::Schema::Member::CachedGraphQLDefinition
         include GraphQL::Relay::TypeExtensions
         include GraphQL::Schema::Member::BaseDSLMethods
+        include GraphQL::Schema::Member::TypeSystemHelpers
         include GraphQL::Schema::Member::HasFields
 
         # Methods defined in this block will be:
@@ -66,6 +67,10 @@ def to_graphql
           type_defn
         end
 
+        def kind
+          GraphQL::TypeKinds::INTERFACE
+        end
+
         protected
 
         def own_interfaces

lib/graphql/schema/list.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # Represents a list type in the schema.
+    # Wraps a {Schema::Member} as a list type.
+    # @see {Schema::Member::TypeSystemHelpers#to_list_type}
+    class List
+      include GraphQL::Schema::Member::CachedGraphQLDefinition
+      include GraphQL::Schema::Member::TypeSystemHelpers
+
+      # @return [Class, Module] The inner type of this list, the type of which one or more objects may be present.
+      attr_reader :of_type
+
+      def initialize(of_type)
+        @of_type = of_type
+      end
+
+      def to_graphql
+        @of_type.graphql_definition.to_list_type
+      end
+
+      def kind
+        GraphQL::TypeKinds::LIST
+      end
+    end
+  end
+end

lib/graphql/schema/member.rb

@@ -3,6 +3,7 @@
 require 'graphql/schema/member/base_dsl_methods'
 require 'graphql/schema/member/cached_graphql_definition'
 require 'graphql/schema/member/graphql_type_names'
+require 'graphql/schema/member/type_system_helpers'
 require "graphql/relay/type_extensions"
 
 module GraphQL
@@ -16,12 +17,11 @@ class Member
       extend CachedGraphQLDefinition
       extend GraphQL::Relay::TypeExtensions
       extend BaseDSLMethods
+      extend TypeSystemHelpers
     end
   end
 end
 
-require 'graphql/schema/member/list_type_proxy'
-require 'graphql/schema/member/non_null_type_proxy'
 require 'graphql/schema/member/has_arguments'
 require 'graphql/schema/member/has_fields'
 require 'graphql/schema/member/instrumentation'

lib/graphql/schema/member/base_dsl_methods.rb

@@ -67,16 +67,6 @@ def to_graphql
           raise NotImplementedError
         end
 
-        # @return [ListTypeProxy] Make a list-type representation of this type
-        def to_list_type
-          ListTypeProxy.new(self)
-        end
-
-        # @return [NonNullTypeProxy] Make a non-null-type representation of this type
-        def to_non_null_type
-          NonNullTypeProxy.new(self)
-        end
-
         def overridden_graphql_name
           @graphql_name || find_inherited_method(:overridden_graphql_name, nil)
         end

lib/graphql/schema/member/build_type.rb

@@ -42,7 +42,7 @@ def parse_type(type_expr, null:)
                 if maybe_type.respond_to?(:graphql_definition)
                   maybe_type
                 else
-                  raise "Unexpected class/module found for GraphQL type: #{type_expr} (must be type definition class/module)"
+                  raise ArgumentError, "Unexpected class/module found for GraphQL type: #{type_expr} (must be type definition class/module)"
                 end
               end
             end
@@ -72,6 +72,8 @@ def parse_type(type_expr, null:)
               # Eg `String` => GraphQL::STRING_TYPE
               parse_type(type_expr.name, null: true)
             end
+          when false
+            raise ArgumentError, "Received `false` instead of a type, maybe a `!` should be replaced with `null: true` (for fields) or `required: true` (for arguments)"
           end
 
           if return_type.nil?

lib/graphql/schema/member/list_type_proxy.rb

@@ -0,0 +1,34 @@
+# 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
+          GraphQL::Schema::NonNull.new(self)
+        end
+
+        # @return [Schema::List] Make a list-type representation of this type
+        def 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
+
+        # @return [GraphQL::TypeKinds::TypeKind]
+        def kind
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

lib/graphql/schema/member/non_null_type_proxy.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # Wraps a {Schema::Member} when it is required.
+    # @see {Schema::Member::TypeSystemHelpers#to_non_null_type}
+    class NonNull
+      include GraphQL::Schema::Member::CachedGraphQLDefinition
+      include GraphQL::Schema::Member::TypeSystemHelpers
+      attr_reader :of_type
+      def initialize(of_type)
+        @of_type = of_type
+      end
+
+      def to_graphql
+        @of_type.graphql_definition.to_non_null_type
+      end
+
+      # @return [true]
+      def non_null?
+        true
+      end
+
+      # @return [Boolean] True if this type wraps a list type
+      def list?
+        @of_type.list?
+      end
+
+      def kind
+        GraphQL::TypeKinds::NON_NULL
+      end
+    end
+  end
+end

lib/graphql/schema/member/type_system_helpers.rb

@@ -71,6 +71,10 @@ def to_graphql
 
           obj_type
         end
+
+        def kind
+          GraphQL::TypeKinds::OBJECT
+        end
       end
     end
   end

lib/graphql/schema/non_null.rb

@@ -25,6 +25,10 @@ def to_graphql
           type_defn.metadata[:type_class] = self
           type_defn
         end
+
+        def kind
+          GraphQL::TypeKinds::SCALAR
+        end
       end
     end
   end

lib/graphql/schema/object.rb

@@ -26,6 +26,10 @@ def to_graphql
           type_defn.metadata[:type_class] = self
           type_defn
         end
+
+        def kind
+          GraphQL::TypeKinds::UNION
+        end
       end
     end
   end