graphql 1.13.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4cb09369d39b11ac4ebb242db3da4bc008a850cdd78c88816143cdfd84addd9
-  data.tar.gz: 4c5fc1be26724efda2dfc4e0f6ae0ad0ff9593b8708cf38ce3ec3a2ffae759d7
+  metadata.gz: c54b2619d5d111575839ba3e5d34794d993cb37a0b9aee4d41347551bb6be846
+  data.tar.gz: f6d53678c268767478a2a86ec34c045ab8744f4ea6f97deeebed3708df634340
 SHA512:
-  metadata.gz: ea28714d8d623e7591325672a08d031f03877f3744fdc18554ac0be2f2e3149dc2f99ee209f3b91d2d3f82564617d71eee5675a32ea1f60d0d75cc7cdffcf1b3
-  data.tar.gz: 492bd5f0312bb01a79175fdf87388e2ffd51a3bbe2d8a485a78e30f89634fd1a5ec28fbb1626ea775b38cd1984a3abfa2cc7ba58bd6189165fc91f923a668e30
+  metadata.gz: c7ccf09ae0a94e0cdce47f66555681391ac29af9cb544b662e8f9cd127905cda5cf5923dc64500dcab15899c7c51d5d2458ae78b95cb40ca47b1ce792e35f52c
+  data.tar.gz: ba6d04f4fc107fe9e2daaf70bd06288f85a6ead011764ab1b975e1796e97fa8c289cc08186bbf23c6020670a585c1a48c22d2acbd28ed10c6ec09b97f07a2a47

data/lib/generators/graphql/core.rb

@@ -25,13 +25,6 @@ module Graphql
         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

@@ -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"')

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/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

@@ -9,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
@@ -15,31 +16,16 @@ module Graphql
       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]
@@ -47,6 +33,8 @@ module Graphql
           ["GraphQL::Types::ISO8601DateTime", null]
         when "Date"
           ["GraphQL::Types::ISO8601Date", null]
+        when "Json", "Jsonb", "Hstore"
+          ["GraphQL::Types::JSON", null]
         else
           super
         end
@@ -54,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/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/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

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+<% module_namespacing_when_supported do -%>
+module Types
+  class <%= ruby_class_name %> < Types::BaseInputObject
+<% normalized_fields.each do |f| %>    <%= f.to_input_argument %>
+<% end %>  end
+end
+<% end -%>

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Types
-  module <%= type_ruby_name.split('::')[-1] %>
+  module <%= ruby_class_name %>
     include Types::BaseInterface
-<% normalized_fields.each do |f| %>    <%= f.to_ruby %>
+<% normalized_fields.each do |f| %>    <%= f.to_object_field %>
 <% end %>  end
 end
 <% end -%>

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

@@ -1,6 +1,6 @@
 <% module_namespacing_when_supported do -%>
 module Mutations
-  class <%= mutation_name %> < BaseMutation
+  class <%= class_name %> < BaseMutation
     # TODO: define return fields
     # field :post, Types::PostType, null: false
 

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+<% module_namespacing_when_supported do -%>
+module Mutations
+  class <%= class_name %>Create < BaseMutation
+    description "Creates a new <%= file_name %>"
+
+    field :<%= file_name %>, Types::<%= options[:namespaced_types] ? 'Objects::' : '' %><%= class_name %>Type, null: false
+
+    argument :<%= file_name %>_input, Types::<%= options[:namespaced_types] ? 'Inputs::' : '' %><%= class_name %>InputType, required: true
+
+    def resolve(<%= file_name %>_input:)
+      <%= singular_table_name %> = ::<%= orm_class.build(class_name, "**#{file_name}_input") %>
+      raise GraphQL::ExecutionError.new "Error creating <%= file_name %>", extensions: <%= singular_table_name %>.errors.to_hash unless <%= orm_instance.save %>
+
+      { <%= file_name %>: <%= singular_table_name %> }
+    end
+  end
+end
+<% end -%>

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+<% module_namespacing_when_supported do -%>
+module Mutations
+  class <%= class_name %>Delete < BaseMutation
+    description "Deletes a <%= file_name %> by ID"
+
+    field :<%= file_name %>, Types::<%= options[:namespaced_types] ? 'Objects::' : '' %><%= class_name %>Type, null: false
+
+    argument :id, ID, required: true
+
+    def resolve(id:)
+      <%= singular_table_name %> = ::<%= orm_class.find(class_name, "id") %>
+      raise GraphQL::ExecutionError.new "Error deleting <%= file_name %>", extensions: <%= singular_table_name %>.errors.to_hash unless <%= orm_instance.destroy %>
+
+      { <%= file_name %>: <%= singular_table_name %> }
+    end
+  end
+end
+<% end -%>

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+<% module_namespacing_when_supported do -%>
+module Mutations
+  class <%= class_name %>Update < BaseMutation
+    description "Updates a <%= file_name %> by id"
+
+    field :<%= file_name %>, Types::<%= options[:namespaced_types] ? 'Objects::' : '' %><%= class_name %>Type, null: false
+
+    argument :id, ID, required: true
+    argument :<%= file_name %>_input, Types::<%= options[:namespaced_types] ? 'Inputs::' : '' %><%= class_name %>InputType, required: true
+
+    def resolve(id:, <%= file_name %>_input:)
+      <%= singular_table_name %> = ::<%= orm_class.find(class_name, "id") %>
+      raise GraphQL::ExecutionError.new "Error updating <%= file_name %>", extensions: <%= singular_table_name %>.errors.to_hash unless <%= orm_instance.update("**#{file_name}_input") %>
+
+      { <%= file_name %>: <%= singular_table_name %> }
+    end
+  end
+end
+<% end -%>

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Types
-  class <%= type_ruby_name.split('::')[-1] %> < Types::BaseObject
+  class <%= ruby_class_name %> < Types::BaseObject
 <% if options.node %>    implements GraphQL::Types::Relay::Node
-<% end %><% normalized_fields.each do |f| %>    <%= f.to_ruby %>
+<% end %><% normalized_fields.each do |f| %>    <%= f.to_object_field %>
 <% end %>  end
 end
 <% end -%>

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Types
-  class <%= type_ruby_name.split('::')[-1] %> < Types::BaseScalar
+  class <%= ruby_class_name %> < Types::BaseScalar
     def self.coerce_input(input_value, context)
       # Override this to prepare a client-provided GraphQL value for your Ruby code
       input_value

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Types
-  class <%= type_ruby_name.split('::')[-1] %> < Types::BaseUnion
-<% if possible_types.any? %>    possible_types <%= normalized_possible_types.join(", ") %>
+  class <%= ruby_class_name %> < Types::BaseUnion
+<% if custom_fields.any? %>    possible_types <%= normalized_possible_types.join(", ") %>
 <% end %>  end
 end
 <% end -%>