graphql-sources 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88238e75afcee4b41463d85c77e4ec70a89afffe18baf5bdaa5a780e153335f
-  data.tar.gz: eb3a39814d97bf3c06c6ea996cd50dcff262a170b5700edd4019f98c2ff80cad
+  metadata.gz: 1e1dff9e9ccdc886ea784a7276e4a6623e6cfca8df8286492b28cc8bd237039b
+  data.tar.gz: 87249e51a1a7f4355d399883567a24acc17b11ed081b7a9f87dd8604bb3a6e33
 SHA512:
-  metadata.gz: 968c6e5955b5f936c040d862219b890137fed330047670ffda3c7b79ecab1531f976696729e24fb50257acacfff6141296071d84d395e27bedfe757cde5f6f5f
-  data.tar.gz: 6ec3329d4de24ca2fe71f7c339fa4e6e9d569e4ef6e940f4b1174b2707e8641a72857c4ae1cb30ad53b436a53875616d6a4d254586619d2ebf76bf8a9dc26707
+  metadata.gz: 32737d8bff6005b5e41a1c19e8d526ae0ce8e8665902f26983d8210cfe2b28f16fb27cab6b16a03cb35549c86f74637ac1f8462eafec4e28a8c0483392e691e5
+  data.tar.gz: 29f417cbdcac1a76846d52110c815bb76816532cd3e82be93fb2637b3176809d0c51e88a9d73d2d1f04a02d4e8e2d3374d423ea62754a8ceb4ef028747367a13

data/README.md

@@ -10,6 +10,15 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install graphql-sources
 
+The `GraphQL::Dataloader` plugin must be installed in the schema:
+
+```ruby
+class AppSchema < GraphQL::Schema
+  use GraphQL::Dataloader
+  # ...
+end
+```
+
 ## Usage
 
 ### Loading `has_one` Associations
@@ -63,7 +72,7 @@ end
 class UserType < GraphQL::Schema::Object
   field :comments, [CommentType], null: false
 
-  def profile
+  def comments
     dataloader
       .with(GraphQL::Sources::ActiveRecordCollection, ::Comment, key: :user_id)
       .load(object.id)
@@ -78,6 +87,46 @@ WHERE "comments"."user_id" IN (...)
 ORDER BY "comments"."id"
 ```
 
+### Loading `has_one_attached` Associations
+
+```ruby
+class User
+  has_one_attached :avatar
+end
+```
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  field :avatar, AttachedType, null: false
+
+  def avatar
+    dataloader
+      .with(GraphQL::Sources::ActiveStorageHasOneAttached, :avatar)
+      .load(object)
+  end
+end
+```
+
+### Loading `has_many_attached` Associations
+
+```ruby
+class User
+  has_many_attached :photos
+end
+```
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  field :photos, [AttachedType], null: false
+
+  def photos
+    dataloader
+      .with(GraphQL::Sources::ActiveStorageHasOneAttached, :photos)
+      .load(object)
+  end
+end
+```
+
 ### Loading Counts
 
 ```ruby
@@ -96,7 +145,7 @@ end
 class PostType < GraphQL::Schema::Object
   field :likes, Integer, null: false
 
-  def comments
+  def likes
     dataloader
       .with(GraphQL::Sources::ActiveRecordCount, ::Like, key: :post_id)
       .load(object.id)
@@ -111,6 +160,26 @@ WHERE "likes"."post_id" IN (1, 2, 3, ...)
 GROUP BY "likes"."post_id"
 ```
 
+### Loading with `Rails.cache`
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  field :location, String, null: false
+
+  def location
+    dataloader
+      .with(GraphQL::Sources::RailsCache)
+      .load(key: "geocode:#{object.latest_ip}", fallback: -> { Geocode.for(object.latest_ip) })
+  end
+end
+```
+
+## Status
+
+[![CircleCI](https://circleci.com/gh/ksylvest/graphql-sources.svg?style=svg)](https://circleci.com/gh/ksylvest/graphql-sources)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/maintainability)](https://codeclimate.com/github/ksylvest/graphql-sources/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/test_coverage)](https://codeclimate.com/github/ksylvest/graphql-sources/test_coverage)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/graphql/sources/active_record_collection.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './active_record_base'
-
 module GraphQL
   module Sources
     # A class for loading `has_many` style associations.
@@ -31,6 +29,8 @@ module GraphQL
     #     WHERE "comments"."user_id" IN (...)
     #     ORDER BY "comments"."id"
     class ActiveRecordCollection < ActiveRecordBase
+      # @param keys [Array] an array of keys
+      # @return [Array] grouped records mirroring the keys
       def fetch(keys)
         models = models(keys: keys).order(:id).load_async
         dataloader.yield

data/lib/graphql/sources/active_record_count.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './active_record_base'
-
 module GraphQL
   module Sources
     # A class for loading a count of records.
@@ -31,6 +29,8 @@ module GraphQL
     #     WHERE "likes"."post_id" IN (1, 2, 3, ...)
     #     GROUP BY "likes"."post_id"
     class ActiveRecordCount < ActiveRecordBase
+      # @param keys [Array] an array of keys
+      # @return [Array] grouped counts for the keys
       def fetch(keys)
         map = models(keys: keys).group(@key).count
         keys.map { |key| map[key] || 0 }

data/lib/graphql/sources/active_record_object.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './active_record_base'
-
 module GraphQL
   module Sources
     # A class for loading `has_one` style associations.
@@ -31,6 +29,8 @@ module GraphQL
     #     WHERE "profiles"."user_id" IN (1, 2, 3, ...)
     #     ORDER BY "profiles"."id"
     class ActiveRecordObject < ActiveRecordBase
+      # @param keys [Array] an array of keys
+      # @return [Array] indexed records mirroring the keys
       def fetch(keys)
         models = models(keys: keys).order(:id).load_async
         dataloader.yield

data/lib/graphql/sources/active_storage_base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # An abstract class for interacting with active storage.
+    class ActiveStorageBase < GraphQL::Dataloader::Source
+      # @param name [String] the association name
+      def initialize(name)
+        super()
+        @name = name
+      end
+
+      protected
+
+      # @param records [Array<ActiveRecord::Base>] a collection of records to load attachments for
+      # @return [Array<ActiveStorage::Attachment>] the associated attachments with preloaded blobs
+      def attachments(records:)
+        ActiveStorage::Attachment
+          .preload(:blob)
+          .where(record: records)
+          .where(name: @name)
+          .order(:id)
+      end
+    end
+  end
+end

data/lib/graphql/sources/active_storage_has_many_attached.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # A class for loading `has_many_attached` style associations.
+    #
+    #   class User
+    #     has_many_attached :photos
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :photos, [AttachedType], null: false
+    #
+    #     def photos
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveStorageHasManyAttached, :photos)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    # The resulting SQL query is:
+    #
+    #     SELECT "active_storage_attachments".*
+    #     FROM "active_storage_attachments"
+    #     WHERE "active_storage_attachments"."name" = 'photos'
+    #       AND "active_storage_attachments"."record_type" = 'User'
+    #       AND "active_storage_attachments"."record_id" IN (...)
+    class ActiveStorageHasManyAttached < ActiveStorageBase
+      # @param records [Array<ActiveRecord::Base>] an array of records
+      # @return [Array] grouped attachments mirroring the keys
+      def fetch(records)
+        attachments = attachments(records: records).load_async
+        dataloader.yield
+
+        map = attachments.group_by { |attachment| [attachment.record_type, attachment.record_id] }
+        records.map { |record| map[[record.class.name, record.id]] || [] }
+      end
+    end
+  end
+end

data/lib/graphql/sources/active_storage_has_one_attached.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # A class for loading `has_one_attached` style associations.
+    #
+    #   class User
+    #     has_one_attached :photo
+    #   end
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :avatar, AttachedType, null: false
+    #
+    #     def avatar
+    #       dataloader
+    #         .with(GraphQL::Sources::ActiveStorageHasOneAttached, :avatar)
+    #         .load(object)
+    #     end
+    #   end
+    #
+    # The resulting SQL query is:
+    #
+    #     SELECT "active_storage_attachments".*
+    #     FROM "active_storage_attachments"
+    #     WHERE "active_storage_attachments"."name" = 'avatar'
+    #       AND "active_storage_attachments"."record_type" = 'User'
+    #       AND "active_storage_attachments"."record_id" IN (...)
+    class ActiveStorageHasOneAttached < ActiveStorageBase
+      # @param records [Array<ActiveRecord::Base>] an array of records
+      # @return [Array] indexed attachments mirroring the keys
+      def fetch(records)
+        attachments = attachments(records: records).load_async
+        dataloader.yield
+
+        map = attachments.index_by { |attachment| [attachment.record_type, attachment.record_id] }
+        records.map { |record| map[[record.class.name, record.id]] }
+      end
+    end
+  end
+end

data/lib/graphql/sources/rails_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Sources
+    # A class for loading with Rails.cache.
+    #
+    #   class UserType < GraphQL::Schema::Object
+    #     field :location, String, null: false
+    #
+    #     def location
+    #       dataloader
+    #         .with(GraphQL::Sources::RailsCache)
+    #         .load(key: "geocode:#{object.latest_ip}", fallback: -> { Geocode.for(object.latest_ip) })
+    #     end
+    #   end
+    class RailsCache < GraphQL::Dataloader::Source
+      # @param operations [Array<Hash>] an array of key and fallback hashes
+      def fetch(operations)
+        keys = operations.pluck(:key)
+        fallbacks = operations.to_h { |operation| [operation[:key], operation[:fallback]] }
+        results = Rails.cache.fetch_multi(*keys) { |key| fallbacks[key].call }
+        keys.map { |key| results[key] }
+      end
+    end
+  end
+end

data/lib/graphql/sources/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Sources
-    VERSION = '0.3.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/graphql/sources.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'graphql'
+require 'zeitwerk'
 
-require_relative './sources/active_record_count'
-require_relative './sources/active_record_collection'
-require_relative './sources/active_record_object'
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir(__dir__, namespace: GraphQL)
+loader.setup
 
 module GraphQL
   # A collection of common GraphQL dataloader classes.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-sources
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Common loaders for various database or cache operations.
 email:
 - kevin@ksylvest.com
@@ -165,6 +193,10 @@ files:
 - lib/graphql/sources/active_record_collection.rb
 - lib/graphql/sources/active_record_count.rb
 - lib/graphql/sources/active_record_object.rb
+- lib/graphql/sources/active_storage_base.rb
+- lib/graphql/sources/active_storage_has_many_attached.rb
+- lib/graphql/sources/active_storage_has_one_attached.rb
+- lib/graphql/sources/rails_cache.rb
 - lib/graphql/sources/version.rb
 homepage: https://github.com/ksylvest/graphql-sources
 licenses: