rails-graphql 0.2.1 → 1.0.0.rc1

data/lib/generators/graphql/install_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module GraphQL
+  module Generators
+    class InstallGenerator < Rails::Generators::Base # :nodoc:
+      include Rails::GraphQL::BaseGenerator
+
+      desc 'Add an initial setup to your application'
+
+      argument :schema, type: :string, optional: true,
+        default: "#{APP_MODULE_NAME}Schema",
+        desc: 'A name for the schema'
+
+      class_option :skip_routes, type: :boolean,
+        default: false,
+        desc: 'Add some initial routes'
+
+      class_option :skip_keeps, type: :boolean,
+        default: false,
+        desc: 'Skip .keep files'
+
+      def create_config_file
+        template 'config.rb', 'config/initializers/graphql.rb'
+      end
+
+      def create_schema
+        invoke 'graphql:schema'
+      end
+
+      def create_keep_files
+        return if options[:skip_keeps]
+
+        %w[
+          directives fields sources enums inputs interfaces object
+          scalars unions queries mutations subscriptions
+        ].each { |folder| create_file("#{options[:directory]}/#{folder}/.keep") }
+      end
+
+      def add_routes
+        return if options[:skip_routes]
+        route('get  "/graphql/describe", to: "graphql/base#describe"')
+        route('get  "/graphiql",         to: "graphql/base#graphiql"')
+        route('post "/graphql",          to: "graphql/base#execute"')
+      end
+    end
+  end
+end

data/lib/generators/graphql/schema_generator.rb

@@ -8,15 +8,20 @@ module GraphQL
       include Rails::GraphQL::BaseGenerator
 
       desc 'Add a new GraphQL schema'
-      argument :name, type: :string, optional: true
+
+      argument :schema, type: :string, optional: true,
+        default: "#{APP_MODULE_NAME}Schema",
+        desc: 'A name for the schema'
 
       def create_schema_file
         template 'schema.erb', "#{options[:directory]}/#{schema_name.underscore}.rb"
       end
 
-      def schema_name
-        @schema_name ||= options[:name].presence || "#{app_module_name}Schema"
-      end
+      private
+
+        def schema_name
+          @schema_name ||= options.fetch(:schema, "#{APP_MODULE_NAME}Schema")
+        end
     end
   end
 end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= channel_name %> < ApplicationCable::Channel
+  include GraphQL::Channel
+end
+<% end -%>

data/lib/generators/graphql/templates/config.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+Rails::GraphQL.configure do |config|
+  # This helps to keep track of when things were cached and registered. Cached
+  # objects with mismatching versions need to be upgraded or simply reloaded.
+  # An excellent way to use this is to set it to the commit hash. TypePap will
+  # always use only the first 8 characters for simplicity.
+  # config.version = nil
+
+  # The instance responsible for caching all the information generated by
+  # requests and all the other components. Manually setting this property
+  # means that the object in it complies with `ActiveSupport::Cache::Store`.
+  # This will map automatically to `Rails.cache` if kept as `nil`. This can
+  # also be set per Schema.
+  # config.cache = nil
+
+  # This is the prefix key of all the cache entries for the GraphQL cached
+  # things.
+  # config.cache_prefix = 'graphql/'
+
+  # This is very similar to `ActiveRecord` verbose logs, which simply show the
+  # path of the file that started a GraphQL request.
+  # config.verbose_logs = true
+
+  # The list of parameters to omit from the logger when running a GraphQL
+  # request. Those values are displayed better in the internal runtime logger
+  # controller.
+  # config.omit_parameters = %w[query operationName operation_name variables graphql]
+
+  # Identical to the one available on a Rails application, but exclusive for
+  # GraphQL operations. The list of parameters to display as filtered in the
+  # logs. When it is nil, it will use the same as the Rails application.
+  # config.filter_parameters = nil
+
+  # The suffix that is added automatically to all the Input type objects. This
+  # prevents situations like `PointInputInput`. If your inputs have a
+  # different suffix, change this value to it.
+  # config.auto_suffix_input_objects = 'Input'
+
+  # Introspection is enabled by default. It is recommended to only use
+  # introspection during development and tests, never in production.
+  # This can also be set per schema level.
+  config.enable_introspection = true
+
+  # Define the names of the schema/operations types. The single "_" is a
+  # suggestion. In an application that has a Subscription object, it will
+  # prevent the conflict. Plus, it is easy to spot that it is something
+  # internal. This can also be set per Schema.
+  # config.schema_type_names = {
+  #   query: '_Query',
+  #   mutation: '_Mutation',
+  #   subscription: '_Subscription',
+  # }
+
+  # For performance purposes, this gem implements a
+  # {JsonCollector}[rdoc-ref:Rails::GraphQL::Collectors::JsonCollector].
+  # You can disable this option if you prefer to use the standard
+  # hash-to-string serialization provided by `ActiveSupport`.
+  # This can also be set per Schema.
+  # config.enable_string_collector = true
+
+  # Set what is de default expected output type of GraphQL requests. String
+  # combined with the previous setting has the best performance. On the
+  # console, it will automatically shift to Hash. This can also be set per
+  # Schema.
+  # config.default_response_format = :string
+
+  # Specifies if the results of operations should be encoded with
+  # +ActiveSupport::JSON#encode+ instead of the default +JSON#generate+.
+  # See also https://github.com/rails/rails/blob/master/activesupport/lib/active_support/json/encoding.rb
+  # config.encode_with_active_support = false
+
+  # Enable the ability of a callback to inject arguments dynamically into the
+  # calling method.
+  # config.callback_inject_arguments = true
+
+  # Enable the ability of a callback to inject named arguments dynamically
+  # into the calling method.
+  # config.callback_inject_named_arguments = true
+
+  # When importing fields from modules or other objects, a warning is
+  # displayed for any given element that was not able to be correctly
+  # imported. You can silence such warnings by changing this option.
+  # config.silence_import_warnings = false
+
+  # Enable the ability to define the description of any object, field, or
+  # argument using I18n. It is recommended for multi-language documentation.
+  config.enable_i18n_descriptions = true
+
+  # The method that should be used to parse literal input values when they are
+  # provided as Hash. `JSON.parse` only supports keys wrapped in quotes. You
+  # can use `Psych.method(:safe_load)` to support keys without quotes, which
+  # behaves closer to YAML. The received value is ensured to be wrapped in
+  # "{}". If that produces unexpected results, you can assign a proc and then
+  # parse the value in any other way.
+  # config.literal_input_parser = JSON.method(:parse)
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 <% module_namespacing do -%>
 class <%= controller_name %> < ApplicationController
   include GraphQL::Controller

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module GraphQL
-  <% module_namespacing do -%>
-  class <%= schema_name %> < Schema
+  <%- module_namespacing do -%>
+  class <%= schema_name %> < GraphQL::Schema
   end
-  <% end -%>
+  <%- end -%>
 end

data/lib/rails/graphql/adapters/mysql_adapter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # Based on:
+    # SELECT DISTINCT data_type FROM information_schema.columns;
+    # And https://www.mysqltutorial.org/mysql-data-types.aspx
+    type_map.register_alias 'mysql:varchar',      :string
+    type_map.register_alias 'mysql:bit',          :bool
+    type_map.register_alias 'mysql:int',          :int
+    type_map.register_alias 'mysql:bigint',       :bigint
+    type_map.register_alias 'mysql:json',         :json
+    type_map.register_alias 'mysql:date',         :date
+    type_map.register_alias 'mysql:timestamp',    :date_time
+    type_map.register_alias 'mysql:binary',       :binary
+    type_map.register_alias 'mysql:float',        :float
+    type_map.register_alias 'mysql:decimal',      :decimal
+    type_map.register_alias 'mysql:time',         :time
+
+    type_map.register_alias 'mysql:set',          'mysql:varchar'
+    type_map.register_alias 'mysql:text',         'mysql:varchar'
+    type_map.register_alias 'mysql:enum',         'mysql:varchar'
+    type_map.register_alias 'mysql:char',         'mysql:varchar'
+    type_map.register_alias 'mysql:tinytext',     'mysql:text'
+    type_map.register_alias 'mysql:mediumtext',   'mysql:text'
+    type_map.register_alias 'mysql:longtext',     'mysql:text'
+    type_map.register_alias 'mysql:datetime',     'mysql:timestamp'
+    type_map.register_alias 'mysql:varbinary',    'mysql:binary'
+    type_map.register_alias 'mysql:blob',         'mysql:binary'
+    type_map.register_alias 'mysql:tinyblob',     'mysql:blob'
+    type_map.register_alias 'mysql:mediumblob',   'mysql:blob'
+    type_map.register_alias 'mysql:longblob',     'mysql:blob'
+    type_map.register_alias 'mysql:tinyint',      'mysql:int'
+    type_map.register_alias 'mysql:smallint',     'mysql:int'
+    type_map.register_alias 'mysql:mediumint',    'mysql:int'
+    type_map.register_alias 'mysql:double',       'mysql:float'
+
+    module MySQL
+      module SourceMethods
+        protected
+
+          def mysql_attributes
+            model.columns_hash.each_value do |column|
+              next yield(column.name, find_type!(:id)) if id_columns.include?(column.name)
+
+              base_type, size = column.sql_type_metadata.sql_type.split(/(\(\d+\))/)
+              type_name = base_type.end_with?('int') && size == '(1)' ? 'bit' : base_type
+
+              type = find_type!("mysql:#{type_name}", fallback: :string)
+
+              yield(column.name, type, array: (base_type == 'set'))
+            end
+          end
+      end
+    end
+
+    Source::ActiveRecordSource.extend(MySQL::SourceMethods)
+  end
+end

data/lib/rails/graphql/adapters/pg_adapter.rb

@@ -1,45 +1,48 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # Based on:
     # SELECT t.oid, t.typname, format_type(t.oid, NULL) AS sql_type
     # FROM pg_type t
     # WHERE typtype = 'b'
-    #   AND typcategory IN ('B', 'D', 'G', 'I', 'N', 'S', 'T', 'V')
+    #   AND typcategory IN ('B', 'D', 'G', 'I', 'N', 'S', 'T', 'U', 'V')
     #   AND typowner = 10;
-    type_map.register_alias 'pg:boolean',                     :boolean
-    type_map.register_alias 'pg:integer',                     :int
-    type_map.register_alias 'pg:date',                        :date
-
-    type_map.register_alias 'pg:char',                        :string
     type_map.register_alias 'pg:bigint',                      :bigint
-    type_map.register_alias 'pg:smallint',                    :int
+    type_map.register_alias 'pg:boolean',                     :boolean
     type_map.register_alias 'pg:text',                        :string
-    type_map.register_alias 'pg:oid',                         :int
+    type_map.register_alias 'pg:date',                        :date
+    type_map.register_alias 'pg:integer',                     :int
+    type_map.register_alias 'pg:json',                        :json
+    type_map.register_alias 'pg:numeric',                     :decimal
     type_map.register_alias 'pg:real',                        :float
-    type_map.register_alias 'pg:double precision',            :float
-    type_map.register_alias 'pg:money',                       :decimal
-    type_map.register_alias 'pg:character',                   :string
-    type_map.register_alias 'pg:character varying',           :string
-    type_map.register_alias 'pg:timestamp',                   :date_time
-    type_map.register_alias 'pg:timestamp without time zone', :date_time
-    type_map.register_alias 'pg:timestamp with time zone',    :date_time
     type_map.register_alias 'pg:time without time zone',      :time
-    type_map.register_alias 'pg:time with time zone',         :time
-    type_map.register_alias 'pg:numeric',                     :decimal
+    type_map.register_alias 'pg:timestamp',                   :date_time
+
+    type_map.register_alias 'pg:char',                        'pg:text'
+    type_map.register_alias 'pg:smallint',                    'pg:integer'
+    type_map.register_alias 'pg:oid',                         'pg:integer'
+    type_map.register_alias 'pg:double precision',            'pg:real'
+    type_map.register_alias 'pg:money',                       'pg:numeric'
+    type_map.register_alias 'pg:character',                   'pg:text'
+    type_map.register_alias 'pg:character varying',           'pg:text'
+    type_map.register_alias 'pg:timestamp without time zone', 'pg:timestamp'
+    type_map.register_alias 'pg:timestamp with time zone',    'pg:timestamp'
+    type_map.register_alias 'pg:time with time zone',         'pg:time without time zone'
+    type_map.register_alias 'pg:jsonb',                       'pg:json'
 
-    module PG # :nodoc: all
+    module PG
       module SourceMethods
         protected
 
           def pg_attributes
             model.columns_hash.each_value do |column|
+              next yield(column.name, find_type!(:id)) if id_columns.include?(column.name)
+
               type_name = column.sql_type_metadata.sql_type
               type = find_type!('pg:' + type_name.gsub(/(\(|\[).*/, ''), fallback: :string)
 
-              options = { array: type_name.include?('[]') }
-              yield column.name, type, options
+              yield(column.name, type, array: type_name.include?('[]'))
             end
           end
       end

data/lib/rails/graphql/adapters/sqlite_adapter.rb

@@ -1,34 +1,37 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
 
     # Based on:
     # https://github.com/rails/rails/blob/v6.0.0/activerecord/lib/active_record/
     # connection_adapters/sqlite3_adapter.rb#L64
+    type_map.register_alias 'sqlite:binary',      :binary
+    type_map.register_alias 'sqlite:boolean',     :boolean
+    type_map.register_alias 'sqlite:date',        :date
+    type_map.register_alias 'sqlite:datetime',    :date_time
+    type_map.register_alias 'sqlite:decimal',     :decimal
+    type_map.register_alias 'sqlite:float',       :float
+    type_map.register_alias 'sqlite:integer',     :int
+    type_map.register_alias 'sqlite:json',        :json
     type_map.register_alias 'sqlite:primary_key', :id
     type_map.register_alias 'sqlite:string',      :string
-    type_map.register_alias 'sqlite:text',        :string
-    type_map.register_alias 'sqlite:integer',     :int
-    type_map.register_alias 'sqlite:float',       :float
-    type_map.register_alias 'sqlite:decimal',     :decimal
-    type_map.register_alias 'sqlite:datetime',    :date_time
     type_map.register_alias 'sqlite:time',        :time
-    type_map.register_alias 'sqlite:date',        :date
-    type_map.register_alias 'sqlite:binary',      :binary
-    type_map.register_alias 'sqlite:boolean',     :boolean
-    # TODO: Add support to JSON type
-    # type_map.register_alias 'pg:json',  :json
 
-    module SQLite # :nodoc: all
+    type_map.register_alias 'sqlite:varchar',     'sqlite:string'
+    type_map.register_alias 'sqlite:text',        'sqlite:string'
+
+    module SQLite
       module SourceMethods
         protected
 
           def sqlite_attributes
             model.columns_hash.each_value do |column|
+              next yield(column.name, find_type!(:id)) if id_columns.include?(column.name)
+
               type_name = column.sql_type_metadata.sql_type
               type = find_type!("sqlite:#{type_name}", fallback: :string)
-              yield column.name, type
+              yield(column.name, type)
             end
           end
       end

data/lib/rails/graphql/alternative/field_set.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    module Alternative
+      # = GraphQL Alternative Field Set
+      #
+      # A simple way to store fields that share some logic with each other
+      class FieldSet
+        extend Helpers::WithNamespace
+        extend Helpers::WithFields
+
+        include Helpers::Instantiable
+
+        self.field_type = Field::OutputField
+        self.valid_field_types = Type::Object.valid_field_types
+
+        def self.i18n_scope
+          :query
+        end
+
+        def self.inspect
+          +"#<#{self.class.name} @fields=#{fields.inspect}>"
+        end
+      end
+
+      # = GraphQL Alternative Query Set
+      #
+      # Exact the same as a +FieldSet+
+      QuerySet = FieldSet
+
+      # = GraphQL Alternative Mutation Set
+      #
+      # Same as a +FieldSet+ but for mutation fields
+      MutationSet = Class.new(FieldSet)
+      MutationSet.field_type = Field::MutationField
+      MutationSet.redefine_singleton_method(:i18n_scope) { :mutation }
+
+
+      # = GraphQL Alternative Subscription Set
+      #
+      # Same as a +FieldSet+ but for subscription fields
+      SubscriptionSet = Class.new(FieldSet)
+      SubscriptionSet.field_type = Field::SubscriptionField
+      SubscriptionSet.redefine_singleton_method(:i18n_scope) { :subscription }
+    end
+  end
+end

data/lib/rails/graphql/alternative/mutation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # = GraphQL Alternative Mutation
+    #
+    # Same as it's parent class, but for mutations
+    class Alternative::Mutation < Alternative::Query
+      redefine_singleton_method(:type_field_class) { :mutation }
+      self.abstract = true
+
+      class << self
+        delegate :perform, to: :@field, allow_nil: true
+      end
+    end
+  end
+end

data/lib/rails/graphql/alternative/query.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # = GraphQL Alternative Query
+    #
+    # This object acts like a field, but is organized as an object for extended
+    # resolvers or really complex fields.
+    class Alternative::Query
+      extend Helpers::WithNamespace
+      include Helpers::Instantiable
+
+      # An abstract class will not have its field imported
+      class_attribute :abstract, instance_accessor: false, default: false
+      self.abstract = true
+
+      class << self
+        delegate :gql_name, :to_sym, :desc, :argument, :ref_argument, :id_argument,
+          :use, :internal?, :disabled?, :enabled?, :disable!, :enable!, :rename!,
+          :authorize, :on, :description=, :description, to: :field
+
+        # Returns the type of the field class
+        def type_field_class
+          :query
+        end
+
+        # Alias does not work because of the override
+        def i18n_scope(*)
+          type_field_class
+        end
+
+        # Stores the underlying field of the object
+        def field
+          return @field if defined?(@field)
+          return define_field unless superclass.instance_variable_defined?(:@field)
+          import_field(superclass.field)
+        end
+
+        def inspect
+          defined?(@field) ? @field.inspect : super
+        end
+
+        protected
+
+          # Mark the given class to be pending of registration
+          def inherited(subclass)
+            subclass.abstract = false
+            super if defined? super
+          end
+
+          # Create a new field for the class
+          def define_field(field_name = nil, type = :any, **xargs, &block)
+            field_name ||= anonymous? ? '_anonymous' : begin
+              type_module = type_field_class.to_s.classify.pluralize
+              user_name = name.split(+"#{type_module}::")[1]
+              user_name ||= name.delete_prefix('GraphQL::')
+              user_name.tr(':', '')
+            end
+
+            # Save the generated field ensuring the owner
+            @field = field_class.new(field_name, type, **xargs, owner: self, &block)
+          end
+
+          # Import the field from a given source
+          def import_field(other_field, **xargs, &block)
+            @field = other_field.to_proxy(**xargs, owner: self, &block)
+          end
+
+          # Change the return type of the field
+          def returns(type, **xargs)
+            full     = xargs.fetch(:full, false)
+            null     = full ? false : xargs.fetch(:null, true)
+            array    = full ? true  : xargs.fetch(:array, false)
+            nullable = full ? false : xargs.fetch(:nullable, true)
+
+            field.send(:assign_type, type)
+            field.instance_variable_set(:@null, null)
+            field.instance_variable_set(:@array, array)
+            field.instance_variable_set(:@nullable, nullable)
+          end
+
+        private
+
+          # Return the class of the underlying field
+          def field_class
+            return @field.class if defined?(@field)
+            list = Helpers::WithSchemaFields::TYPE_FIELD_CLASS
+            GraphQL::Field.const_get(list[type_field_class])
+          end
+      end
+    end
+
+    # = GraphQL Alternative Field
+    #
+    # Just an alias, since query fields are the same as output fields
+    Alternative.const_set(:Field, Alternative::Query)
+  end
+end

data/lib/rails/graphql/alternative/subscription.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # = GraphQL Alternative Subscription
+    #
+    # Same as it's parent class, but for subscription
+    class Alternative::Subscription < Alternative::Query
+      redefine_singleton_method(:type_field_class) { :subscription }
+      self.abstract = true
+
+      class << self
+        delegate :scope, :trigger_for, :trigger, :unsubscribe_from, :unsubscribe,
+          to: :@field, allow_nil: true
+      end
+    end
+  end
+end

data/lib/rails/graphql/alternative.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # Several alternatives to declare GraphQL objects
+    module Alternative
+      extend ActiveSupport::Autoload
+
+      autoload :Query
+      autoload :Mutation
+      autoload :Subscription
+
+      autoload_at "#{__dir__}/alternative/field_set" do
+        autoload :FieldSet
+        autoload :MutationSet
+        autoload :SubscriptionSet
+      end
+    end
+  end
+end