graphql 0.16.0 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f8d3d315c998e0d44c6ebbcd186825a1d7c86639
-  data.tar.gz: adfa16f977635d988505202bee3ea8fe54ede003
+SHA256:
+  metadata.gz: 46b43157a331eae41dd54897d24dbc3adac190910237c7c1c158fc2bc32b6616
+  data.tar.gz: 118ac97b740ba1340d3e6b9aee5fa2f81ca25dc8769a98ec0d8e25d63e839711
 SHA512:
-  metadata.gz: 34bad6ba6d2ff0e811b2d9abbddf3e834df69e8fb8d6a1b06581f446b8bffee325717df2731874bcec57581cac8d7808a9c97937d43e1d45386edf41f8824a4f
-  data.tar.gz: e11a5741e64138f68cac3ad51d14243bfa47c8f56b3b03144b685b1d2d71d4fea657221bcdffcfdaef5edd485b7df6262eb018b38ac4dcb0e01b22648c55a080
+  metadata.gz: be38356ecdff7f8a9627bb021e83d13ea92e951b287386e76fd6e42ff05ef0a5a37ce9c98e6e4bf1834459989558f6c8b512c98e7642bef2c624578c1db24932
+  data.tar.gz: b0b75f342dca7a731b1b59e6399d364184152ceb0c5deb9fb4338a3582b3b6e38bf789a53839f6def9eb4b9c079c45e74675fb608a184dff4e6aeaf0ce052dfd

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--markup=markdown
+--readme=readme.md
+--title='GraphQL Ruby API Documentation'
+'lib/**/*.rb' - '*.md'

data/lib/generators/graphql/core.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module Graphql
+  module Generators
+    module Core
+      def self.included(base)
+        base.send(
+          :class_option,
+          :directory,
+          type: :string,
+          default: "app/graphql",
+          desc: "Directory where generated files should be saved"
+        )
+      end
+
+      def insert_root_type(type, name)
+        log :add_root_type, type
+        sentinel = /< GraphQL::Schema\s*\n/m
+
+        in_root do
+          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 schema_file_path
+        "#{options[:directory]}/#{schema_name.underscore}.rb"
+      end
+
+      def create_dir(dir)
+        empty_directory(dir)
+        if !options[:skip_keeps]
+          create_file("#{dir}/.keep")
+        end
+      end
+
+      def module_namespacing_when_supported
+        if defined?(module_namespacing)
+          module_namespacing { yield }
+        else
+          yield
+        end
+      end
+
+      private
+
+      def schema_name
+        @schema_name ||= begin
+          if options[:schema]
+            options[:schema]
+          else
+            "#{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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'generators/graphql/type_generator'
+
+module Graphql
+  module Generators
+    # Generate an enum type by name, with the given values.
+    # To add a `value:` option, add another value after a `:`.
+    #
+    # ```
+    # rails g graphql:enum ProgrammingLanguage RUBY PYTHON PERL PERL6:"PERL"
+    # ```
+    class EnumGenerator < TypeGeneratorBase
+      desc "Create a GraphQL::EnumType with the given name and values"
+      source_root File.expand_path('../templates', __FILE__)
+
+      private
+
+      def graphql_type
+        "enum"
+      end
+
+      def prepared_values
+        custom_fields.map { |v| v.split(":", 2) }
+      end
+    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,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/install/templates/mutation_type.erb

@@ -0,0 +1,12 @@
+<% module_namespacing_when_supported do -%>
+module Types
+  class MutationType < Types::BaseObject
+    # TODO: remove me
+    field :test_field, String, null: false,
+      description: "An example field added by the generator"
+    def test_field
+      "Hello World"
+    end
+  end
+end
+<% end -%>

data/lib/generators/graphql/install_generator.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/base'
+require_relative 'core'
+require_relative 'relay'
+
+module Graphql
+  module Generators
+    # Add GraphQL to a Rails app with `rails g graphql:install`.
+    #
+    # Setup a folder structure for GraphQL:
+    #
+    # ```
+    # - app/
+    #   - 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
+    # ```
+    #
+    # (Add `.gitkeep`s by default, support `--skip-keeps`)
+    #
+    # Add a controller for serving GraphQL queries:
+    #
+    # ```
+    # app/controllers/graphql_controller.rb
+    # ```
+    #
+    # Add a route for that controller:
+    #
+    # ```ruby
+    # # config/routes.rb
+    # post "/graphql", to: "graphql#execute"
+    # ```
+    #
+    # Accept a `--batch` option which adds `GraphQL::Batch` setup.
+    #
+    # 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__)
+
+      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"
+
+      class_option :skip_graphiql,
+        type: :boolean,
+        default: false,
+        desc: "Skip graphiql-rails installation"
+
+      class_option :skip_mutation_root_type,
+        type: :boolean,
+        default: false,
+        desc: "Skip creation of the mutation root type"
+
+      class_option :relay,
+        type: :boolean,
+        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,
+        desc: "Preconfigure smaller stack for API only apps"
+
+      def create_folder_structure
+        create_dir("#{options[:directory]}/types")
+        template("schema.erb", schema_file_path)
+
+        ["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')
+
+        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"')
+
+        if options[:batch]
+          gem("graphql-batch")
+          create_dir("#{options[:directory]}/loaders")
+        end
+
+        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]
+          # `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'
+          shell.mute do
+            # Rails 5.2 has better support for `route`?
+            if Rails::VERSION::STRING > "5.2"
+              route <<-RUBY
+if Rails.env.development?
+  mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
+end
+RUBY
+            else
+              route <<-RUBY
+if Rails.env.development?
+    mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
+  end
+RUBY
+            end
+          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
+      end
+
+      private
+
+      def gemfile_modified?
+        @gemfile_modified
+      end
+
+      def gem(*args)
+        @gemfile_modified = true
+        super(*args)
+      end
+    end
+  end
+end

data/lib/generators/graphql/interface_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'generators/graphql/type_generator'
+
+module Graphql
+  module Generators
+    # Generate an interface type by name,
+    # with the specified fields.
+    #
+    # ```
+    # rails g graphql:interface NamedEntityType name:String!
+    # ```
+    class InterfaceGenerator < TypeGeneratorBase
+      desc "Create a GraphQL::InterfaceType with the given name and fields"
+      source_root File.expand_path('../templates', __FILE__)
+
+      private
+
+      def graphql_type
+        "interface"
+      end
+
+      def fields
+        custom_fields
+      end
+    end
+  end
+end

data/lib/generators/graphql/loader_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require "rails/generators/named_base"
+require_relative "core"
+
+module Graphql
+  module Generators
+    # @example Generate a `GraphQL::Batch` loader by name.
+    #     rails g graphql:loader RecordLoader
+    class LoaderGenerator < Rails::Generators::NamedBase
+      include Core
+
+      desc "Create a GraphQL::Batch::Loader by name"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_loader_file
+        template "loader.erb", "#{options[:directory]}/loaders/#{file_path}.rb"
+      end
+    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

@@ -0,0 +1,30 @@
+# 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 MutationGenerator < Rails::Generators::NamedBase
+      include Core
+
+      desc "Create a Relay Classic mutation by name"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_mutation_file
+        template "mutation.erb", File.join(options[:directory], "/mutations/", class_path, "#{file_name}.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}, mutation: Mutations::#{class_name}\n", after: sentinel, verbose: false, force: false
+        end
+      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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'generators/graphql/type_generator'
+require 'generators/graphql/field_extractor'
+
+module Graphql
+  module Generators
+    # Generate an object type by name,
+    # with the specified fields.
+    #
+    # ```
+    # rails g graphql:object PostType name:String!
+    # ```
+    #
+    # Add the Node interface with `--node`.
+    class ObjectGenerator < TypeGeneratorBase
+      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__)
+      include FieldExtractor
+
+      class_option :node,
+                   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 graphql_type
+        "object"
+      end
+    end
+  end
+end