hq-graphql 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4f7f2421a64474e031ddd0a97ef63d36c03218fdfc51bf759f0f1150e1ae5cb
-  data.tar.gz: 19addd42ac2c2f4bae1b985cacbda91998a3616b71f2e9923e19e89e8937d111
+  metadata.gz: e2508bf165d504937a9ea21ecc4b463e98e75c4e0d1ae12156df59ed649e4c2d
+  data.tar.gz: 07c40cac0b734c307953864ba415700b0a5dad4769d48e168361449cbe3e3a8e
 SHA512:
-  metadata.gz: '0777580cb64e038700a3d16e6a20ef1883fe5d39575a7d7db13df5e64950bf263946581463546b6dfe53ec4aab262a07cc9114896c7755c1aaf2428e3a81c22a'
-  data.tar.gz: e51c0b4555486894697b81420264f6abd515bb81eeeff5df4869b0a3ebb46430e6a20a3c5179e4a6d1b32e930e7253e2706377dc127394b8a66d53831986a3da
+  metadata.gz: 8c7d4b1e507b25c0288a55387c183079e2dfbe8fec512a15c09d47f1352ed14655dd2507f86f996848a7bf4513969d59fa16f6df8b873ce74488867b31a9832e
+  data.tar.gz: 86c8781c2e074dc2d6882144d8604f33d11cd943f1e3effe0949c5efb8ee26ee9b687c697e2e30e146a7651b41f31252b7ff7bfeb237ff331a917a8aba02e798

data/lib/hq/graphql/field/association_loader.rb

@@ -0,0 +1,27 @@
+# typed: false
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    module Field
+      class AssociationLoader < ::GraphQL::Schema::Field
+        attr_reader :loader_klass
+
+        def initialize(*args, loader_klass: nil, **options, &block)
+          super(*args, **options, &block)
+          @loader_klass = loader_klass
+        end
+
+        def resolve_field(object, args, ctx)
+          if loader_klass.present? && !!::GraphQL::Batch::Executor.current && object.object
+            Loaders::Association.for(loader_klass.constantize, original_name).load(object.object).then do
+              super
+            end
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/field.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# typed: strict
+require "hq/graphql/field/association_loader"

data/lib/hq/graphql/loaders/association.rb

@@ -0,0 +1,52 @@
+# typed: false
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    module Loaders
+      class Association < ::GraphQL::Batch::Loader
+        def initialize(model, association_name)
+          @model = model
+          @association_name = association_name
+          validate
+        end
+
+        def load(record)
+          raise TypeError, "#{@model} loader can't load association for #{record.class}" unless record.is_a?(@model)
+          return Promise.resolve(read_association(record)) if association_loaded?(record)
+          super
+        end
+
+        # We want to load the associations on all records, even if they have the same id
+        def cache_key(record)
+          record.object_id
+        end
+
+        def perform(records)
+          preload_association(records)
+          records.each { |record| fulfill(record, read_association(record)) }
+        end
+
+        private
+
+        def validate
+          unless @model.reflect_on_association(@association_name)
+            raise ArgumentError, "No association #{@association_name} on #{@model}"
+          end
+        end
+
+        def preload_association(records)
+          ::ActiveRecord::Associations::Preloader.new.preload(records, @association_name)
+        end
+
+        def read_association(record)
+          record.public_send(@association_name)
+        end
+
+        def association_loaded?(record)
+          record.association(@association_name).loaded?
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/loaders.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# typed: strict
+require "hq/graphql/loaders/association"

data/lib/hq/graphql/object.rb

@@ -7,18 +7,20 @@ module HQ
       include Scalars
       include ::HQ::GraphQL::ActiveRecordExtensions
 
-      def self.with_model(model_name, attributes: true, associations: true)
+      field_class ::HQ::GraphQL::Field::AssociationLoader
+
+      def self.with_model(model_name, attributes: true, associations: true, auto_nil: true)
         self.model_name = model_name
         self.auto_load_attributes = attributes
         self.auto_load_associations = associations
 
         lazy_load do
           model_columns.each do |column|
-            field_from_column(column)
+            field_from_column(column, auto_nil: auto_nil)
           end
 
           model_associations.each do |association|
-            field_from_association association
+            field_from_association(association, auto_nil: auto_nil)
           end
         end
       end
@@ -31,21 +33,28 @@ module HQ
       class << self
         private
 
-        def field_from_association(association)
+        def field_from_association(association, auto_nil:)
           type = ::HQ::GraphQL::Types[association.klass]
           name = association.name
           case association.macro
           when :has_many
-            field name, [type], null: false
+            field name, [type], null: false, loader_klass: model_name
           else
-            field name, type, null: true
+            field name, type, null: !auto_nil || !association_required?(association), loader_klass: model_name
           end
         rescue ::HQ::GraphQL::Types::Error
           nil
         end
 
-        def field_from_column(column)
-          field column.name, ::HQ::GraphQL::Types.type_from_column(column), null: true
+        def field_from_column(column, auto_nil:)
+          field column.name, ::HQ::GraphQL::Types.type_from_column(column), null: !auto_nil || column.null
+        end
+
+        def association_required?(association)
+          !association.options[:optional] || model_klass.validators.any? do |validation|
+            next unless validation.class == ActiveRecord::Validations::PresenceValidator
+            validation.attributes.any? { |a| a.to_s == association.name.to_s }
+          end
         end
       end
     end

data/lib/hq/graphql/resource/mutation.rb

@@ -5,13 +5,13 @@ module HQ
   module GraphQL
     module Resource
       module Mutation
-        def self.build(model_name, graphql_name:, require_primary_key: false, &block)
+        def self.build(model_name, graphql_name:, require_primary_key: false, show_copy: false, &block)
           Class.new(::HQ::GraphQL::Mutation) do
             graphql_name graphql_name
 
             lazy_load do
               field :errors, ::HQ::GraphQL::Types::Object, null: false
-              field :resource, ::HQ::GraphQL::Types[model_name], null: true
+              field :resource, ::HQ::GraphQL::Types[model_name, show_copy], null: true
             end
 
             instance_eval(&block)

data/lib/hq/graphql/resource.rb

@@ -53,6 +53,10 @@ module HQ
           @input_klass ||= build_input_object
         end
 
+        def input_result_klass
+          @input_result_klass ||= build_graphql_object(name: "#{graphql_name}Copy", auto_nil: false)
+        end
+
         def query_klass
           @query_klass ||= build_graphql_object
         end
@@ -67,6 +71,10 @@ module HQ
           @input_klass = build_input_object(**options, &block)
         end
 
+        def input_result(**options, &block)
+          @input_result_klass = build_graphql_object(name: "#{graphql_name}Copy", **options, auto_nil: false, &block)
+        end
+
         def mutations(create: true, copy: true, update: true, destroy: true)
           scoped_graphql_name = graphql_name
           scoped_model_name = model_name
@@ -102,7 +110,8 @@ module HQ
             copy_mutation = ::HQ::GraphQL::Resource::Mutation.build(
               model_name,
               graphql_name: "#{scoped_graphql_name}Copy",
-              require_primary_key: true
+              require_primary_key: true,
+              show_copy: true
             ) do
               define_method(:resolve) do |**args|
                 resource = scoped_self.find_record(args, context)
@@ -251,8 +260,8 @@ module HQ
 
         private
 
-        def build_graphql_object(**options, &block)
-          scoped_graphql_name = graphql_name
+        def build_graphql_object(name: graphql_name, **options, &block)
+          scoped_graphql_name = name
           scoped_model_name = model_name
           Class.new(::HQ::GraphQL::Object) do
             graphql_name scoped_graphql_name

data/lib/hq/graphql/scalars.rb

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: strict
 # frozen_string_literal: true
 
 require "hq/graphql/types/object"

data/lib/hq/graphql/types.rb

@@ -8,11 +8,12 @@ module HQ
         MISSING_TYPE_MSG = "The GraphQL type for `%{klass}` is missing."
       end
 
-      def self.[](key)
-        @types ||= Hash.new do |hash, klass|
-          hash[klass] = klass_for(klass)
+      def self.[](key, *args)
+        @types ||= Hash.new do |hash, options|
+          klass, show_copy = Array(options)
+          hash[klass] = show_copy ? copy_klass(klass) : klass_for(klass)
         end
-        @types[key]
+        @types[[key, *args]]
       end
 
       def self.type_from_column(column)
@@ -43,10 +44,18 @@ module HQ
       class << self
         private
 
+        def copy_klass(klass_or_string)
+          find_klass(klass_or_string, :input_result_klass)
+        end
+
         def klass_for(klass_or_string)
+          find_klass(klass_or_string, :query_klass)
+        end
+
+        def find_klass(klass_or_string, method)
           klass = klass_or_string.is_a?(String) ? klass_or_string.constantize : klass_or_string
-          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass }&.query_klass ||
-          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass.base_class }&.query_klass ||
+          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass }&.send(method) ||
+          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass.base_class }&.send(method) ||
              raise(Error, Error::MISSING_TYPE_MSG % { klass: klass.name })
         end
       end

data/lib/hq/graphql/version.rb

@@ -3,6 +3,6 @@
 
 module HQ
   module GraphQL
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

data/lib/hq/graphql.rb

@@ -3,6 +3,7 @@
 
 require "rails"
 require "graphql"
+require "graphql/batch"
 require "sorbet-runtime"
 require "hq/graphql/config"
 
@@ -49,8 +50,10 @@ end
 require "hq/graphql/active_record_extensions"
 require "hq/graphql/scalars"
 
+require "hq/graphql/field"
 require "hq/graphql/inputs"
 require "hq/graphql/input_object"
+require "hq/graphql/loaders"
 require "hq/graphql/mutation"
 require "hq/graphql/object"
 require "hq/graphql/resource"

data/lib/hq-graphql.rb

@@ -2,6 +2,6 @@
 # rubocop:enable Naming/FileName
 # frozen_string_literal: true
 
-# typed: strong
+# typed: strict
 
 require "hq/graphql"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Danny Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.6
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -241,8 +255,12 @@ files:
 - lib/hq/graphql/active_record_extensions.rb
 - lib/hq/graphql/config.rb
 - lib/hq/graphql/engine.rb
+- lib/hq/graphql/field.rb
+- lib/hq/graphql/field/association_loader.rb
 - lib/hq/graphql/input_object.rb
 - lib/hq/graphql/inputs.rb
+- lib/hq/graphql/loaders.rb
+- lib/hq/graphql/loaders/association.rb
 - lib/hq/graphql/mutation.rb
 - lib/hq/graphql/object.rb
 - lib/hq/graphql/resource.rb