hq-graphql 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05c40fc2e6eaccc1277c1b6f36b19983af507721b011d6d25c9010f877c18db7
-  data.tar.gz: cf67ac6f3d02f3c6a5c5b0f1124e8aacd706d1e30b0077af69cad336d5dc1475
+  metadata.gz: 5aefcd1b96fb05c456ebdef007f9bcad196e7aba2cd864d6dd7c83f3b3fbc95c
+  data.tar.gz: 0173c91a781e4872cbf65c597f3266030850c8e0ba31b05d8f9b578f11263216
 SHA512:
-  metadata.gz: 2f643af54cb80d2325dc8829c620f9c4d0c48a950aced92cb0313b2aacba52a3b797f42deb0c1f8848b9454cf70d014c4795f64d5e34444d87cc4fdbe36702c8
-  data.tar.gz: df55f4034030bed0f035a170d581bfe030f62a2545b2f4b7d15d48838c9777a7e4aa357e5f86618ee7bb692ba001c263df9973f8e546f8a1a902d0e8f61d4821
+  metadata.gz: 8a7b74ef1631a0d98004beb6bec61ea6898994c3ff25366afbc1fa5ba47bc60e36061ea3875c655ecfc9ac088b5f809b28fb411c05bfaeeda4e7256742345d5e
+  data.tar.gz: 3f6ecdc50f8a59d0e4c5c204fe4ed5967064e82f0f4a9aa961277532d6a49be5fb534204fa03a928777133e1b9541ec86fd2f9b196c383ff9da2ce1c94736cdc

data/lib/hq/graphql.rb

@@ -64,7 +64,6 @@ module HQ
   end
 end
 
-require "hq/graphql/active_record_extensions"
 require "hq/graphql/association_loader"
 require "hq/graphql/scalars"
 require "hq/graphql/comparator"

data/lib/hq/graphql/enum.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hq/graphql/types"
+
 module HQ::GraphQL
   class Enum < ::GraphQL::Schema::Enum
     ## Auto generate enums from the database using ActiveRecord
@@ -73,6 +75,3 @@ module HQ::GraphQL
     end
   end
 end
-
-require "hq/graphql/enum/sort_by"
-require "hq/graphql/enum/sort_order"

data/lib/hq/graphql/enum/sort_by.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hq/graphql/enum"
+
 module HQ
   class GraphQL::Enum::SortBy < ::HQ::GraphQL::Enum
     value "CreatedAt", value: :created_at

data/lib/hq/graphql/enum/sort_order.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hq/graphql/enum"
+
 module HQ
   class GraphQL::Enum::SortOrder < ::HQ::GraphQL::Enum
     value "ASC", value: :asc

data/lib/hq/graphql/field.rb

@@ -9,7 +9,15 @@ module HQ
         super(*args, **options, &block)
         @authorize_action = authorize_action
         @authorize = authorize
-        @class_name = klass
+        @klass_or_string = klass
+      end
+
+      def scope(&block)
+        if block
+          @scope = block
+        else
+          @scope
+        end
       end
 
       def authorized?(object, ctx)
@@ -18,35 +26,8 @@ module HQ
           ::HQ::GraphQL.authorize_field(authorize_action, self, object, ctx)
       end
 
-      def resolve_field(object, args, ctx)
-        if klass.present? && !!::GraphQL::Batch::Executor.current && object.object
-          loader =
-            if ::HQ::GraphQL.use_experimental_associations?
-              limit       = args[:limit]
-              offset      = args[:offset]
-              sort_by     = args[:sortBy]
-              sort_order  = args[:sortOrder]
-
-              PaginatedAssociationLoader.for(
-                klass,
-                original_name,
-                limit: limit,
-                offset: offset,
-                sort_by: sort_by,
-                sort_order: sort_order
-              )
-            else
-              AssociationLoader.for(klass, original_name)
-            end
-
-          loader.load(object.object)
-        else
-          super
-        end
-      end
-
       def klass
-        @klass ||= @class_name&.constantize
+        @klass ||= @klass_or_string.is_a?(String) ? @klass_or_string.constantize : @klass_or_string
       end
     end
   end

data/lib/hq/graphql/field_extension/association_loader_extension.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "hq/graphql/association_loader"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class AssociationLoaderExtension < ::GraphQL::Schema::FieldExtension
+        def resolve(object:, **_kwargs)
+          AssociationLoader.for(options[:klass], field.original_name).load(object.object)
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/field_extension/paginated_arguments.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "hq/graphql/enum/sort_by"
+require "hq/graphql/enum/sort_order"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class PaginatedArguments < ::GraphQL::Schema::FieldExtension
+        def apply
+          field.argument :offset, Integer, required: false
+          field.argument :limit, Integer, required: false
+          field.argument :sort_order, Enum::SortOrder, required: false
+
+          resource = ::HQ::GraphQL.lookup_resource(options[:klass])
+          enum = resource ? resource.sort_fields_enum : ::HQ::GraphQL::Enum::SortBy
+          field.argument :sort_by, enum, required: false
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/field_extension/paginated_loader.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "hq/graphql/paginated_association_loader"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class PaginatedLoader < ::GraphQL::Schema::FieldExtension
+        def resolve(object:, arguments:, **_options)
+          limit       = arguments[:limit]
+          offset      = arguments[:offset]
+          sort_by     = arguments[:sort_by]
+          sort_order  = arguments[:sort_order]
+          scope       = field.scope.call(**arguments.except(:limit, :offset, :sort_by, :sort_order)) if field.scope
+          loader      = PaginatedAssociationLoader.for(
+            klass,
+            association,
+            internal_association: internal_association,
+            scope:                scope,
+            limit:                limit,
+            offset:               offset,
+            sort_by:              sort_by,
+            sort_order:           sort_order
+          )
+
+          loader.load(object.object)
+        end
+
+        private
+
+        def association
+          options[:association]
+        end
+
+        def internal_association
+          options[:internal_association]
+        end
+
+        def klass
+          options[:klass]
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/input_object.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "hq/graphql/active_record_extensions"
+require "hq/graphql/inputs"
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     class InputObject < ::GraphQL::Schema::InputObject

data/lib/hq/graphql/object.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
+require "hq/graphql/active_record_extensions"
+require "hq/graphql/field"
+require "hq/graphql/field_extension/association_loader_extension"
+require "hq/graphql/field_extension/paginated_arguments"
+require "hq/graphql/field_extension/paginated_loader"
+require "hq/graphql/object_association"
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     class Object < ::GraphQL::Schema::Object
       include Scalars
-      include ::HQ::GraphQL::ActiveRecordExtensions
+      include ActiveRecordExtensions
+      extend ObjectAssociation
 
-      field_class ::HQ::GraphQL::Field
+      field_class Field
 
       def self.authorize_action(action)
         self.authorized_action = action
@@ -28,8 +37,15 @@ module HQ
           end
 
           model_associations.each do |association|
+            next if resource_reflections[association.name.to_s]
             field_from_association(association, auto_nil: auto_nil)
           end
+
+          resource_reflections.values.each do |resource_reflection|
+            reflection = resource_reflection.reflection(model_klass)
+            next unless reflection
+            field_from_association(reflection, auto_nil: auto_nil, internal_association: true, &resource_reflection.block)
+          end
         end
       end
 
@@ -46,32 +62,36 @@ module HQ
           @authorized_action ||= :read
         end
 
-        def field_from_association(association, auto_nil:)
+        def field_from_association(association, auto_nil:, internal_association: false, &block)
           # The PaginationAssociationLoader doesn't support through associations yet
           return if association.through_reflection? && ::HQ::GraphQL.use_experimental_associations?
 
           association_klass = association.klass
-          type = ::HQ::GraphQL::Types[association_klass]
-          name = association.name
+          name              = association.name
+          klass             = model_klass
+          type              = Types[association_klass]
           case association.macro
           when :has_many
             field name, [type], null: false, klass: model_name do
-              if ::HQ::GraphQL.use_experimental_associations? && (resource = ::HQ::GraphQL.lookup_resource(association_klass))
-                argument :offset, Integer, required: false
-                argument :limit, Integer, required: false
-                argument :sort_by, resource.sort_fields_enum, required: false
-                argument :sort_order, Enum::SortOrder, required: false
+              if ::HQ::GraphQL.use_experimental_associations?
+                extension FieldExtension::PaginatedArguments, klass: association_klass
+                extension FieldExtension::PaginatedLoader, klass: klass, association: name, internal_association: internal_association
+              else
+                extension FieldExtension::AssociationLoaderExtension, klass: klass
               end
+              instance_eval(&block) if block
             end
           else
-            field name, type, null: !auto_nil || !association_required?(association), klass: model_name
+            field name, type, null: !auto_nil || !association_required?(association), klass: model_name do
+              extension FieldExtension::AssociationLoaderExtension, klass: klass
+            end
           end
-        rescue ::HQ::GraphQL::Types::Error
+        rescue Types::Error
           nil
         end
 
         def field_from_column(column, auto_nil:)
-          field column.name, ::HQ::GraphQL::Types.type_from_column(column), null: !auto_nil || column.null
+          field column.name, Types.type_from_column(column), null: !auto_nil || column.null
         end
 
         def association_required?(association)

data/lib/hq/graphql/object_association.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    module ObjectAssociation
+      class ResourceReflection
+        attr_reader :name, :scope, :options, :macro, :block
+
+        def initialize(name, scope, options, macro, block)
+          @name = name
+          @scope = scope
+          @options = options
+          @macro = macro
+          @block = block
+        end
+
+        def reflection(model_klass)
+          if macro == :has_many
+            ::ActiveRecord::Associations::Builder::HasMany.create_reflection(model_klass, name, scope, options)
+          elsif macro == :belongs_to
+            ::ActiveRecord::Associations::Builder::BelongsTo.create_reflection(model_klass, name, scope, options)
+          end
+        end
+      end
+
+      def reflect_on_association(association)
+        resource_reflections[association.to_s]&.reflection(model_klass)
+      end
+
+      def belongs_to(name, scope = nil, **options, &block)
+        add_reflection(name, scope, options, :belongs_to, block)
+      end
+
+      def has_many(name, scope = nil, through: nil, **options, &block)
+        raise TypeError, "has_many through is unsupported" if through
+        add_reflection(name, scope, options, :has_many, block)
+      end
+
+      private
+
+      def resource_reflections
+        @resource_reflections ||= {}
+      end
+
+      def add_reflection(name, scope, options, macro, block)
+        resource_reflections[name.to_s] = ResourceReflection.new(name, scope, options, macro, block)
+      end
+    end
+  end
+end

data/lib/hq/graphql/paginated_association_loader.rb

@@ -1,15 +1,30 @@
 # frozen_string_literal: true
 
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     class PaginatedAssociationLoader < ::GraphQL::Batch::Loader
-      def initialize(model, association_name, limit: nil, offset: nil, sort_by: nil, sort_order: nil)
-        @model            = model
-        @association_name = association_name
-        @limit            = [0, limit].max if limit
-        @offset           = [0, offset].max if offset
-        @sort_by          = sort_by || :updated_at
-        @sort_order       = normalize_sort_order(sort_order)
+      def self.for(*args, scope: nil, **kwargs)
+        if scope
+          raise TypeError, "scope must be an ActiveRecord::Relation" unless scope.is_a?(::ActiveRecord::Relation)
+          executor = ::GraphQL::Batch::Executor.current
+          loader_key = loader_key_for(*args, **kwargs, scope: scope.to_sql)
+          executor.loader(loader_key) { new(*args, **kwargs, scope: scope) }
+        else
+          super
+        end
+      end
+
+      def initialize(model, association_name, internal_association: false, limit: nil, offset: nil, scope: nil, sort_by: nil, sort_order: nil)
+        @model                = model
+        @association_name     = association_name
+        @internal_association = internal_association
+        @limit                = [0, limit].max if limit
+        @offset               = [0, offset].max if offset
+        @scope                = scope
+        @sort_by              = sort_by || :updated_at
+        @sort_order           = normalize_sort_order(sort_order)
 
         validate!
       end
@@ -95,6 +110,7 @@ module HQ
         scope = association_class
         scope = association.scopes.reduce(scope, &:merge)
         scope = association_class.default_scopes.reduce(scope, &:merge)
+        scope = scope.merge(@scope) if @scope
         scope
       end
 
@@ -107,7 +123,11 @@ module HQ
       end
 
       def association
-        @model.reflect_on_association(@association_name)
+        if @internal_association
+          Types[@model].reflect_on_association(@association_name)
+        else
+          @model.reflect_on_association(@association_name)
+        end
       end
 
       def association_class

data/lib/hq/graphql/resource.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
+require "hq/graphql/enum/sort_by"
+require "hq/graphql/field_extension/paginated_arguments"
+require "hq/graphql/input_object"
+require "hq/graphql/object"
 require "hq/graphql/resource/auto_mutation"
+require "hq/graphql/scalars"
 
 module HQ
   module GraphQL
@@ -18,24 +23,6 @@ module HQ
 
         attr_writer :graphql_name, :model_name
 
-        def sort_fields(*fields)
-          self.sort_fields_enum = fields
-        end
-
-        def sort_fields_enum
-          @sort_fields_enum || ::HQ::GraphQL::Enum::SortBy
-        end
-
-        def sort_fields_enum=(fields)
-          @sort_fields_enum ||= Class.new(::HQ::GraphQL::Enum::SortBy).tap do |c|
-            c.graphql_name "#{graphql_name}Sort"
-          end
-
-          Array(fields).each do |field|
-            @sort_fields_enum.value field.to_s.classify, value: field
-          end
-        end
-
         def scope(context)
           scope = model_klass
           scope = ::HQ::GraphQL.default_scope(scope, context)
@@ -80,6 +67,10 @@ module HQ
           @query_klass ||= build_graphql_object
         end
 
+        def sort_fields_enum
+          @sort_fields_enum || ::HQ::GraphQL::Enum::SortBy
+        end
+
         protected
 
         def default_scope(&block)
@@ -101,6 +92,10 @@ module HQ
           @query_klass = build_graphql_object(**options, &block)
         end
 
+        def sort_fields(*fields)
+          self.sort_fields_enum = fields
+        end
+
         def def_root(field_name, is_array: false, null: true, &block)
           resource = self
           resolver = -> {
@@ -134,12 +129,7 @@ module HQ
 
           if find_all
             def_root field_name.pluralize, is_array: true, null: false do
-              if pagination
-                argument :offset, Integer, required: false
-                argument :limit, Integer, required: false
-              end
-              argument :sort_by, scoped_self.sort_fields_enum, required: false
-              argument :sort_order, Enum::SortOrder, required: false
+              extension FieldExtension::PaginatedArguments, klass: scoped_self.model_klass if pagination
 
               define_method(:resolve) do |limit: nil, offset: nil, sort_by: nil, sort_order: nil, **_attrs|
                 scope = scoped_self.scope(context).all
@@ -186,6 +176,16 @@ module HQ
             class_eval(&block) if block
           end
         end
+
+        def sort_fields_enum=(fields)
+          @sort_fields_enum ||= Class.new(::HQ::GraphQL::Enum::SortBy).tap do |c|
+            c.graphql_name "#{graphql_name}Sort"
+          end
+
+          Array(fields).each do |field|
+            @sort_fields_enum.value field.to_s.classify, value: field
+          end
+        end
       end
     end
   end

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

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "hq/graphql/inputs"
+require "hq/graphql/mutation"
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     module Resource

data/lib/hq/graphql/types.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "hq/graphql/types/object"
+require "hq/graphql/types/uuid"
+
 module HQ
   module GraphQL
     module Types

data/lib/hq/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module HQ
   module GraphQL
-    VERSION = "2.1.0"
+    VERSION = "2.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Danny Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -255,10 +255,14 @@ files:
 - lib/hq/graphql/enum/sort_by.rb
 - lib/hq/graphql/enum/sort_order.rb
 - lib/hq/graphql/field.rb
+- lib/hq/graphql/field_extension/association_loader_extension.rb
+- lib/hq/graphql/field_extension/paginated_arguments.rb
+- lib/hq/graphql/field_extension/paginated_loader.rb
 - lib/hq/graphql/input_object.rb
 - lib/hq/graphql/inputs.rb
 - lib/hq/graphql/mutation.rb
 - lib/hq/graphql/object.rb
+- lib/hq/graphql/object_association.rb
 - lib/hq/graphql/paginated_association_loader.rb
 - lib/hq/graphql/resource.rb
 - lib/hq/graphql/resource/auto_mutation.rb