rails-graphql 0.2.1 → 1.0.0.rc1

data/lib/rails/graphql/config.rb

@@ -1,61 +1,192 @@
 # 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 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
+
+      # If Rails cache is not properly defined or just set to use a NullStore,
+      # this fallback will set itself up with a memory store because cache is
+      # crucial, 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 is very similar to `ActiveRecord` verbose logs, which simply show the
+      # path of the file that started a GraphQL request.
       config.verbose_logs = true
 
-      # A list of ActiveRecord adapters and their specific internal naming used
-      # to compound the accessors for direct query serialization
+      # 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
+
+      # A list of all `ActiveRecord` adapters supported. When an adapter is
+      # supported, it will map the database types into GraphQL types using proper
+      # aliases. Plus, it will have the method to map models attributes to their
+      # equivalent fields.
       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+.
+      # 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 = false
+
+      # 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].
-      # If you prefer to use the normal hash to string serialization, you can
-      # disable this option.
+      # 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 dynamically inject argumnets to the
+      # 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 dynamically inject named argumnets
-      # to the calling method.
+      # Enable the ability of a callback to inject named arguments dynamically
+      # into the calling method.
       config.callback_inject_named_arguments = true
 
-      # A list of execution strategies. Each application can add their own by
-      # simply append a class name, preferable as string, in this list.
+      # 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 = false
+
+      # The list of scopes that will be used to locate the descriptions.
+      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 its own by
+      # appending a class, preferably as a string, in this list. This can also be
+      # set per Schema.
       config.request_strategies = [
         'Rails::GraphQL::Request::Strategy::MultiQueryStrategy',
         'Rails::GraphQL::Request::Strategy::SequencedStrategy',
+        # 'Rails::GraphQL::Request::Strategy::CachedStrategy',
+      ]
+
+      # A list of all possible ruby-to-graphql compatible sources.
+      config.sources = [
+        'Rails::GraphQL::Source::ActiveRecordSource',
+      ]
+
+      # A list of all available subscription providers.
+      config.subscription_providers = [
+        'Rails::GraphQL::Subscription::Provider::ActionCable',
       ]
 
+      # The default subscription provider for all schemas. This can also be set
+      # per Schema.
+      config.default_subscription_provider = config.subscription_providers.first
+
+      # The default value for fields about their ability to be broadcasted. This
+      # can also be set per Schema.
+      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 resources
+      # and allow users to enable 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",
+        },
+        enum:      {},
+        input:     {},
+        interface: {},
+        object:    {},
+        union:     {},
+        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. 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)
+
       # 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,8 @@ module Rails # :nodoc:
         When false, the underlying element will be automatically marked as null.
       DESC
 
-      on :attach do |source|
-        source.invalidate! unless args[:if]
+      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,8 @@ module Rails # :nodoc:
         When true, the underlying element will be automatically marked as null.
       DESC
 
-      on :attach do |source|
-        source.invalidate! if args[:if]
+      on(:attach) do |source|
+        source.skip! if args[:if]
       end
     end
   end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Rails
+  module GraphQL
+    # = GraphQL Spec Specified By Directive
+    #
+    # Provides a scalar specification URL for specifying the behavior of
+    # custom scalar types.
+    class Directive::SpecifiedByDirective < Directive
+      self.spec_object = true
+
+      placed_on :scalar
+
+      desc <<~DESC
+        A built-in directive used within the type system definition language to provide
+        a scalar specification URL for specifying the behavior of custom scalar types.
+      DESC
+
+      argument :url, :string, null: false, desc: <<~DESC
+        Point to a human-readable specification of the data format.
+      DESC
+    end
+  end
+end