graphql 1.9.0 → 2.1.1

data/lib/graphql/language/nodes.rb

@@ -2,6 +2,7 @@
 module GraphQL
   module Language
     module Nodes
+      NONE = GraphQL::EmptyObjects::EMPTY_ARRAY
       # {AbstractNode} is the base class for all nodes in a GraphQL AST.
       #
       # It provides some APIs for working with ASTs:
@@ -9,6 +10,7 @@ module GraphQL
       # - `scalars` returns all scalar (Ruby) values attached to this one. Used for comparing nodes.
       # - `to_query_string` turns an AST node into a GraphQL string
       class AbstractNode
+
         module DefinitionNode
           # This AST node's {#line} returns the first line, which may be the description.
           # @return [Integer] The first line of the definition (not the description)
@@ -25,27 +27,31 @@ module GraphQL
         # Initialize a node by extracting its position,
         # then calling the class's `initialize_node` method.
         # @param options [Hash] Initial attributes for this node
-        def initialize(options={})
+        def initialize(options = {})
           if options.key?(:position_source)
             position_source = options.delete(:position_source)
-            @line, @col = position_source.line_and_column
+            @line = position_source[1]
+            @col = position_source[2]
+          else
+            @line = options.delete(:line)
+            @col = options.delete(:col)
           end
 
           @filename = options.delete(:filename)
 
-          initialize_node(options)
+          initialize_node(**options)
         end
 
         # Value equality
         # @return [Boolean] True if `self` is equivalent to `other`
-        def eql?(other)
+        def ==(other)
           return true if equal?(other)
-          other.is_a?(self.class) &&
-            other.scalars.eql?(self.scalars) &&
-            other.children.eql?(self.children)
+          other.kind_of?(self.class) &&
+            other.scalars == self.scalars &&
+            other.children == self.children
         end
 
-        NO_CHILDREN = [].freeze
+        NO_CHILDREN = GraphQL::EmptyObjects::EMPTY_ARRAY
 
         # @return [Array<GraphQL::Language::Nodes::AbstractNode>] all nodes in the tree below this one
         def children
@@ -61,11 +67,11 @@ module GraphQL
         def initialize_copy(other)
           @children = nil
           @scalars = nil
+          @query_string = nil
         end
 
-        # @return [Symbol] the method to call on {Language::Visitor} for this node
-        def visit_method
-          raise NotImplementedError, "#{self.class.name}#visit_method shold return a symbol"
+        def children_method_name
+          self.class.children_method_name
         end
 
         def position
@@ -73,18 +79,18 @@ module GraphQL
         end
 
         def to_query_string(printer: GraphQL::Language::Printer.new)
-          printer.print(self)
+          if printer.is_a?(GraphQL::Language::Printer)
+            @query_string ||= printer.print(self)
+          else
+            printer.print(self)
+          end
         end
 
         # This creates a copy of `self`, with `new_options` applied.
         # @param new_options [Hash]
         # @return [AbstractNode] a shallow copy of `self`
         def merge(new_options)
-          copied_self = dup
-          new_options.each do |key, value|
-            copied_self.instance_variable_set(:"@#{key}", value)
-          end
-          copied_self
+          dup.merge!(new_options)
         end
 
         # Copy `self`, but modify the copy so that `previous_child` is replaced by `new_child`
@@ -122,6 +128,15 @@ module GraphQL
           copy_of_self
         end
 
+        protected
+
+        def merge!(new_options)
+          new_options.each do |key, value|
+            instance_variable_set(:"@#{key}", value)
+          end
+          self
+        end
+
         class << self
           # Add a default `#visit_method` and `#children_method_name` using the class name
           def inherited(child_class)
@@ -131,17 +146,26 @@ module GraphQL
               .gsub(/([a-z])([A-Z])/,'\1_\2') # insert underscores
               .downcase # remove caps
 
-            child_class.module_eval <<-RUBY
+            child_class.module_eval <<-RUBY, __FILE__, __LINE__
               def visit_method
                 :on_#{name_underscored}
               end
 
-              def children_method_name
-                :#{name_underscored}s
+              class << self
+                attr_accessor :children_method_name
+
+                def visit_method
+                  :on_#{name_underscored}
+                end
               end
+              self.children_method_name = :#{name_underscored}s
             RUBY
           end
 
+          def children_of_type
+            @children_methods
+          end
+
           private
 
           # Name accessors which return lists of nodes,
@@ -150,7 +174,7 @@ module GraphQL
           # - Add a persistent update method to add a child
           # - Generate a `#children` method
           def children_methods(children_of_type)
-            if @children_methods
+            if defined?(@children_methods)
               raise "Can't re-call .children_methods for #{self} (already have: #{@children_methods})"
             else
               @children_methods = children_of_type
@@ -186,14 +210,27 @@ module GraphQL
               else
                 module_eval <<-RUBY, __FILE__, __LINE__
                   def children
-                    @children ||= (#{children_of_type.keys.map { |k| "@#{k}" }.join(" + ")}).freeze
+                    @children ||= begin
+                      if #{children_of_type.keys.map { |k| "@#{k}.any?" }.join(" || ")}
+                        new_children = []
+                        #{children_of_type.keys.map { |k| "new_children.concat(@#{k})" }.join("; ")}
+                        new_children.freeze
+                        new_children
+                      else
+                        NO_CHILDREN
+                      end
+                    end
                   end
                 RUBY
               end
             end
 
             if defined?(@scalar_methods)
-              generate_initialize_node
+              if !method_defined?(:initialize_node)
+                generate_initialize_node
+              else
+                # This method was defined manually
+              end
             else
               raise "Can't generate_initialize_node because scalar_methods wasn't called; call it before children_methods"
             end
@@ -203,7 +240,7 @@ module GraphQL
           # - Add reader methods
           # - Add a `#scalars` method
           def scalar_methods(*method_names)
-            if @scalar_methods
+            if defined?(@scalar_methods)
               raise "Can't re-call .scalar_methods for #{self} (already have: #{@scalar_methods})"
             else
               @scalar_methods = method_names
@@ -240,15 +277,22 @@ module GraphQL
               return
             else
               arguments = scalar_method_names.map { |m| "#{m}: nil"} +
-                @children_methods.keys.map { |m| "#{m}: []" }
+                @children_methods.keys.map { |m| "#{m}: NO_CHILDREN" }
 
               assignments = scalar_method_names.map { |m| "@#{m} = #{m}"} +
                 @children_methods.keys.map { |m| "@#{m} = #{m}.freeze" }
 
+              keywords = scalar_method_names.map { |m| "#{m}: #{m}"} +
+                @children_methods.keys.map { |m| "#{m}: #{m}" }
+
               module_eval <<-RUBY, __FILE__, __LINE__
                 def initialize_node #{arguments.join(", ")}
                   #{assignments.join("\n")}
                 end
+
+                def self.from_a(filename, line, col, #{(scalar_method_names + @children_methods.keys).join(", ")})
+                  self.new(filename: filename, line: line, col: col, #{keywords.join(", ")})
+                end
               RUBY
             end
           end
@@ -276,10 +320,10 @@ module GraphQL
         #   @return [String] the key for this argument
 
         # @!attribute value
-        #   @return [String, Float, Integer, Boolean, Array, InputObject] The value passed for this key
+        #   @return [String, Float, Integer, Boolean, Array, InputObject, VariableIdentifier] The value passed for this key
 
         def children
-          @children ||= Array(value).flatten.select { |v| v.is_a?(AbstractNode) }
+          @children ||= Array(value).flatten.tap { _1.select! { |v| v.is_a?(AbstractNode) } }
         end
       end
 
@@ -294,42 +338,13 @@ module GraphQL
       class DirectiveDefinition < AbstractNode
         include DefinitionNode
         attr_reader :description
-        scalar_methods :name
+        scalar_methods :name, :repeatable
         children_methods(
-          locations: Nodes::DirectiveLocation,
           arguments: Nodes::Argument,
+          locations: Nodes::DirectiveLocation,
         )
       end
 
-      # This is the AST root for normal queries
-      #
-      # @example Deriving a document by parsing a string
-      #   document = GraphQL.parse(query_string)
-      #
-      # @example Creating a string from a document
-      #   document.to_query_string
-      #   # { ... }
-      #
-      # @example Creating a custom string from a document
-      #  class VariableScrubber < GraphQL::Language::Printer
-      #    def print_argument(arg)
-      #      "#{arg.name}: <HIDDEN>"
-      #    end
-      #  end
-      #
-      #  document.to_query_string(printer: VariableSrubber.new)
-      #
-      class Document < AbstractNode
-        scalar_methods false
-        children_methods(definitions: nil)
-        # @!attribute definitions
-        #   @return [Array<OperationDefinition, FragmentDefinition>] top-level GraphQL units: operations or fragments
-
-        def slice_definition(name)
-          GraphQL::Language::DefinitionSlice.slice(self, name)
-        end
-      end
-
       # An enum value. The string is available as {#name}.
       class Enum < NameOnlyNode
       end
@@ -350,29 +365,25 @@ module GraphQL
         # @!attribute selections
         #   @return [Array<Nodes::Field>] Selections on this object (or empty array if this is a scalar field)
 
-        def initialize_node(name: nil, arguments: [], directives: [], selections: [], **kwargs)
-          @name = name
-          @arguments = arguments
-          @directives = directives
-          @selections = selections
+        def initialize_node(attributes)
+          @name = attributes[:name]
+          @arguments = attributes[:arguments] || NONE
+          @directives = attributes[:directives] || NONE
+          @selections = attributes[:selections] || NONE
           # oops, alias is a keyword:
-          @alias = kwargs.fetch(:alias, nil)
+          @alias = attributes[:alias]
         end
 
-        # Override this because default is `:fields`
-        def children_method_name
-          :selections
+        def self.from_a(filename, line, col, graphql_alias, name, arguments, directives, selections) # rubocop:disable Metrics/ParameterLists
+          self.new(filename: filename, line: line, col: col, alias: graphql_alias, name: name, arguments: arguments, directives: directives, selections: selections)
         end
+
+        # Override this because default is `:fields`
+        self.children_method_name = :selections
       end
 
       # A reusable fragment, defined at document-level.
       class FragmentDefinition < AbstractNode
-        scalar_methods :name, :type
-        children_methods({
-          selections: GraphQL::Language::Nodes::Field,
-          directives: GraphQL::Language::Nodes::Directive,
-        })
-
         # @!attribute name
         #   @return [String] the identifier for this fragment, which may be applied with `...#{name}`
 
@@ -385,9 +396,17 @@ module GraphQL
           @selections = selections
         end
 
-        def children_method_name
-          :definitions
+        def self.from_a(filename, line, col, name, type, directives, selections)
+          self.new(filename: filename, line: line, col: col, name: name, type: type, directives: directives, selections: selections)
         end
+
+        scalar_methods :name, :type
+        children_methods({
+          selections: GraphQL::Language::Nodes::Field,
+          directives: GraphQL::Language::Nodes::Directive,
+        })
+
+        self.children_method_name = :definitions
       end
 
       # Application of a named fragment in a selection
@@ -395,9 +414,7 @@ module GraphQL
         scalar_methods :name
         children_methods(directives: GraphQL::Language::Nodes::Directive)
 
-        def children_method_name
-          :selections
-        end
+        self.children_method_name = :selections
 
         # @!attribute name
         #   @return [String] The identifier of the fragment to apply, corresponds with {FragmentDefinition#name}
@@ -407,13 +424,11 @@ module GraphQL
       class InlineFragment < AbstractNode
         scalar_methods :type
         children_methods({
-          selections: GraphQL::Language::Nodes::Field,
           directives: GraphQL::Language::Nodes::Directive,
+          selections: GraphQL::Language::Nodes::Field,
         })
 
-        def children_method_name
-          :selections
-        end
+        self.children_method_name = :selections
 
         # @!attribute type
         #   @return [String, nil] Name of the type this fragment applies to, or `nil` if this fragment applies to any type
@@ -436,9 +451,7 @@ module GraphQL
           end
         end
 
-        def children_method_name
-          :value
-        end
+        self.children_method_name = :value
 
         private
 
@@ -460,7 +473,6 @@ module GraphQL
         end
       end
 
-
       # A list type definition, denoted with `[...]` (used for variable type definitions)
       class ListType < WrapperType
       end
@@ -481,6 +493,8 @@ module GraphQL
 
         # @!attribute name
         #   @return [String] The identifier for this variable, _without_ `$`
+
+        self.children_method_name = :variables
       end
 
       # A query, mutation or subscription.
@@ -490,12 +504,12 @@ module GraphQL
         scalar_methods :operation_type, :name
         children_methods({
           variables: GraphQL::Language::Nodes::VariableDefinition,
-          selections: GraphQL::Language::Nodes::Field,
           directives: GraphQL::Language::Nodes::Directive,
+          selections: GraphQL::Language::Nodes::Field,
         })
 
         # @!attribute variables
-        #   @return [Array<VariableDefinition>] Variable definitions for this operation
+        #   @return [Array<VariableDefinition>] Variable $definitions for this operation
 
         # @!attribute selections
         #   @return [Array<Field>] Root-level fields on this operation
@@ -506,8 +520,35 @@ module GraphQL
         # @!attribute name
         #   @return [String, nil] The name for this operation, or `nil` if unnamed
 
-        def children_method_name
-          :definitions
+        self.children_method_name = :definitions
+      end
+
+      # This is the AST root for normal queries
+      #
+      # @example Deriving a document by parsing a string
+      #   document = GraphQL.parse(query_string)
+      #
+      # @example Creating a string from a document
+      #   document.to_query_string
+      #   # { ... }
+      #
+      # @example Creating a custom string from a document
+      #  class VariableScrubber < GraphQL::Language::Printer
+      #    def print_argument(arg)
+      #      print_string("#{arg.name}: <HIDDEN>")
+      #    end
+      #  end
+      #
+      #  document.to_query_string(printer: VariableScrubber.new)
+      #
+      class Document < AbstractNode
+        scalar_methods false
+        children_methods(definitions: nil)
+        # @!attribute definitions
+        #   @return [Array<OperationDefinition, FragmentDefinition>] top-level GraphQL units: operations or fragments
+
+        def slice_definition(name)
+          GraphQL::Language::DefinitionSlice.slice(self, name)
         end
       end
 
@@ -517,6 +558,7 @@ module GraphQL
 
       # Usage of a variable in a query. Name does _not_ include `$`.
       class VariableIdentifier < NameOnlyNode
+        self.children_method_name = :value
       end
 
       class SchemaDefinition < AbstractNode
@@ -525,9 +567,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class SchemaExtension < AbstractNode
@@ -535,9 +575,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class ScalarTypeDefinition < AbstractNode
@@ -547,9 +585,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class ScalarTypeExtension < AbstractNode
@@ -557,9 +593,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class InputValueDefinition < AbstractNode
@@ -569,9 +603,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :fields
-        end
+        self.children_method_name = :fields
       end
 
       class FieldDefinition < AbstractNode
@@ -579,12 +611,10 @@ module GraphQL
         attr_reader :description
         scalar_methods :name, :type
         children_methods({
-          directives: GraphQL::Language::Nodes::Directive,
           arguments: GraphQL::Language::Nodes::InputValueDefinition,
+          directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :fields
-        end
+        self.children_method_name = :fields
 
         # this is so that `children_method_name` of `InputValueDefinition` works properly
         # with `#replace_child`
@@ -605,9 +635,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::FieldDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class ObjectTypeExtension < AbstractNode
@@ -616,9 +644,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::FieldDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class InterfaceTypeDefinition < AbstractNode
@@ -626,23 +652,21 @@ module GraphQL
         attr_reader :description
         scalar_methods :name
         children_methods({
+          interfaces: GraphQL::Language::Nodes::TypeName,
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::FieldDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class InterfaceTypeExtension < AbstractNode
         scalar_methods :name
         children_methods({
+          interfaces: GraphQL::Language::Nodes::TypeName,
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::FieldDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class UnionTypeDefinition < AbstractNode
@@ -652,9 +676,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class UnionTypeExtension < AbstractNode
@@ -663,9 +685,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class EnumValueDefinition < AbstractNode
@@ -675,9 +695,7 @@ module GraphQL
         children_methods({
           directives: GraphQL::Language::Nodes::Directive,
         })
-        def children_method_name
-          :values
-        end
+        self.children_method_name = :values
       end
 
       class EnumTypeDefinition < AbstractNode
@@ -688,9 +706,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           values: GraphQL::Language::Nodes::EnumValueDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class EnumTypeExtension < AbstractNode
@@ -699,9 +715,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           values: GraphQL::Language::Nodes::EnumValueDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class InputObjectTypeDefinition < AbstractNode
@@ -712,9 +726,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::InputValueDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
 
       class InputObjectTypeExtension < AbstractNode
@@ -723,9 +735,7 @@ module GraphQL
           directives: GraphQL::Language::Nodes::Directive,
           fields: GraphQL::Language::Nodes::InputValueDefinition,
         })
-        def children_method_name
-          :definitions
-        end
+        self.children_method_name = :definitions
       end
     end
   end