graphql 1.8.0 → 1.12.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5283bf51e22ac60f8d9368d9cc19b8c6d038d8b
-  data.tar.gz: 147ec429661a6fbc1aaef685ba94c8a81d87910e
+SHA256:
+  metadata.gz: 296954a3b03f2fd5dae9fae56eaa08ea04b3dfb8f25923201ea27c67147c71fa
+  data.tar.gz: 4de323637c29b729a3eb3f07b620e2014515b37235c485002d016ead490d86e7
 SHA512:
-  metadata.gz: 06a2a8730fc1c13dc0a0d76a35b19e89dd40ad842e41618abb1b05a7f75b667eede56c106728e3e68bd531e36e29b28050b991319599b7952ac3285fb3f9be3c
-  data.tar.gz: 8231c7696681477decf92b0665f3e4249b308153338c8d7cf5102b7e95133b9ac7aa6156f3dddc026c4178ea9fcb25d7f181f752298d5cf38185141af653a471
+  metadata.gz: fdf50f6c6f170aa4c50d46356e4089c40a939bf3d0dfd4ab7bdb667d169f01a38320c971cdec1dde32353a20823c1756196312df5e425af41a157caa1179e845
+  data.tar.gz: 4202ca4741998ee1f5535eea14ff93c1a8529ff5085625d67171e75736f65f55d0433b93512c272e16f4f9a48dd630eba49cf37a54e49b0e9e3dad5f0496930c

data/lib/generators/graphql/core.rb

@@ -16,7 +16,7 @@ module Graphql
 
       def insert_root_type(type, name)
         log :add_root_type, type
-        sentinel = /GraphQL\:\:Schema\.define do\s*\n/m
+        sentinel = /< GraphQL::Schema\s*\n/m
 
         in_root do
           inject_into_file schema_file_path, "  #{type}(Types::#{name})\n", after: sentinel, verbose: false, force: false
@@ -25,6 +25,7 @@ module Graphql
 
       def create_mutation_root_type
         create_dir("#{options[:directory]}/mutations")
+        template("base_mutation.erb", "#{options[:directory]}/mutations/base_mutation.rb", { skip: true })
         template("mutation_type.erb", "#{options[:directory]}/types/mutation_type.rb", { skip: true })
         insert_root_type('mutation', 'MutationType')
       end
@@ -40,6 +41,14 @@ module Graphql
         end
       end
 
+      def module_namespacing_when_supported
+        if defined?(module_namespacing)
+          module_namespacing { yield }
+        else
+          yield
+        end
+      end
+
       private
 
       def schema_name
@@ -47,11 +56,19 @@ module Graphql
           if options[:schema]
             options[:schema]
           else
-            require File.expand_path("config/application", destination_root)
-            "#{Rails.application.class.parent_name}Schema"
+            "#{parent_name}Schema"
           end
         end
       end
+
+      def parent_name
+        require File.expand_path("config/application", destination_root)
+        if Rails.application.class.respond_to?(:module_parent_name)
+          Rails.application.class.module_parent_name
+        else
+          Rails.application.class.parent_name
+        end
+      end
     end
   end
 end

data/lib/generators/graphql/enum_generator.rb

@@ -3,11 +3,11 @@ require 'generators/graphql/type_generator'
 
 module Graphql
   module Generators
-    # Generate an interface type by name,
-    # with the specified fields.
+    # Generate an enum type by name, with the given values.
+    # To add a `value:` option, add another value after a `:`.
     #
     # ```
-    # rails g graphql:interface NamedEntityType name:String!
+    # rails g graphql:enum ProgrammingLanguage RUBY PYTHON PERL PERL6:"PERL"
     # ```
     class EnumGenerator < TypeGeneratorBase
       desc "Create a GraphQL::EnumType with the given name and values"

data/lib/generators/graphql/install_generator.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+require 'rails/generators'
 require 'rails/generators/base'
 require_relative 'core'
+require_relative 'relay'
 
 module Graphql
   module Generators
@@ -13,9 +15,18 @@ module Graphql
     #   - graphql/
     #     - resolvers/
     #     - types/
+    #       - base_argument.rb
+    #       - base_field.rb
+    #       - base_enum.rb
+    #       - base_input_object.rb
+    #       - base_interface.rb
+    #       - base_object.rb
+    #       - base_scalar.rb
+    #       - base_union.rb
     #       - query_type.rb
     #     - loaders/
     #     - mutations/
+    #       - base_mutation.rb
     #     - {app_name}_schema.rb
     # ```
     #
@@ -34,14 +45,14 @@ module Graphql
     # post "/graphql", to: "graphql#execute"
     # ```
     #
-    # Accept a `--relay` option which adds
-    # The root `node(id: ID!)` field.
-    #
     # Accept a `--batch` option which adds `GraphQL::Batch` setup.
     #
     # Use `--no-graphiql` to skip `graphiql-rails` installation.
+    #
+    # TODO: also add base classes
     class InstallGenerator < Rails::Generators::Base
       include Core
+      include Relay
 
       desc "Install GraphQL folder structure and boilerplate code"
       source_root File.expand_path('../templates', __FILE__)
@@ -68,14 +79,19 @@ module Graphql
 
       class_option :relay,
         type: :boolean,
-        default: false,
-        desc: "Include GraphQL::Relay installation"
+        default: true,
+        desc: "Include installation of Relay conventions (nodes, connections, edges)"
 
       class_option :batch,
         type: :boolean,
         default: false,
         desc: "Include GraphQL::Batch installation"
 
+      class_option :playground,
+        type: :boolean,
+        default: false,
+        desc: "Use GraphQL Playground over Graphiql as IDE"
+
       # These two options are taken from Rails' own generators'
       class_option :api,
         type: :boolean,
@@ -85,7 +101,11 @@ module Graphql
         create_dir("#{options[:directory]}/types")
         template("schema.erb", schema_file_path)
 
-        # Note: Yuo can't have a schema without the query type, otherwise introspection breaks
+        ["base_object", "base_argument", "base_field", "base_enum", "base_input_object", "base_interface", "base_scalar", "base_union"].each do |base_type|
+          template("#{base_type}.erb", "#{options[:directory]}/types/#{base_type}.rb")
+        end
+
+        # Note: You can't have a schema without the query type, otherwise introspection breaks
         template("query_type.erb", "#{options[:directory]}/types/query_type.rb")
         insert_root_type('query', 'QueryType')
 
@@ -102,7 +122,7 @@ module Graphql
         if options.api?
           say("Skipped graphiql, as this rails project is API only")
           say("  You may wish to use GraphiQL.app for development: https://github.com/skevy/graphiql-app")
-        elsif !options[:skip_graphiql]
+        elsif !options[:skip_graphiql] && !File.read(Rails.root.join("Gemfile")).include?("graphiql-rails")
           gem("graphiql-rails", group: :development)
 
           # This is a little cheat just to get cleaner shell output:
@@ -125,6 +145,31 @@ RUBY
           end
         end
 
+        if options[:playground]
+          gem("graphql_playground-rails", group: :development)
+
+          log :route, 'graphql_playground-rails'
+          shell.mute do
+            if Rails::VERSION::STRING > "5.2"
+              route <<-RUBY
+if Rails.env.development?
+  mount GraphqlPlayground::Rails::Engine, at: "/playground", graphql_path: "/graphql"
+end
+RUBY
+            else
+              route <<-RUBY
+if Rails.env.development?
+    mount GraphqlPlayground::Rails::Engine, at: "/playground", graphql_path: "/graphql"
+  end
+RUBY
+            end
+          end
+        end
+
+        if options[:relay]
+          install_relay
+        end
+
         if gemfile_modified?
           say "Gemfile has been modified, make sure you `bundle install`"
         end

data/lib/generators/graphql/loader_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'rails/generators'
 require "rails/generators/named_base"
 require_relative "core"
 

data/lib/generators/graphql/mutation_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'rails/generators'
 require 'rails/generators/named_base'
 require_relative 'core'
 
@@ -6,12 +7,12 @@ module Graphql
   module Generators
     # TODO: What other options should be supported?
     #
-    # @example Generate a `Relay::Mutation` by name
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
     #     rails g graphql:mutation CreatePostMutation
     class MutationGenerator < Rails::Generators::Base
       include Core
 
-      desc "Create a Relay mutation by name"
+      desc "Create a Relay Classic mutation by name"
       source_root File.expand_path('../templates', __FILE__)
 
       argument :name, type: :string
@@ -32,20 +33,20 @@ module Graphql
         else
           log :gsub, "#{options[:directory]}/types/mutation_type.rb"
         end
-        
+
         template "mutation.erb", "#{options[:directory]}/mutations/#{file_name}.rb"
 
-        sentinel = /name "Mutation"\s*\n/m
+        sentinel = /class .*MutationType\s*<\s*[^\s]+?\n/m
         in_root do
           gsub_file "#{options[:directory]}/types/mutation_type.rb", /  \# TODO\: Add Mutations as fields\s*\n/m, ""
-          inject_into_file "#{options[:directory]}/types/mutation_type.rb", "  field :#{field_name}, Mutations::#{mutation_name}.field\n", after: sentinel, verbose: false, force: false
+          inject_into_file "#{options[:directory]}/types/mutation_type.rb", "    field :#{field_name}, mutation: Mutations::#{mutation_name}\n", after: sentinel, verbose: false, force: false
         end
       end
 
       private
 
       def assign_names!(name)
-        @field_name = name.camelize(:lower)
+        @field_name = name.camelize.underscore
         @mutation_name = name.camelize(:upper)
         @file_name = name.camelize.underscore
       end

data/lib/generators/graphql/object_generator.rb

@@ -15,20 +15,64 @@ module Graphql
       desc "Create a GraphQL::ObjectType with the given name and fields"
       source_root File.expand_path('../templates', __FILE__)
 
-      argument :fields,
-        type: :array,
-        default: [],
-        banner: "name:type name:type ...",
-        desc: "Fields for this object (type may be expressed as Ruby or GraphQL)"
+      argument :custom_fields,
+               type: :array,
+               default: [],
+               banner: "name:type name:type ...",
+               desc: "Fields for this object (type may be expressed as Ruby or GraphQL)"
 
       class_option :node,
-        type: :boolean,
-        default: false,
-        desc: "Include the Relay Node interface"
+                   type: :boolean,
+                   default: false,
+                   desc: "Include the Relay Node interface"
 
       def create_type_file
         template "object.erb", "#{options[:directory]}/types/#{type_file_name}.rb"
       end
+
+      def fields
+        columns = []
+        columns += klass.columns.map { |c| generate_column_string(c) } if class_exists?
+        columns + custom_fields
+      end
+
+      def self.normalize_type_expression(type_expression, mode:, null: true)
+        case type_expression
+        when "Text"
+          ["String", null]
+        when "Decimal"
+          ["Float", null]
+        when "DateTime", "Datetime"
+          ["GraphQL::Types::ISO8601DateTime", null]
+        when "Date"
+          ["GraphQL::Types::ISO8601Date", null]
+        else
+          super
+        end
+      end
+
+      private
+
+      def generate_column_string(column)
+        name = column.name
+        required = column.null ? "" : "!"
+        type = column_type_string(column)
+        "#{name}:#{required}#{type}"
+      end
+
+      def column_type_string(column)
+        column.name == "id" ? "ID" : column.type.to_s.camelize
+      end
+
+      def class_exists?
+        klass.is_a?(Class) && klass.ancestors.include?(ActiveRecord::Base)
+      rescue NameError
+        return false
+      end
+
+      def klass
+        @klass ||= Module.const_get(type_name.camelize)
+      end
     end
   end
 end

data/lib/generators/graphql/relay.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module Graphql
+  module Generators
+    module Relay
+      def install_relay
+        # Add Node, `node(id:)`, and `nodes(ids:)`
+        template("node_type.erb", "#{options[:directory]}/types/node_type.rb")
+        in_root do
+          fields = "    # Add `node(id: ID!) and `nodes(ids: [ID!]!)`\n    include GraphQL::Types::Relay::HasNodeField\n    include GraphQL::Types::Relay::HasNodesField\n\n"
+          inject_into_file "#{options[:directory]}/types/query_type.rb", fields, after: /class .*QueryType\s*<\s*[^\s]+?\n/m, force: false
+        end
+
+        # Add connections and edges
+        template("base_connection.erb", "#{options[:directory]}/types/base_connection.rb")
+        template("base_edge.erb", "#{options[:directory]}/types/base_edge.rb")
+        connectionable_type_files = {
+          "#{options[:directory]}/types/base_object.rb" => /class .*BaseObject\s*<\s*[^\s]+?\n/m,
+          "#{options[:directory]}/types/base_union.rb" =>  /class .*BaseUnion\s*<\s*[^\s]+?\n/m,
+          "#{options[:directory]}/types/base_interface.rb" => /include GraphQL::Schema::Interface\n/m,
+        }
+        in_root do
+          connectionable_type_files.each do |type_class_file, sentinel|
+            inject_into_file type_class_file, "    connection_type_class(Types::BaseConnection)\n", after: sentinel, force: false
+            inject_into_file type_class_file, "    edge_type_class(Types::BaseEdge)\n", after: sentinel, force: false
+          end
+        end
+
+        # Add object ID hooks & connection plugin
+        schema_code = <<-RUBY
+
+  # Relay-style Object Identification:
+
+  # Return a string UUID for `object`
+  def self.id_from_object(object, type_definition, query_ctx)
+    # Here's a simple implementation which:
+    # - joins the type name & object.id
+    # - encodes it with base64:
+    # GraphQL::Schema::UniqueWithinType.encode(type_definition.name, object.id)
+  end
+
+  # Given a string UUID, find the object
+  def self.object_from_id(id, query_ctx)
+    # For example, to decode the UUIDs generated above:
+    # type_name, item_id = GraphQL::Schema::UniqueWithinType.decode(id)
+    #
+    # Then, based on `type_name` and `id`
+    # find an object in your application
+    # ...
+  end
+RUBY
+        inject_into_file schema_file_path, schema_code, before: /^end\n/m, force: false
+      end
+    end
+  end
+end

data/lib/generators/graphql/relay_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/base'
+require_relative 'core'
+require_relative 'relay'
+
+module Graphql
+  module Generators
+    class RelayGenerator < Rails::Generators::Base
+      include Core
+      include Relay
+
+      desc "Add base types and fields for Relay-style nodes and connections"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def install_relay
+        super
+      end
+    end
+  end
+end

data/lib/generators/graphql/scalar_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'generators/graphql/type_generator'
+
+module Graphql
+  module Generators
+    # Generate a scalar type by given name.
+    #
+    # ```
+    # rails g graphql:scalar Date
+    # ```
+    class ScalarGenerator < TypeGeneratorBase
+      desc "Create a GraphQL::ScalarType with the given name"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_type_file
+        template "scalar.erb", "#{options[:directory]}/types/#{type_file_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/graphql/templates/base_argument.erb

@@ -0,0 +1,6 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseArgument < GraphQL::Schema::Argument
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_connection.erb

@@ -0,0 +1,8 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseConnection < Types::BaseObject
+    # add `nodes` and `pageInfo` fields, as well as `edge_type(...)` and `node_nullable(...)` overrides
+    include GraphQL::Types::Relay::ConnectionBehaviors
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_edge.erb

@@ -0,0 +1,8 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseEdge < Types::BaseObject
+    # add `node` and `cursor` fields, as well as `node_type(...)` override
+    include GraphQL::Types::Relay::EdgeBehaviors
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_enum.erb

@@ -0,0 +1,6 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseEnum < GraphQL::Schema::Enum
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_field.erb

@@ -0,0 +1,7 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseField < GraphQL::Schema::Field
+    argument_class Types::BaseArgument
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_input_object.erb

@@ -0,0 +1,7 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseInputObject < GraphQL::Schema::InputObject
+    argument_class Types::BaseArgument
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_interface.erb

@@ -0,0 +1,9 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  module BaseInterface
+    include GraphQL::Schema::Interface
+
+    field_class Types::BaseField
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_mutation.erb

@@ -0,0 +1,10 @@
+<% module_namespacing_when_supported do -%>
+module Mutations
+  class BaseMutation < GraphQL::Schema::RelayClassicMutation
+    argument_class Types::BaseArgument
+    field_class Types::BaseField
+    input_object_class Types::BaseInputObject
+    object_class Types::BaseObject
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_object.erb

@@ -0,0 +1,7 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseObject < GraphQL::Schema::Object
+    field_class Types::BaseField
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_scalar.erb

@@ -0,0 +1,6 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseScalar < GraphQL::Schema::Scalar
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/base_union.erb

@@ -0,0 +1,6 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class BaseUnion < GraphQL::Schema::Union
+  end
+end
+<% end -%>

data/lib/generators/graphql/templates/enum.erb

@@ -1,4 +1,7 @@
-<%= type_ruby_name %> = GraphQL::EnumType.define do
-  name "<%= type_graphql_name %>"
-<% prepared_values.each do |v| %>  value "<%= v[0] %>"<%= v.length > 1 ? ", value: #{v[1]}" : "" %>
-<% end %>end
+<% module_namespacing_when_supported do -%>
+module Types
+  class <%= type_ruby_name.split('::')[-1] %> < Types::BaseEnum
+<% prepared_values.each do |v| %>    value "<%= v[0] %>"<%= v.length > 1 ? ", value: #{v[1]}" : "" %>
+<% end %>  end
+end
+<% end -%>

data/lib/generators/graphql/templates/graphql_controller.erb

@@ -1,6 +1,12 @@
+<% module_namespacing_when_supported do -%>
 class GraphqlController < ApplicationController
+  # If accessing from outside this domain, nullify the session
+  # This allows for outside API access while preventing CSRF attacks,
+  # but you'll have to authenticate your user separately
+  # protect_from_forgery with: :null_session
+
   def execute
-    variables = ensure_hash(params[:variables])
+    variables = prepare_variables(params[:variables])
     query = params[:query]
     operation_name = params[:operationName]
     context = {
@@ -9,25 +15,38 @@ class GraphqlController < ApplicationController
     }
     result = <%= schema_name %>.execute(query, variables: variables, context: context, operation_name: operation_name)
     render json: result
+  rescue StandardError => e
+    raise e unless Rails.env.development?
+    handle_error_in_development(e)
   end
 
   private
 
-  # Handle form data, JSON body, or a blank value
-  def ensure_hash(ambiguous_param)
-    case ambiguous_param
+  # Handle variables in form data, JSON body, or a blank value
+  def prepare_variables(variables_param)
+    case variables_param
     when String
-      if ambiguous_param.present?
-        ensure_hash(JSON.parse(ambiguous_param))
+      if variables_param.present?
+        JSON.parse(variables_param) || {}
       else
         {}
       end
-    when Hash, ActionController::Parameters
-      ambiguous_param
+    when Hash
+      variables_param
+    when ActionController::Parameters
+      variables_param.to_unsafe_hash # GraphQL-Ruby will validate name and type of incoming variables.
     when nil
       {}
     else
-      raise ArgumentError, "Unexpected parameter: #{ambiguous_param}"
+      raise ArgumentError, "Unexpected parameter: #{variables_param}"
     end
   end
+
+  def handle_error_in_development(e)
+    logger.error e.message
+    logger.error e.backtrace.join("\n")
+
+    render json: { errors: [{ message: e.message, backtrace: e.backtrace }], data: {} }, status: 500
+  end
 end
+<% end -%>

data/lib/generators/graphql/templates/interface.erb

@@ -1,4 +1,8 @@
-<%= type_ruby_name %> = GraphQL::InterfaceType.define do
-  name "<%= type_graphql_name %>"
-<% normalized_fields.each do |f| %>  field :<%= f[0] %>, <%= f[1] %>
-<% end %>end
+<% module_namespacing_when_supported do -%>
+module Types
+  module <%= type_ruby_name.split('::')[-1] %>
+    include Types::BaseInterface
+<% normalized_fields.each do |f| %>    <%= f.to_ruby %>
+<% end %>  end
+end
+<% end -%>

data/lib/generators/graphql/templates/loader.erb

@@ -1,15 +1,19 @@
-class Loaders::<%= class_name %> < GraphQL::Batch::Loader
-  # Define `initialize` to store grouping arguments, eg
-  #
-  #     Loaders::<%= class_name %>.for(group).load(value)
-  #
-  # def initialize()
-  # end
+<% module_namespacing_when_supported do -%>
+module Loaders
+  class <%= class_name %> < GraphQL::Batch::Loader
+    # Define `initialize` to store grouping arguments, eg
+    #
+    #     Loaders::<%= class_name %>.for(group).load(value)
+    #
+    # def initialize()
+    # end
 
-  # `keys` contains each key from `.load(key)`.
-  # Find the corresponding values, then
-  # call `fulfill(key, value)` or `fulfill(key, nil)`
-  # for each key.
-  def perform(keys)
+    # `keys` contains each key from `.load(key)`.
+    # Find the corresponding values, then
+    # call `fulfill(key, value)` or `fulfill(key, nil)`
+    # for each key.
+    def perform(keys)
+    end
   end
 end
+<% end -%>