graphql 0.16.0 → 2.0.15

data/lib/graphql/language/block_string.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+module GraphQL
+  module Language
+    module BlockString
+      # Remove leading and trailing whitespace from a block string.
+      # See "Block Strings" in https://github.com/facebook/graphql/blob/master/spec/Section%202%20--%20Language.md
+      def self.trim_whitespace(str)
+        # Early return for the most common cases:
+        if str == ""
+          return "".dup
+        elsif !(has_newline = str.include?("\n")) && !(str.start_with?(" "))
+          return str
+        end
+
+        lines = has_newline ? str.split("\n") : [str]
+        common_indent = nil
+
+        # find the common whitespace
+        lines.each_with_index do |line, idx|
+          if idx == 0
+            next
+          end
+          line_length = line.size
+          line_indent = if line.match?(/\A  [^ ]/)
+            2
+          elsif line.match?(/\A    [^ ]/)
+            4
+          elsif line.match?(/\A[^ ]/)
+            0
+          else
+            line[/\A */].size
+          end
+          if line_indent < line_length && (common_indent.nil? || line_indent < common_indent)
+            common_indent = line_indent
+          end
+        end
+
+        # Remove the common whitespace
+        if common_indent && common_indent > 0
+          lines.each_with_index do |line, idx|
+            if idx == 0
+              next
+            else
+              line.slice!(0, common_indent)
+            end
+          end
+        end
+
+        # Remove leading & trailing blank lines
+        while lines.size > 0 && lines[0].empty?
+          lines.shift
+        end
+        while lines.size > 0 && lines[-1].empty?
+          lines.pop
+        end
+
+        # Rebuild the string
+        lines.size > 1 ? lines.join("\n") : (lines.first || "".dup)
+      end
+
+      def self.print(str, indent: '')
+        lines = str.split("\n")
+
+        block_str = "#{indent}\"\"\"\n".dup
+
+        lines.each do |line|
+          if line == ''
+            block_str << "\n"
+          else
+            sublines = break_line(line, 120 - indent.length)
+            sublines.each do |subline|
+              block_str << "#{indent}#{subline}\n"
+            end
+          end
+        end
+
+        block_str << "#{indent}\"\"\"\n".dup
+      end
+
+      private
+
+      def self.break_line(line, length)
+        return [line] if line.length < length + 5
+
+        parts = line.split(Regexp.new("((?: |^).{15,#{length - 40}}(?= |$))"))
+        return [line] if parts.length < 4
+
+        sublines = [parts.slice!(0, 3).join]
+
+        parts.each_with_index do |part, i|
+          next if i % 2 == 1
+          sublines << "#{part[1..-1]}#{parts[i + 1]}"
+        end
+
+        sublines
+      end
+    end
+  end
+end

data/lib/graphql/language/cache.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'graphql/version'
+require 'digest/sha2'
+
+module GraphQL
+  module Language
+    class Cache
+      def initialize(path)
+        @path = path
+      end
+
+      DIGEST = Digest::SHA256.new << GraphQL::VERSION
+      def fetch(filename)
+        hash = DIGEST.dup << filename
+        begin
+          hash << File.mtime(filename).to_i.to_s
+        rescue SystemCallError
+          return yield
+        end
+        cache_path = @path.join(hash.to_s)
+
+        if cache_path.exist?
+          Marshal.load(cache_path.read)
+        else
+          payload = yield
+          tmp_path = "#{cache_path}.#{rand}"
+
+          @path.mkpath
+          File.binwrite(tmp_path, Marshal.dump(payload))
+          File.rename(tmp_path, cache_path.to_s)
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/graphql/language/definition_slice.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module GraphQL
+  module Language
+    module DefinitionSlice
+      extend self
+
+      def slice(document, name)
+        definitions = {}
+        document.definitions.each { |d| definitions[d.name] = d }
+        names = Set.new
+        DependencyVisitor.find_definition_dependencies(definitions, name, names)
+        definitions = document.definitions.select { |d| names.include?(d.name) }
+        Nodes::Document.new(definitions: definitions)
+      end
+
+      private
+
+      class DependencyVisitor < GraphQL::Language::Visitor
+        def initialize(doc, definitions, names)
+          @names = names
+          @definitions = definitions
+          super(doc)
+        end
+
+        def on_fragment_spread(node, parent)
+          if fragment = @definitions[node.name]
+            self.class.find_definition_dependencies(@definitions, fragment.name, @names)
+          end
+          super
+        end
+
+        def self.find_definition_dependencies(definitions, name, names)
+          names.add(name)
+          visitor = self.new(definitions[name], definitions, names)
+          visitor.visit
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/graphql/language/document_from_schema_definition.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+module GraphQL
+  module Language
+    # @api private
+    #
+    # {GraphQL::Language::DocumentFromSchemaDefinition} is used to convert a {GraphQL::Schema} object
+    # To a {GraphQL::Language::Document} AST node.
+    #
+    # @param context [Hash]
+    # @param only [<#call(member, ctx)>]
+    # @param except [<#call(member, ctx)>]
+    # @param include_introspection_types [Boolean] Whether or not to include introspection types in the AST
+    # @param include_built_in_scalars [Boolean] Whether or not to include built in scalars in the AST
+    # @param include_built_in_directives [Boolean] Whether or not to include built in directives in the AST
+    class DocumentFromSchemaDefinition
+      def initialize(
+        schema, context: nil, only: nil, except: nil, include_introspection_types: false,
+        include_built_in_directives: false, include_built_in_scalars: false, always_include_schema: false
+      )
+        @schema = schema
+        @always_include_schema = always_include_schema
+        @include_introspection_types = include_introspection_types
+        @include_built_in_scalars = include_built_in_scalars
+        @include_built_in_directives = include_built_in_directives
+
+        filter = GraphQL::Filter.new(only: only, except: except)
+        if @schema.respond_to?(:visible?)
+          filter = filter.merge(only: @schema.method(:visible?))
+        end
+
+        schema_context = schema.context_class.new(query: nil, object: nil, schema: schema, values: context)
+        @warden = GraphQL::Schema::Warden.new(
+          filter,
+          schema: @schema,
+          context: schema_context,
+        )
+        schema_context.warden = @warden
+      end
+
+      def document
+        GraphQL::Language::Nodes::Document.new(
+          definitions: build_definition_nodes
+        )
+      end
+
+      def build_schema_node
+        schema_options = {
+          # `@schema.directives` is covered by `build_definition_nodes`
+          directives: definition_directives(@schema, :schema_directives),
+        }
+        if !schema_respects_root_name_conventions?(@schema)
+          schema_options.merge!({
+            query: (q = warden.root_type_for_operation("query")) && q.graphql_name,
+            mutation: (m = warden.root_type_for_operation("mutation")) && m.graphql_name,
+            subscription: (s = warden.root_type_for_operation("subscription")) && s.graphql_name,
+          })
+        end
+        GraphQL::Language::Nodes::SchemaDefinition.new(schema_options)
+      end
+
+      def build_object_type_node(object_type)
+        GraphQL::Language::Nodes::ObjectTypeDefinition.new(
+          name: object_type.graphql_name,
+          interfaces: warden.interfaces(object_type).sort_by(&:graphql_name).map { |iface| build_type_name_node(iface) },
+          fields: build_field_nodes(warden.fields(object_type)),
+          description: object_type.description,
+          directives: directives(object_type),
+        )
+      end
+
+      def build_field_node(field)
+        GraphQL::Language::Nodes::FieldDefinition.new(
+          name: field.graphql_name,
+          arguments: build_argument_nodes(warden.arguments(field)),
+          type: build_type_name_node(field.type),
+          description: field.description,
+          directives: directives(field),
+        )
+      end
+
+      def build_union_type_node(union_type)
+        GraphQL::Language::Nodes::UnionTypeDefinition.new(
+          name: union_type.graphql_name,
+          description: union_type.description,
+          types: warden.possible_types(union_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
+          directives: directives(union_type),
+        )
+      end
+
+      def build_interface_type_node(interface_type)
+        GraphQL::Language::Nodes::InterfaceTypeDefinition.new(
+          name: interface_type.graphql_name,
+          interfaces: warden.interfaces(interface_type).sort_by(&:graphql_name).map { |type| build_type_name_node(type) },
+          description: interface_type.description,
+          fields: build_field_nodes(warden.fields(interface_type)),
+          directives: directives(interface_type),
+        )
+      end
+
+      def build_enum_type_node(enum_type)
+        GraphQL::Language::Nodes::EnumTypeDefinition.new(
+          name: enum_type.graphql_name,
+          values: warden.enum_values(enum_type).sort_by(&:graphql_name).map do |enum_value|
+            build_enum_value_node(enum_value)
+          end,
+          description: enum_type.description,
+          directives: directives(enum_type),
+        )
+      end
+
+      def build_enum_value_node(enum_value)
+        GraphQL::Language::Nodes::EnumValueDefinition.new(
+          name: enum_value.graphql_name,
+          description: enum_value.description,
+          directives: directives(enum_value),
+        )
+      end
+
+      def build_scalar_type_node(scalar_type)
+        GraphQL::Language::Nodes::ScalarTypeDefinition.new(
+          name: scalar_type.graphql_name,
+          description: scalar_type.description,
+          directives: directives(scalar_type),
+        )
+      end
+
+      def build_argument_node(argument)
+        if argument.default_value?
+          default_value = build_default_value(argument.default_value, argument.type)
+        else
+          default_value = nil
+        end
+
+        argument_node = GraphQL::Language::Nodes::InputValueDefinition.new(
+          name: argument.graphql_name,
+          description: argument.description,
+          type: build_type_name_node(argument.type),
+          default_value: default_value,
+          directives: directives(argument),
+        )
+
+        argument_node
+      end
+
+      def build_input_object_node(input_object)
+        GraphQL::Language::Nodes::InputObjectTypeDefinition.new(
+          name: input_object.graphql_name,
+          fields: build_argument_nodes(warden.arguments(input_object)),
+          description: input_object.description,
+          directives: directives(input_object),
+        )
+      end
+
+      def build_directive_node(directive)
+        GraphQL::Language::Nodes::DirectiveDefinition.new(
+          name: directive.graphql_name,
+          repeatable: directive.repeatable?,
+          arguments: build_argument_nodes(warden.arguments(directive)),
+          locations: build_directive_location_nodes(directive.locations),
+          description: directive.description,
+        )
+      end
+
+      def build_directive_location_nodes(locations)
+        locations.sort.map { |location| build_directive_location_node(location) }
+      end
+
+      def build_directive_location_node(location)
+        GraphQL::Language::Nodes::DirectiveLocation.new(
+          name: location.to_s
+        )
+      end
+
+      def build_type_name_node(type)
+        case type.kind.name
+        when "LIST"
+          GraphQL::Language::Nodes::ListType.new(
+            of_type: build_type_name_node(type.of_type)
+          )
+        when "NON_NULL"
+          GraphQL::Language::Nodes::NonNullType.new(
+            of_type: build_type_name_node(type.of_type)
+          )
+        else
+          GraphQL::Language::Nodes::TypeName.new(name: type.graphql_name)
+        end
+      end
+
+      def build_default_value(default_value, type)
+        if default_value.nil?
+          return GraphQL::Language::Nodes::NullValue.new(name: "null")
+        end
+
+        case type.kind.name
+        when "SCALAR"
+          type.coerce_isolated_result(default_value)
+        when "ENUM"
+          GraphQL::Language::Nodes::Enum.new(name: type.coerce_isolated_result(default_value))
+        when "INPUT_OBJECT"
+          GraphQL::Language::Nodes::InputObject.new(
+            arguments: default_value.to_h.map do |arg_name, arg_value|
+              args = @warden.arguments(type)
+              arg = args.find { |a| a.keyword.to_s == arg_name.to_s }
+              if arg.nil?
+                raise ArgumentError, "No argument definition on #{type.graphql_name} for argument: #{arg_name.inspect} (expected one of: #{args.map(&:keyword)})"
+              end
+              GraphQL::Language::Nodes::Argument.new(
+                name: arg.graphql_name.to_s,
+                value: build_default_value(arg_value, arg.type)
+              )
+            end
+          )
+        when "NON_NULL"
+          build_default_value(default_value, type.of_type)
+        when "LIST"
+          default_value.to_a.map { |v| build_default_value(v, type.of_type) }
+        else
+          raise GraphQL::RequiredImplementationMissingError, "Unexpected default value type #{type.inspect}"
+        end
+      end
+
+      def build_type_definition_node(type)
+        case type.kind.name
+        when "OBJECT"
+          build_object_type_node(type)
+        when "UNION"
+          build_union_type_node(type)
+        when "INTERFACE"
+          build_interface_type_node(type)
+        when "SCALAR"
+          build_scalar_type_node(type)
+        when "ENUM"
+          build_enum_type_node(type)
+        when "INPUT_OBJECT"
+          build_input_object_node(type)
+        else
+          raise TypeError
+        end
+      end
+
+      def build_argument_nodes(arguments)
+        arguments
+          .map { |arg| build_argument_node(arg) }
+          .sort_by(&:name)
+      end
+
+      def build_directive_nodes(directives)
+        if !include_built_in_directives
+          directives = directives.reject { |directive| directive.default_directive? }
+        end
+
+        directives
+          .map { |directive| build_directive_node(directive) }
+          .sort_by(&:name)
+      end
+
+      def build_definition_nodes
+        definitions = []
+        definitions << build_schema_node if include_schema_node?
+        definitions += build_directive_nodes(warden.directives)
+        definitions += build_type_definition_nodes(warden.reachable_types)
+        definitions
+      end
+
+      def build_type_definition_nodes(types)
+        if !include_introspection_types
+          types = types.reject { |type| type.introspection? }
+        end
+
+        if !include_built_in_scalars
+          types = types.reject { |type| type.kind.scalar? && type.default_scalar? }
+        end
+
+        types
+          .map { |type| build_type_definition_node(type) }
+          .sort_by(&:name)
+      end
+
+      def build_field_nodes(fields)
+        fields
+          .map { |field| build_field_node(field) }
+          .sort_by(&:name)
+      end
+
+      private
+
+      def include_schema_node?
+        always_include_schema ||
+          !schema_respects_root_name_conventions?(schema) ||
+          !schema.schema_directives.empty?
+      end
+
+      def schema_respects_root_name_conventions?(schema)
+        (schema.query.nil? || schema.query.graphql_name == 'Query') &&
+        (schema.mutation.nil? || schema.mutation.graphql_name == 'Mutation') &&
+        (schema.subscription.nil? || schema.subscription.graphql_name == 'Subscription')
+      end
+
+      def directives(member)
+        definition_directives(member, :directives)
+      end
+
+      def definition_directives(member, directives_method)
+        dirs = if !member.respond_to?(directives_method) || member.directives.empty?
+          []
+        else
+          member.public_send(directives_method).map do |dir|
+            args = []
+            dir.arguments.argument_values.each_value do |arg_value| # rubocop:disable Development/ContextIsPassedCop -- directive instance method
+              arg_defn = arg_value.definition
+              if arg_defn.default_value? && arg_value.value == arg_defn.default_value
+                next
+              else
+                value_node = build_default_value(arg_value.value, arg_value.definition.type)
+                args << GraphQL::Language::Nodes::Argument.new(
+                  name: arg_value.definition.name,
+                  value: value_node,
+                )
+              end
+            end
+            GraphQL::Language::Nodes::Directive.new(
+              name: dir.class.graphql_name,
+              arguments: args
+            )
+          end
+        end
+
+        dirs
+      end
+
+      attr_reader :schema, :warden, :always_include_schema,
+        :include_introspection_types, :include_built_in_directives, :include_built_in_scalars
+    end
+  end
+end

data/lib/graphql/language/generation.rb

@@ -1,93 +1,23 @@
+# frozen_string_literal: true
 module GraphQL
   module Language
+    # Exposes {.generate}, which turns AST nodes back into query strings.
     module Generation
-      def self.generate(node, indent: "")
-        case node
-        when Nodes::Document
-          node.definitions.map { |d| generate(d) }.join("\n")
-        when Nodes::Argument
-          "#{node.name}: #{generate(node.value)}"
-        when Nodes::Directive
-          "@#{node.name}(#{node.arguments.map { |a| generate(a) }.join(", ")})"
-        when Nodes::Enum
-          "#{node.name}"
-        when Nodes::Field
-          out = "#{indent}"
-          out << "#{node.alias}: " if node.alias
-          out << "#{node.name}"
-          out << "(#{node.arguments.map { |a| generate(a) }.join(", ")})" if node.arguments.any?
-          out << generate_directives(node.directives)
-          out << generate_selections(node.selections, indent: indent)
-          out
-        when Nodes::FragmentDefinition
-          out = "#{indent}fragment #{node.name}"
-          out << " on #{node.type}" if node.type
-          out << generate_directives(node.directives)
-          out << generate_selections(node.selections, indent: indent)
-          out
+      extend self
 
-        when Nodes::FragmentSpread
-          out = "#{indent}... #{node.name}"
-          out << generate_directives(node.directives)
-          out
-        when Nodes::InlineFragment
-          out = "#{indent}..."
-          out << " on #{node.type}" if node.type
-          out << generate_directives(node.directives)
-          out << generate_selections(node.selections, indent: indent)
-          out
-        when Nodes::InputObject
-          generate(node.to_h)
-        when Nodes::ListType
-          "[#{generate(node.of_type)}]"
-        when Nodes::NonNullType
-          "#{generate(node.of_type)}!"
-        when Nodes::OperationDefinition
-          out = "#{indent}#{node.operation_type}"
-          out << " #{node.name}" if node.name
-          out << "(#{node.variables.map { |v| generate(v) }.join(", ")})" if node.variables.any?
-          out << generate_directives(node.directives)
-          out << generate_selections(node.selections, indent: indent)
-          out
-        when Nodes::TypeName
-          "#{node.name}"
-        when Nodes::VariableDefinition
-          out = "$#{node.name}: #{generate(node.type)}"
-          out << " = #{generate(node.default_value)}" if node.default_value
-          out
-        when Nodes::VariableIdentifier
-          "$#{node.name}"
-        when Nodes::AbstractNode
-          node.to_query_string(indent: indent)
-        when FalseClass, Float, Integer, NilClass, String, TrueClass
-          JSON.generate(node, quirks_mode: true)
-        when Array
-          "[#{node.map { |v| generate(v) }.join(", ")}]"
-        when Hash
-          "{#{node.map { |k, v| "#{k}: #{generate(v)}" }.join(", ")}}"
-        else
-          raise TypeError
-        end
-      end
-
-      def self.generate_directives(directives)
-        if directives.any?
-          directives.map { |d| " #{generate(d)}" }.join
-        else
-          ""
-        end
-      end
-
-      def self.generate_selections(selections, indent: "")
-        if selections.any?
-          out = " {\n"
-          selections.each do |selection|
-            out << generate(selection, indent: indent + "  ") << "\n"
-          end
-          out << "#{indent}}"
-        else
-          ""
-        end
+      # Turn an AST node back into a string.
+      #
+      # @example Turning a document into a query
+      #    document = GraphQL.parse(query_string)
+      #    GraphQL::Language::Generation.generate(document)
+      #    # => "{ ... }"
+      #
+      # @param node [GraphQL::Language::Nodes::AbstractNode] an AST node to recursively stringify
+      # @param indent [String] Whitespace to add to each printed node
+      # @param printer [GraphQL::Language::Printer] An optional custom printer for printing AST nodes. Defaults to GraphQL::Language::Printer
+      # @return [String] Valid GraphQL for `node`
+      def generate(node, indent: "", printer: GraphQL::Language::Printer.new)
+        printer.print(node, indent: indent)
       end
     end
   end