rails-graphql 0.2.0 → 1.0.0.beta

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,36 @@
+# 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.inspect
+          +"#<#{self.class.name} @fields=#{fields.inspect}>"
+        end
+      end
+
+      # = GraphQL Alternative Mutation Set
+      #
+      # Same as a +FieldSet+ but for mutation fields
+      MutationSet = Class.new(FieldSet)
+      MutationSet.field_type = Field::MutationField
+
+      # = GraphQL Alternative Subscription Set
+      #
+      # Same as a +FieldSet+ but for subscription fields
+      SubscriptionSet = Class.new(FieldSet)
+      SubscriptionSet.field_type = Field::SubscriptionField
+    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,93 @@
+# 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, &blcok)
+            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, &blcok)
+          end
+
+          # Import the field from a given source
+          def import_field(other_field, **xargs, &blcok)
+            @field = other_field.to_proxy(**xargs, owner: self, &blcok)
+          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
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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, 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

data/lib/rails/graphql/argument.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # = GraphQL Argument
     #
     # This represents an item from the ArgumentsDefinition, which was supposed
@@ -31,6 +31,7 @@ module Rails # :nodoc:
     #   (defaults to nil).
     class Argument
       include Helpers::WithValidator
+      include Helpers::WithDescription
 
       # TODO: When arguments are attached to output fields they can have
       # directives so add this possibility
@@ -67,7 +68,8 @@ module Rails # :nodoc:
         @nullable = full ? false : nullable
 
         @default = default
-        @desc = desc&.strip_heredoc&.chomp
+        @default = deserialize(@default) if @default.is_a?(::GQLParser::Token)
+        self.description = desc
       end
 
       def initialize_copy(*)
@@ -114,14 +116,9 @@ module Rails # :nodoc:
         !!@nullable
       end
 
-      # Return the description of the argument
-      def description
-        @desc
-      end
-
-      # Checks if a description was provided
-      def description?
-        !!@desc
+      # Override to add the kind
+      def description(namespace = nil, *)
+        super(namespace || owner.try(:namespaces), :argument)
       end
 
       # Checks if a given default value was provided
@@ -149,7 +146,7 @@ module Rails # :nodoc:
 
       # Turn the given value into a ruby object through deserialization
       def deserialize(value = nil)
-        value = @default if value.nil?
+        value = as_json if value.nil?
 
         return if value.nil?
         return type_klass.deserialize(value) unless array?
@@ -174,19 +171,19 @@ module Rails # :nodoc:
       def validate!(*)
         super if defined? super
 
-        raise NameError, <<~MSG.squish if gql_name.start_with?('__')
+        raise NameError, (+<<~MSG).squish if gql_name.start_with?('__')
           The name "#{gql_name}" is invalid. Argument names cannot start with "__".
         MSG
 
-        raise ArgumentError, <<~MSG.squish unless type_klass.is_a?(Module)
+        raise ArgumentError, (+<<~MSG).squish unless type_klass.is_a?(Module)
           Unable to find the "#{type.inspect}" input type on GraphQL context.
         MSG
 
-        raise ArgumentError, <<~MSG.squish unless type_klass.input_type?
+        raise ArgumentError, (+<<~MSG).squish unless type_klass.input_type?
           The "#{type_klass.gql_name}" is not a valid input type.
         MSG
 
-        raise ArgumentError, <<~MSG.squish unless default.nil? || valid?(default)
+        raise ArgumentError, (+<<~MSG).squish unless default.nil? || valid?(as_json(default))
           The given default value "#{default.inspect}" is not valid for this argument.
         MSG
       end
@@ -198,14 +195,14 @@ module Rails # :nodoc:
 
       alias_method :&, :+
 
-      def inspect # :nodoc:
-        result = "#{name}: "
-        result += '[' if array?
-        result += type_klass.gql_name
-        result += '!' if array? && !nullable?
-        result += ']' if array?
-        result += '!' unless null?
-        result += " = #{to_hash.inspect}" if default_value?
+      def inspect
+        result = +"#{name}: "
+        result << '[' if array?
+        result << type_klass.gql_name
+        result << '!' if array? && !nullable?
+        result << ']' if array?
+        result << '!' unless null?
+        result << " = #{as_json.inspect}" if default_value?
         result
       end
 

data/lib/rails/graphql/callback.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # = Rails GraphQL Callback
     #
     # An extra powerfull proc that can handle way more situations than the
     # original block caller
     class Callback
+      EXCLUSIVE_ARGUMENT = :exclusive_callback
+
       attr_reader :event_name, :block, :target, :filters
 
       delegate :event_filters, to: :target
@@ -19,7 +21,7 @@ module Rails # :nodoc:
       end
 
       def initialize(target, event_name, *args, **xargs, &block)
-        raise ::ArgumentError, <<~MSG.squish if block.nil? && !args.first.present?
+        raise ::ArgumentError, (+<<~MSG).squish if block.nil? && !args.first.present?
           Either provide a block or a method name when setting a #{event_name}
           callback on #{target.inspect}.
         MSG
@@ -27,7 +29,7 @@ module Rails # :nodoc:
         if block.nil?
           block = args.shift
           valid_format = block.is_a?(Symbol) || block.is_a?(Proc)
-          raise ::ArgumentError, <<~MSG.squish unless valid_format
+          raise ::ArgumentError, (+<<~MSG).squish unless valid_format
             The given #{block.class.name} class is not a valid callback.
           MSG
         end
@@ -35,11 +37,13 @@ module Rails # :nodoc:
         @target = target
         @event_name = event_name
 
+        @exclusive = xargs.delete(EXCLUSIVE_ARGUMENT)
+        @exclusive = target.try(:default_exclusive?, event_name) if @exclusive.nil?
+        @exclusive = true if @exclusive.nil?
+
         @pre_args = args
         @pre_xargs = xargs.slice!(*event_filters.keys)
-        @filters = xargs.map do |key, value|
-          [key, event_filters[key][:sanitizer]&.call(value) || value]
-        end.to_h
+        @filters = xargs
 
         @block = block
       end
@@ -54,10 +58,16 @@ module Rails # :nodoc:
           : call_proc(event, _callback_context, *args, **xargs)
       end
 
+      # Return if this event is exclusive, so that only the original source of
+      # the callback will be allowed to receive it
+      def exclusive?
+        @exclusive
+      end
+
       # Get a described source location for the callback
       def source_location
         block.is_a?(Proc) ? block.source_location : [
-          "(symbolized-callback/#{target.inspect})",
+          +"(symbolized-callback/#{target.inspect})",
           block,
         ]
       end
@@ -80,10 +90,15 @@ module Rails # :nodoc:
 
         # Using the filters, check if the current callback can be executed
         def can_run?(event)
-          filters.all? { |key, options| event_filters[key][:block].call(options, event) }
+          return false if exclusive? && !event.same_source?(target)
+
+          filters.all? do |key, options|
+            target.instance_exec(options, event, &event_filters[key])
+          end
         end
 
         # Call the callback block as a symbol
+        # TODO: Maybe black calling non-public events
         def call_symbol(event, *args, **xargs)
           event.on_instance(owner) do |instance|
             block = instance.method(@block)

data/lib/rails/graphql/collectors/hash_collector.rb

@@ -1,6 +1,10 @@
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
-    module Collectors # :nodoc:
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    module Collectors
+      # = GraphQL Hash Collector
+      #
       # This collector helps building a JSON response using the hash approach,
       # where the value is kept as an hash and later turn into a string
       class HashCollector
@@ -24,7 +28,7 @@ module Rails # :nodoc:
 
         # Add the given +value+ to the given +key+.
         def add(key, value)
-          @data.is_a?(Array) ? @data << value : @data[key.to_s] = value
+          @data.is_a?(::Array) ? @data << value : @data[key.to_s] = value
         end
 
         alias safe_add add
@@ -36,7 +40,7 @@ module Rails # :nodoc:
 
         # Mark the start of a new element on the array.
         def next
-          return unless @stack.last.is_a?(Array)
+          return unless @stack.last.is_a?(::Array)
           @stack.last << @data
           @data = {}
         end
@@ -45,7 +49,7 @@ module Rails # :nodoc:
         # request process
         def append_errors(errors)
           return if errors.empty?
-          @data['errors'] = errors.to_a
+          @data['errors'] = errors.as_json
         end
 
         # Return the generated object
@@ -53,6 +57,8 @@ module Rails # :nodoc:
           @data
         end
 
+        alias as_json to_h
+
         # Generate the JSON string result
         def to_s
           GraphQL.config.encode_with_active_support? \
@@ -60,6 +66,8 @@ module Rails # :nodoc:
             : ::JSON.generate(@data)
         end
 
+        alias to_json to_s
+
         private
 
           # Start a new part of the collector. When set +as_array+, the result

data/lib/rails/graphql/collectors/idented_collector.rb

@@ -1,11 +1,14 @@
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
-    module Collectors # :nodoc:
-      # This collector helps building a indented string
+module Rails
+  module GraphQL
+    module Collectors
+      # = GraphQL Idented Collector
+      #
+      # This collector helps building a indented string, most used for
+      # displaying a GraphQL schema
       class IdentedCollector
         def initialize(initial = 0, size = 2, auto_eol: true)
           @size = size
-          @val = [[initial, '']]
+          @val = [[initial, +'']]
           @auto_eol = auto_eol
         end
 
@@ -50,13 +53,13 @@ module Rails # :nodoc:
 
         def indent
           return @val.last[0] += @size if blank?
-          @val << [last_ident + @size, '']
+          @val << [last_ident + @size, +'']
           self
         end
 
         def unindent
           return @val.last[0] -= @size if blank?
-          @val << [last_ident - @size, '']
+          @val << [last_ident - @size, +'']
           self
         end