graphql 1.11.6 → 1.13.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6e1d6fb5063c843becb61784cb776964a380af5a2fc5a98054d2554ddf4caa
-  data.tar.gz: c41027cdf69f8c07bed157075c70e95936f3d26922f0b1d38f7759352a35ab43
+  metadata.gz: c21327429549138738debab2d522197133548eb4b275a5f67086154e08469149
+  data.tar.gz: ec61107f4f45aaf1de25c6674d7fcf3b8e19b1245fdbf2a1bd1b0f7f1dd9b0aa
 SHA512:
-  metadata.gz: 3dc4e13b30d51c32775785b9ed4a11940bc2cb541866877e6eef48bc621956700ddf057c597d2bc5a9fa09ca863e01ba84295e414e488e22ee03b94c28bc4003
-  data.tar.gz: 70f5ba8c04e13b83af431db1e8edea297a3c43acc6f6356668094349b577fe7de4e8cdb029aaf8ce70cc243664915ac7dac38612badd0acb720ce57464769cec
+  metadata.gz: 5b56c3aaa86b6d758b53d49a7906de483375c54f40db9126b96d791f41c7bba6407d9b59205a4d47215cef1391cd5ebbc03d5eb76825747cbfc1d0f6baf1f0ef
+  data.tar.gz: 7f7cb3b2e4fa8c26b355ea4adf01803ab32e2d97036475469071e2cf67d06431ab0486f0daf8ab28433deb95bb8642ea0a2b52739abe6d0ad06bb22b4fdcb2cc

data/lib/generators/graphql/core.rb

@@ -19,17 +19,12 @@ module Graphql
         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
+          if File.exist?(schema_file_path)
+            inject_into_file schema_file_path, "  #{type}(Types::#{name})\n", after: sentinel, verbose: false, force: false
+          end
         end
       end
 
-      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
-
       def schema_file_path
         "#{options[:directory]}/#{schema_name.underscore}.rb"
       end

data/lib/generators/graphql/enum_generator.rb

@@ -13,20 +13,14 @@ module Graphql
       desc "Create a GraphQL::EnumType with the given name and values"
       source_root File.expand_path('../templates', __FILE__)
 
-      argument :values,
-        type: :array,
-        default: [],
-        banner: "value{:ruby_value} value{:ruby_value} ...",
-        desc: "Values for this enum (if present, ruby_value will be inserted verbatim)"
+      private
 
-      def create_type_file
-        template "enum.erb", "#{options[:directory]}/types/#{type_file_name}.rb"
+      def graphql_type
+        "enum"
       end
 
-      private
-
       def prepared_values
-        values.map { |v| v.split(":", 2) }
+        custom_fields.map { |v| v.split(":", 2) }
       end
     end
   end

data/lib/generators/graphql/field_extractor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module Graphql
+  module Generators
+    module FieldExtractor
+      def fields
+        columns = []
+        columns += (klass&.columns&.map { |c| generate_column_string(c) }  || [])
+        columns + custom_fields
+      end
+
+      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 klass
+        @klass ||= Module.const_get(name.camelize)
+      rescue NameError
+        @klass = nil
+      end
+    end
+  end
+end

data/lib/generators/graphql/input_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'generators/graphql/type_generator'
+require 'generators/graphql/field_extractor'
+
+module Graphql
+  module Generators
+    # Generate an input type by name,
+    # with the specified fields.
+    #
+    # ```
+    # rails g graphql:object PostType name:string!
+    # ```
+    class InputGenerator < TypeGeneratorBase
+      desc "Create a GraphQL::InputObjectType with the given name and fields"
+      source_root File.expand_path('../templates', __FILE__)
+      include FieldExtractor
+
+      def self.normalize_type_expression(type_expression, mode:, null: true)
+        case type_expression.camelize
+        when "Text", "Citext"
+          ["String", null]
+        when "Decimal"
+          ["Float", null]
+        when "DateTime", "Datetime"
+          ["GraphQL::Types::ISO8601DateTime", null]
+        when "Date"
+          ["GraphQL::Types::ISO8601Date", null]
+        when "Json", "Jsonb", "Hstore"
+          ["GraphQL::Types::JSON", null]
+        else
+          super
+        end
+      end
+
+      private
+
+      def graphql_type
+        "input"
+      end
+
+      def type_ruby_name
+        super.gsub(/Type\z/, "InputType")
+      end
+
+      def type_file_name
+        super.gsub(/_type\z/, "_input_type")
+      end
+    end
+  end
+end

data/lib/generators/graphql/install/mutation_root_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require_relative "../core"
+
+module Graphql
+  module Generators
+    module Install
+      class MutationRootGenerator < Rails::Generators::Base
+        include Core
+
+        desc "Create mutation base type, mutation root tipe, and adds the latter to the schema"
+        source_root File.expand_path('../templates', __FILE__)
+
+        class_option :schema,
+          type: :string,
+          default: nil,
+          desc: "Name for the schema constant (default: {app_name}Schema)"
+
+        class_option :skip_keeps,
+          type: :boolean,
+          default: false,
+          desc: "Skip .keep files for source control"
+
+        def generate
+          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
+      end
+    end
+  end
+end 

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
@@ -43,9 +45,6 @@ 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.
@@ -53,6 +52,7 @@ module Graphql
     # 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__)
@@ -79,8 +79,8 @@ 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,
@@ -109,7 +109,7 @@ module Graphql
         template("query_type.erb", "#{options[:directory]}/types/query_type.rb")
         insert_root_type('query', 'QueryType')
 
-        create_mutation_root_type unless options.skip_mutation_root_type?
+        invoke "graphql:install:mutation_root" unless options.skip_mutation_root_type?
 
         template("graphql_controller.erb", "app/controllers/graphql_controller.rb")
         route('post "/graphql", to: "graphql#execute"')
@@ -123,7 +123,14 @@ module Graphql
           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]
-          gem("graphiql-rails", group: :development)
+          # `gem(...)` uses `gsub_file(...)` under the hood, which is a no-op for `rails destroy...` (when `behavior == :revoke`).
+          # So handle that case by calling `gsub_file` with `force: true`.
+          if behavior == :invoke && !File.read(Rails.root.join("Gemfile")).include?("graphiql-rails")
+            gem("graphiql-rails", group: :development)
+          elsif behavior == :revoke
+            gemfile_pattern = /\n\s*gem ('|")graphiql-rails('|"), :?group(:| =>) :development/
+            gsub_file Rails.root.join("Gemfile"), gemfile_pattern, "", { force: true }
+          end
 
           # This is a little cheat just to get cleaner shell output:
           log :route, 'graphiql-rails'
@@ -164,7 +171,10 @@ if Rails.env.development?
 RUBY
             end
           end
+        end
 
+        if options[:relay]
+          install_relay
         end
 
         if gemfile_modified?

data/lib/generators/graphql/interface_generator.rb

@@ -13,14 +13,14 @@ module Graphql
       desc "Create a GraphQL::InterfaceType 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 interface (type may be expressed as Ruby or GraphQL)"
+      private
 
-      def create_type_file
-        template "interface.erb", "#{options[:directory]}/types/#{type_file_name}.rb"
+      def graphql_type
+        "interface"
+      end
+
+      def fields
+        custom_fields
       end
     end
   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_create_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'orm_mutations_base'
+
+module Graphql
+  module Generators
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
+    #     rails g graphql:mutation CreatePostMutation
+    class MutationCreateGenerator < OrmMutationsBase
+
+      desc "Scaffold a Relay Classic ORM create mutation for the given model class"
+      source_root File.expand_path('../templates', __FILE__)
+
+      private
+
+      def operation_type
+        "create"
+      end
+    end
+  end
+end

data/lib/generators/graphql/mutation_delete_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'orm_mutations_base'
+
+module Graphql
+  module Generators
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
+    #     rails g graphql:mutation CreatePostMutation
+    class MutationDeleteGenerator < OrmMutationsBase
+
+      desc "Scaffold a Relay Classic ORM delete mutation for the given model class"
+      source_root File.expand_path('../templates', __FILE__)
+
+      private
+
+      def operation_type
+        "delete"
+      end
+    end
+  end
+end

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'
 
@@ -8,47 +9,22 @@ module Graphql
     #
     # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
     #     rails g graphql:mutation CreatePostMutation
-    class MutationGenerator < Rails::Generators::Base
+    class MutationGenerator < Rails::Generators::NamedBase
       include Core
 
       desc "Create a Relay Classic mutation by name"
       source_root File.expand_path('../templates', __FILE__)
 
-      argument :name, type: :string
-
-      def initialize(args, *options) #:nodoc:
-        # Unfreeze name in case it's given as a frozen string
-        args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
-        super
-
-        assign_names!(name)
-      end
-
-      attr_reader :file_name, :mutation_name, :field_name
-
       def create_mutation_file
-        unless @behavior == :revoke
-          create_mutation_root_type
-        else
-          log :gsub, "#{options[:directory]}/types/mutation_type.rb"
-        end
-
-        template "mutation.erb", "#{options[:directory]}/mutations/#{file_name}.rb"
+        template "mutation.erb", File.join(options[:directory], "/mutations/", class_path, "#{file_name}.rb")
 
         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}, mutation: Mutations::#{mutation_name}\n", after: sentinel, verbose: false, force: false
+          path = "#{options[:directory]}/types/mutation_type.rb"
+          invoke "graphql:install:mutation_root" unless File.exist?(path)
+          inject_into_file "#{options[:directory]}/types/mutation_type.rb", "    field :#{file_name}, mutation: Mutations::#{class_name}\n", after: sentinel, verbose: false, force: false
         end
       end
-
-      private
-
-      def assign_names!(name)
-        @field_name = name.camelize.underscore
-        @mutation_name = name.camelize(:upper)
-        @file_name = name.camelize.underscore
-      end
     end
   end
 end

data/lib/generators/graphql/mutation_update_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'orm_mutations_base'
+
+module Graphql
+  module Generators
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
+    #     rails g graphql:mutation CreatePostMutation
+    class MutationUpdateGenerator < OrmMutationsBase
+
+      desc "Scaffold a Relay Classic ORM update mutation for the given model class"
+      source_root File.expand_path('../templates', __FILE__)
+
+      private
+
+      def operation_type
+        "update"
+      end
+    end
+  end
+end

data/lib/generators/graphql/object_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'generators/graphql/type_generator'
+require 'generators/graphql/field_extractor'
 
 module Graphql
   module Generators
@@ -12,38 +13,28 @@ module Graphql
     #
     # Add the Node interface with `--node`.
     class ObjectGenerator < TypeGeneratorBase
-      desc "Create a GraphQL::ObjectType with the given name and fields"
+      desc "Create a GraphQL::ObjectType with the given name and fields." \
+      "If the given type name matches an existing ActiveRecord model, the generated type will automatically include fields for the models database columns."
       source_root File.expand_path('../templates', __FILE__)
-
-      argument :custom_fields,
-               type: :array,
-               default: [],
-               banner: "name:type name:type ...",
-               desc: "Fields for this object (type may be expressed as Ruby or GraphQL)"
+      include FieldExtractor
 
       class_option :node,
                    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"
+        case type_expression.camelize
+        when "Text", "Citext"
           ["String", null]
+        when "Decimal"
+          ["Float", null]
         when "DateTime", "Datetime"
           ["GraphQL::Types::ISO8601DateTime", null]
         when "Date"
           ["GraphQL::Types::ISO8601Date", null]
+        when "Json", "Jsonb", "Hstore"
+          ["GraphQL::Types::JSON", null]
         else
           super
         end
@@ -51,25 +42,8 @@ module Graphql
 
       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)
+      def graphql_type
+        "object"
       end
     end
   end

data/lib/generators/graphql/orm_mutations_base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/named_base'
+require_relative 'core'
+
+module Graphql
+  module Generators
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
+    #     rails g graphql:mutation CreatePostMutation
+    class OrmMutationsBase < Rails::Generators::NamedBase
+      include Core
+      include Rails::Generators::ResourceHelpers
+
+      desc "Create a Relay Classic mutation by name"
+
+      class_option :orm, banner: "NAME", type: :string, required: true,
+                         desc: "ORM to generate the controller for"
+
+      class_option 'namespaced_types',
+        type: :boolean,
+        required: false,
+        default: false,
+        banner: "Namespaced",
+        desc: "If the generated types will be namespaced"
+
+      def create_mutation_file
+        template "mutation_#{operation_type}.erb", File.join(options[:directory], "/mutations/", class_path, "#{file_name}_#{operation_type}.rb")
+
+        sentinel = /class .*MutationType\s*<\s*[^\s]+?\n/m
+        in_root do
+          path = "#{options[:directory]}/types/mutation_type.rb"
+          invoke "graphql:install:mutation_root" unless File.exist?(path)
+          inject_into_file "#{options[:directory]}/types/mutation_type.rb", "    field :#{file_name}_#{operation_type}, mutation: Mutations::#{class_name}#{operation_type.classify}\n", after: sentinel, verbose: false, force: false
+        end
+      end
+    end
+  end
+end

data/lib/generators/graphql/relay.rb

@@ -0,0 +1,63 @@
+# 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)
+    # For example, use Rails' GlobalID library (https://github.com/rails/globalid):
+    object_id = object.to_global_id.to_s
+    # Remove this redundant prefix to make IDs shorter:
+    object_id = object_id.sub("gid://\#{GlobalID.app}/", "")
+    encoded_id = Base64.urlsafe_encode64(object_id)
+    # Remove the "=" padding
+    encoded_id = encoded_id.sub(/=+/, "")
+    # Add a type hint
+    type_hint = type_definition.graphql_name.first
+    "\#{type_hint}_\#{encoded_id}"
+  end
+
+  # Given a string UUID, find the object
+  def self.object_from_id(encoded_id_with_hint, query_ctx)
+    # For example, use Rails' GlobalID library (https://github.com/rails/globalid):
+    # Split off the type hint
+    _type_hint, encoded_id = encoded_id_with_hint.split("_", 2)
+    # Decode the ID
+    id = Base64.urlsafe_decode64(encoded_id)
+    # Rebuild it for Rails then find the object:
+    full_global_id = "gid://\#{GlobalID.app}/\#{id}"
+    GlobalID::Locator.locate(full_global_id)
+  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

@@ -12,8 +12,10 @@ module Graphql
       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"
+      private
+
+      def graphql_type
+        "scalar"
       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/enum.erb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Types
-  class <%= type_ruby_name.split('::')[-1] %> < Types::BaseEnum
+  class <%= ruby_class_name %> < Types::BaseEnum
+    description "<%= human_name %> enum"
+
 <% prepared_values.each do |v| %>    value "<%= v[0] %>"<%= v.length > 1 ? ", value: #{v[1]}" : "" %>
 <% end %>  end
 end