graphql_backed 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 688cf9549fad3d7eeac442d87b9e24aa3602b8f88d788974f685941c7fc3853a
-  data.tar.gz: cc98e73c3013faa2ff629b94baddcc49f8e19b37cb180ec214d1a36dbfb1525a
+  metadata.gz: a21db7d71dddd530cc70c7bfb5150ccb37a53a46e2bab3b91c7c50f366dff30c
+  data.tar.gz: 53fa12435b06da5fc3f17409bc1f7980364df6dc739593557501dee033cde440
 SHA512:
-  metadata.gz: f0d328339fbd51167750b9cc3f8adc16323f51c3bfefa67efe9bfdd1d5238e60a2f29ed4227aab97b484fdd7fa618257a38a1f0651adf4e1f754bc8a521a3cd2
-  data.tar.gz: bb1d9bb8ea64d3bd90adf462ea42ea3b9fc3545bc322449df3077329b542f9918089f346a18175e66f8cec18381d257de30dcaa14d3b715c1dbbb5d5af575e17
+  metadata.gz: 35d313b0387dac02a4f50a857c79e8eb7a4d9605b62b5eadebeafc0d359eee7247ed07b836062aa0e302636a38f0bf8fae443289e42e514949d15bbe5383d6df
+  data.tar.gz: '091739d2f38b081802ea87b962f9e5798911c539fd65744fc07dc4e1ae925570468980801a8c4509ec7f0a1ac052c4ce2eebfe448eaaca2cd3dfe2c4ca5c04f8'

data/lib/graphql_backed/json_schema.rb

@@ -33,6 +33,10 @@ module GraphQLBacked
     #
     # Each variable is described by the first argument that it's passed to, if that argument has a description.
     #
+    # Default values are included as `"default"`: a variable's own default, or else the default of the argument
+    # that it's passed to (if it's passed to several, only when they all have the same default). Input objects' arguments
+    # have their defaults too. `null` defaults are left out.
+    #
     # `scalars` are schemas for custom scalars, by name. See Service.scalar_json_schema.
     #
     #: (singleton(GraphQL::Schema) schema, singleton(Operation) operation_class, ?scalars: Hash[String, Hash[String, untyped]]) -> Hash[String, untyped]
@@ -47,6 +51,7 @@ module GraphQLBacked
         @operation_class = operation_class
         @scalars = scalars
         @defs = {} #: Hash[String, untyped]
+        @variable_arguments = {} #: Hash[String, Array[untyped]]
       end
 
       #: -> Hash[String, untyped]
@@ -56,7 +61,8 @@ module GraphQLBacked
         required = [] #: Array[String]
         @operation_class.definition.variables.each do |variable|
           type = @schema.type_from_ast(variable.type)
-          properties[variable.name] = JSONSchema.with_description(type_schema(type), descriptions[variable.name])
+          default = variable.default_value.nil? ? argument_default(variable.name) : literal_value(variable.default_value)
+          properties[variable.name] = with_default(JSONSchema.with_description(type_schema(type), descriptions[variable.name]), default)
           required << variable.name if type.non_null? && variable.default_value.nil?
         end
         result = { "type" => "object", "properties" => properties } #: Hash[String, untyped]
@@ -82,7 +88,7 @@ module GraphQLBacked
             required = [] #: Array[String]
             input_object["properties"] = type.arguments.to_h do |name, argument|
               required << name if argument.type.non_null? && !argument.default_value?
-              [name, JSONSchema.with_description(type_schema(argument.type), argument.description)]
+              [name, with_default(JSONSchema.with_description(type_schema(argument.type), argument.description), default_value(argument))]
             end
             input_object["required"] = required if required.any?
             JSONSchema.with_description(input_object, type.description)
@@ -93,7 +99,49 @@ module GraphQLBacked
         end
       end
 
-      # The description of the first described argument that each variable is passed to, by variable name
+      #: (Hash[String, untyped] json_schema, untyped default) -> Hash[String, untyped]
+      def with_default(json_schema, default)
+        json_schema["default"] = default unless default.nil?
+        json_schema
+      end
+
+      # The default value of `argument` as it would be written in variables, if it has one
+      #
+      #: (untyped argument) -> untyped
+      def default_value(argument)
+        return nil if !argument.default_value?
+        value = argument.default_value
+        return nil if value.nil?
+        type = argument.type
+        # A single value is a valid default for a list
+        value = [value] if (type.non_null? ? type.of_type : type).list? && !value.respond_to?(:map)
+        type.coerce_isolated_result(value)
+      end
+
+      # The default that's used when the variable named `name` is omitted and has no default of its own:
+      # the one that's shared by every argument that it's passed to.
+      #
+      #: (String name) -> untyped
+      def argument_default(name)
+        defaults = @variable_arguments.fetch(name, []).map { |argument| default_value(argument) }.uniq #: Array[untyped]
+        defaults.size == 1 ? defaults.first : nil
+      end
+
+      # The JSON value of a default written in GraphQL
+      #
+      #: (untyped node) -> untyped
+      def literal_value(node)
+        case node
+        when GraphQL::Language::Nodes::NullValue then nil
+        when GraphQL::Language::Nodes::Enum then node.name
+        when GraphQL::Language::Nodes::InputObject then node.arguments.to_h { |argument| [argument.name, literal_value(argument.value)] }
+        when Array then node.map { |item| literal_value(item) }
+        else node
+        end
+      end
+
+      # The description of the first described argument that each variable is passed to, by variable name.
+      # This also gathers the arguments that each variable is passed to, for #argument_default.
       #
       #: -> Hash[String, String?]
       def variable_descriptions
@@ -146,6 +194,7 @@ module GraphQLBacked
         case value
         when GraphQL::Language::Nodes::VariableIdentifier
           descriptions[value.name] ||= argument.description
+          (@variable_arguments[value.name] ||= []) << argument
         when GraphQL::Language::Nodes::InputObject
           describe_arguments(argument.type.unwrap, value.arguments, descriptions)
         when Array

data/lib/graphql_backed/mcp.rb

@@ -24,7 +24,7 @@ module GraphQLBacked
   # - its name is Operation.public_name
   # - its description is Operation.description, or else the description of its root field in the schema
   # - its hints come from Operation.query?, Operation.destructive?, Operation.idempotent? and Operation.open_world?
-  # - its input is the operation's variables, each described by the argument that it's passed to
+  # - its input is the operation's variables, each described by the argument that it's passed to, with its default value
   # - its output schema describes the `"data"` of the GraphQL response, based on the operation's selections,
   #   with the description of each field and each Resource as a reusable definition
   # - custom scalars are described by Service.scalar_json_schema

data/lib/graphql_backed/rest.rb

@@ -109,7 +109,7 @@ module GraphQLBacked
   # - variables in its path are `path` parameters
   # - its other variables are `query` parameters for `GET` and `DELETE` operations, or else properties of the JSON request body.
   #   List parameters are named with `[]` (`ids[]=1&ids[]=2`) and input objects use the `deepObject` style (`filter[role]=ADMIN`).
-  #   Each one is described by the argument that it's passed to.
+  #   Each one is described by the argument that it's passed to, with its default value.
   # - its `200` response is described by the selections of its root field, with the description of each field
   # - input objects and Resources are shared in `components.schemas`, named after the input type or Resource.fragment_name
   #   (eg `Resources__User`). If two operations define different fragments with the same name, the second

data/lib/graphql_backed/version.rb

@@ -3,5 +3,5 @@
 
 # :startdoc:
 module GraphQLBacked
-  VERSION = "0.1.0" #: String
+  VERSION = "0.1.1" #: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql_backed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Mosolgo