graphql 1.9.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb79bf185d3d89d53f50ad5f0ae1cc93e3480acb
-  data.tar.gz: 46c04d4e296ea2b3b520d6df50f82d76da5ec641
+SHA256:
+  metadata.gz: 9997a74f471a1d4abbca1fe24f276db80bbad6f87b278a8083491ced64354906
+  data.tar.gz: 4265a7d1e76f784ad3df4739328fedfae1698e26dc4a1fee982971650e553c47
 SHA512:
-  metadata.gz: 78e070c3df4abd9e2d649ba0e5f1e7fdcef9b0241572a30bf233d516fa28b7eee9afa0fd2d650db835556dff87f4eddb344aefce8825019569aa7e55ff28f780
-  data.tar.gz: eb138cb5d2274c815ea42ec2eff4371cf34023ad817e4009302cb6de6da7deea213ccfaa2169d86a6a8c2b684f9e4fc8bd0780060163a764960d22af1a48bb25
+  metadata.gz: 2b1c5bed0660b9c194814e889384b3a37a27967c1f808aff55e693431056729434a2556cf85e9dd4c184262f8ad1344fe86316c3ffa12afc2c87315d69773f04
+  data.tar.gz: 0b2c961d00651a479ce183e0c77d23d2090df85f46490aac53d724d0f657f9cfe1c49bda191feec4b3a90f1cf671cd55f0a6a97d0c79c20d567fc47e214f921d

data/lib/generators/graphql/core.rb

@@ -19,16 +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("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
@@ -40,6 +36,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 +51,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

@@ -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/templates/base_mutation.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+<% 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 → install/templates}/mutation_type.erb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+<% module_namespacing_when_supported do -%>
 module Types
   class MutationType < Types::BaseObject
     # TODO: remove me
@@ -8,3 +11,4 @@ module Types
     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
@@ -13,6 +15,8 @@ module Graphql
     #   - graphql/
     #     - resolvers/
     #     - types/
+    #       - base_argument.rb
+    #       - base_field.rb
     #       - base_enum.rb
     #       - base_input_object.rb
     #       - base_interface.rb
@@ -22,6 +26,7 @@ module Graphql
     #       - query_type.rb
     #     - loaders/
     #     - mutations/
+    #       - base_mutation.rb
     #     - {app_name}_schema.rb
     # ```
     #
@@ -40,16 +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.
+    # Use `--skip-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__)
@@ -76,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,
@@ -93,7 +101,7 @@ module Graphql
         create_dir("#{options[:directory]}/types")
         template("schema.erb", schema_file_path)
 
-        ["base_object", "base_enum", "base_input_object", "base_interface", "base_scalar", "base_union"].each do |base_type|
+        ["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
 
@@ -101,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"')
@@ -115,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'
@@ -137,6 +152,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/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 DeletePostMutation
+    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(:lower)
-        @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 UpdatePostMutation
+    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,22 +13,37 @@ 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 :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"
+                   type: :boolean,
+                   default: false,
+                   desc: "Include the Relay Node interface"
+
+      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 create_type_file
-        template "object.erb", "#{options[:directory]}/types/#{type_file_name}.rb"
+      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