rails-graphql 0.2.0 → 1.0.0.beta

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

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
-    module Collectors # :nodoc:
+module Rails
+  module GraphQL
+    module Collectors
+      # = GraphQL JSON Collector
+      #
       # This collector helps building a JSON response using the string approach,
       # which has better performance, since all the encoding is performed up
-      # front. The drawback is that it can't return an hash.
+      # front. The drawback is that it can't return a hash.
       class JsonCollector
         def initialize(request)
           @request = request
 
-          @current_value = String.new
+          @current_value = StringIO.new
           @stack_value = []
 
           @current_array = false
@@ -33,7 +35,7 @@ module Rails # :nodoc:
           raise
         end
 
-        # Append to the responsa data all the errors that happened during the
+        # Append to the response data all the errors that happened during the
         # request process.
         def append_errors(errors)
           return if errors.empty?
@@ -43,15 +45,12 @@ module Rails # :nodoc:
         # Add the given +value+ to the given +key+. Ensure to encode the value
         # before calling this function.
         def add(key, value)
-          (@current_value << ',') unless @current_value.blank?
+          (@current_value << ',') if @current_value.pos > 0
 
           if @current_array
             @current_value << value
           else
-            @current_value << '"'
-            @current_value << key.to_s
-            @current_value << '":'
-            @current_value << value.to_s
+            @current_value << '"' << +key.to_s << '"' << ':' << +value.to_s
           end
         end
 
@@ -68,31 +67,37 @@ module Rails # :nodoc:
         # Mark the start of a new element on the array.
         def next
           return unless @stack_array.last === :complex
-          (@stack_value.last << ',') unless @stack_value.last.blank?
+          (@stack_value.last << ',') if @stack_value.last.pos > 0
           @stack_value.last << to_s
-          @current_value = String.new
+          @current_value = StringIO.new
         end
 
         # Get the current result
         def to_s
-          @current_array ? "[#{@current_value}]" : "{#{@current_value}}"
+          if @current_array
+            +'[' << @current_value.string << ']'
+          else
+            +'{' << @current_value.string << '}'
+          end
         end
 
+        alias to_json to_s
+
         private
 
           # Start a new part of the collector. When set +as_array+, the result
-          # of the stack will be encolsed by +[]+.
+          # of the stack will be enclosed by +[]+.
           def start_stack(as_array = false, plain_array = false)
             @stack_value << @current_value
             @stack_array << @current_array
 
             if as_array && !plain_array
-              @stack_value << String.new
+              @stack_value << StringIO.new
               @stack_array << :complex
               as_array = false
             end
 
-            @current_value = String.new
+            @current_value = StringIO.new
             @current_array = as_array
           end
 

data/lib/rails/graphql/collectors.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
-    module Collectors # :nodoc:
+module Rails
+  module GraphQL
+    # All the possible collectors that uses the reverse visit approach
+    module Collectors
       extend ActiveSupport::Autoload
 
       autoload :HashCollector
       autoload :IdentedCollector
       autoload :JsonCollector
-
     end
   end
 end

data/lib/rails/graphql/config.rb

@@ -1,61 +1,176 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     configure do |config|
-      # This exposes the clean path from where a GraphQL request was started
+      # This helps to keep track of when things were cached and registered.
+      # Cached objects with mismatching versions needs to be upgraded or simply
+      # reloaded. A good way to use this is to set to the commit hash, but
+      # beware to stick to 8 characters.
+      config.version = nil
+
+      # This will be automatically mapped to +Rails.cache+. Manually setting
+      # this property means that the object in it complies with
+      # +ActiveSupport::Cache::Store+.
+      config.cache = nil
+
+      # If Rails cache is not properly defined, by default it is set to a
+      # NullStore, than fallback to this option to get a memory store because
+      # cache is extremely important, especially for subscriptions
+      config.cache_fallback = -> do
+        ::ActiveSupport::Cache::MemoryStore.new(max_prune_time: nil)
+      end
+
+      # This is the prefix key of all the cache entries for the GraphQL cached
+      # things.
+      config.cache_prefix = 'graphql/'
+
+      # The list of nested paths inside of the graphql folder that does not
+      # require to be in their own namespace.
+      config.paths = %w[directives fields sources enums inputs interfaces object
+        scalars unions].to_set
+
+      # This exposes the clean path from where a GraphQL request was started.
       config.verbose_logs = true
 
+      # The list of parameters to omit from logger when running a GraphQL
+      # request. Those values will be better displayed in the internal runtime
+      # logger controller.
+      config.omit_parameters = %w[query operationName operation_name variables graphql]
+
+      # This list will actually affect what is displayed in the logs. When it is
+      # set to nil, it will copy its value from Rails +filter_parameters+.
+      config.filter_parameters = nil
+
       # A list of ActiveRecord adapters and their specific internal naming used
-      # to compound the accessors for direct query serialization
+      # to compound the accessors for direct query serialization.
       config.ar_adapters = {
-        'Mysql2'     => :mysql,
-        'PostgreSQL' => :pg,
-        'SQLite'     => :sqlite,
+        'Mysql2'     => { key: :mysql,  path: "#{__dir__}/adapters/mysql_adapter" },
+        'PostgreSQL' => { key: :pg,     path: "#{__dir__}/adapters/pg_adapter" },
+        'SQLite'     => { key: :sqlite, path: "#{__dir__}/adapters/sqlite_adapter" },
       }
 
       # For all the input object type defined, auto add the following prefix to
       # their name, so we don't have to define classes like +PointInputInput+.
       config.auto_suffix_input_objects = 'Input'
 
+      # Introspection is enabled by default. Changing this will affect all the
+      # schemas off the application and reduce memory usage. This can also be
+      # set at per schema.
+      config.enable_introspection = true
+
+      # Define the names of the schema/operations types. The single "_" is a
+      # suggestion so that in an application that has, most likely, a
+      # Subscription type, it does not generate a conflict. Plus, it is easy to
+      # spot that it is something internal.
+      config.schema_type_names = {
+        query: '_Query',
+        mutation: '_Mutation',
+        subscription: '_Subscription',
+      }
+
       # For performance purposes, this gem implements a
       # {JsonCollector}[rdoc-ref:Rails::GraphQL::Collectors::JsonCollector].
       # If you prefer to use the normal hash to string serialization, you can
       # disable this option.
       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 console,
+      # it will automatically shift to hash.
+      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 dynamically inject argumnets to the
+      # Enable the ability of a callback to dynamically inject arguments to the
       # calling method.
       config.callback_inject_arguments = true
 
-      # Enable the ability of a callback to dynamically inject named argumnets
+      # Enable the ability of a callback to dynamically inject named arguments
       # to the calling method.
       config.callback_inject_named_arguments = true
 
+      # When importing fields into other places, if the given class is
+      # incompatible it will display an warning. This can make such warning be
+      # silenced.
+      config.silence_import_warnings = false
+
+      # Enable the ability to active custom descriptions using i18n
+      config.enable_i18n_descriptions = true
+
+      # Specify the scopes for I18n translations
+      config.i18n_scopes = [
+        'graphql.%{namespace}.%{kind}.%{parent}.%{name}',
+        'graphql.%{namespace}.%{kind}.%{name}',
+        'graphql.%{namespace}.%{name}',
+        'graphql.%{kind}.%{parent}.%{name}',
+        'graphql.%{kind}.%{name}',
+        'graphql.%{name}'
+      ]
+
       # A list of execution strategies. Each application can add their own by
       # simply append a class name, preferable as string, in this list.
       config.request_strategies = [
         'Rails::GraphQL::Request::Strategy::MultiQueryStrategy',
         'Rails::GraphQL::Request::Strategy::SequencedStrategy',
+        # 'Rails::GraphQL::Request::Strategy::CachedStrategy',
+      ]
+
+      # A list of all possible rails-graphql-compatible sources.
+      config.sources = [
+        'Rails::GraphQL::Source::ActiveRecordSource',
+      ]
+
+      # A list of all available subscription providers which bases on
+      # Rails::GraphQL::SubscriptionProvider::Base
+      config.subscription_providers = [
+        'Rails::GraphQL::Subscription::Provider::ActionCable',
       ]
 
+      # The default subscription provider for all the schemas
+      config.default_subscription_provider = config.subscription_providers.first
+
+      # The default value for fields about their ability of being broadcasted
+      config.default_subscription_broadcastable = nil
+
+      # A list of known dependencies that can be requested and included in any
+      # schema. This is the best place for other gems to add their own
+      # dependencies and allow users to pick them.
+      config.known_dependencies = {
+        scalar: {
+          any:       "#{__dir__}/type/scalar/any_scalar",
+          bigint:    "#{__dir__}/type/scalar/bigint_scalar",
+          binary:    "#{__dir__}/type/scalar/binary_scalar",
+          date_time: "#{__dir__}/type/scalar/date_time_scalar",
+          date:      "#{__dir__}/type/scalar/date_scalar",
+          decimal:   "#{__dir__}/type/scalar/decimal_scalar",
+          time:      "#{__dir__}/type/scalar/time_scalar",
+          json:      "#{__dir__}/type/scalar/json_scalar",
+        },
+        directive: {
+          # cached:    "#{__dir__}/directive/cached_directive",
+        },
+      }
+
+      # 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,
+      # to support keys without quotes, you can use +Psych.method(:safe_load)+,
+      # which behaves closer to YAML, but the received value is ensure to be
+      # wrapped in "{}". If that produces unexpected results, you can assign a
+      # proc and then parse the value in any other way, like
+      # +->(value) { anything }+
+      config.literal_input_parser = JSON.method(:parse)
+
       # TODO: To be implemented
-      # enable_i18n_descriptions
-      # enable_auto_descriptions
       # allow_query_serialization
-      # source_generate_dependencies
     end
 
     # This is the logger for all the operations for GraphQL
     def self.logger
-      config.logger ||= ActiveSupport::TaggedLogging.new(
-        ActiveSupport::Logger.new(STDOUT),
-      )
+      config.logger ||= ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
     end
   end
 end

data/lib/rails/graphql/directive/cached_directive.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # = GraphQL Cached Directive
+    #
+    # Indicates that the request has hard cached operations that need to be
+    # collected
+    class Directive::CachedDirective < Directive
+      placed_on :query
+
+      desc 'Indicates that there are hard cached operations.'
+
+      argument :id, :ID, null: false, desc: <<~DESC
+        The unique identifier of the cached operation.
+      DESC
+
+      on(:attach) do |source, request|
+        source.data.selection = nil
+        # TODO: Add the request name back
+        # source.instance_variable_set(:@name, 'here')
+
+        # TODO: Add the arguments and variables
+        field = request.build(Request::Component::Field, source, nil, { name: 'a', alias: 'b' })
+        field.assing_to(ApplicationSchema[:query][:a])
+        field.check_authorization!
+
+        source.instance_variable_set(:@selection, { 'b' => field })
+        # puts source.inspect
+      end
+    end
+  end
+end

data/lib/rails/graphql/directive/deprecated_directive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # = GraphQL Spec Deprecated Directive
     #
     # Mark fields or enum values as deprecated which will include an error
@@ -12,7 +12,7 @@ module Rails # :nodoc:
       placed_on :field_definition, :enum_value
 
       desc <<~DESC
-        Indicate deprecated portions of a GraphQL service’s schema, such as deprecated
+        Indicate deprecated portions of a GraphQL service's schema, such as deprecated
         fields on a type or deprecated enum values.
       DESC
 
@@ -22,11 +22,11 @@ module Rails # :nodoc:
         using Markdown syntax (as specified by [CommonMark](http://commonmark.org/)).
       DESC
 
-      on :organized do |event|
+      on(:organized) do |event|
         report_for_field(event)
       end
 
-      on :finalize, for: Type::Enum do |event|
+      on(:finalize, for: Type::Enum) do |event|
         report_for_enum_value(event)
       end
 
@@ -35,7 +35,7 @@ module Rails # :nodoc:
         # Check if the requested field is marked as deprecated
         def report_for_field(event)
           return unless event.field.using?(self.class)
-          item = "#{event.source.gql_name} field"
+          item = +"#{event.source.gql_name} field"
           event.request.report_error(build_message(item))
         end
 
@@ -44,15 +44,15 @@ module Rails # :nodoc:
           return unless event.current_value.deprecated?
 
           value = event.current_value.to_s
-          item = "#{value} value for the #{event.source.gql_name} field"
+          item = +"#{value} value for the #{event.source.gql_name} field"
           event.request.report_error(build_message(item))
         end
 
         # Build the error message to display on the result
         def build_message(item)
-          result = "The #{item} is deprecated"
-          result += ", reason: #{args.reason}" if args.reason.present?
-          result + '.'
+          result = +"The #{item} is deprecated"
+          result << ", reason: #{args.reason}" if args.reason.present?
+          result << '.'
         end
     end
   end

data/lib/rails/graphql/directive/include_directive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # = GraphQL Spec Include Directive
     #
     # Allow including fields only +if+ condition is true
@@ -16,8 +16,9 @@ module Rails # :nodoc:
         When false, the underlying element will be automatically marked as null.
       DESC
 
-      on :attach do |source|
-        source.invalidate! unless args[:if]
+      # TODO: On attach does not covers default value per operation variable scenario
+      on(:attach) do |source|
+        source.skip! unless args[:if]
       end
     end
   end

data/lib/rails/graphql/directive/skip_directive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rails # :nodoc:
-  module GraphQL # :nodoc:
+module Rails
+  module GraphQL
     # = GraphQL Spec Skip Directive
     #
     # Allow skipping fields given an +if+ condition
@@ -16,8 +16,9 @@ module Rails # :nodoc:
         When true, the underlying element will be automatically marked as null.
       DESC
 
-      on :attach do |source|
-        source.invalidate! if args[:if]
+      # TODO: On attach does not covers default value per operation variable scenario
+      on(:attach) do |source|
+        source.skip! if args[:if]
       end
     end
   end