graphql-sources 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3f8fb917c9bbe477e31a14294750e1f7bca546bd8321f1e802eb654b083888
-  data.tar.gz: 8dfe477f1139b1c2fd44cf5627c6c2d0415cb4f62c97f45c6a924102a3594661
+  metadata.gz: e99e1d718952f3ee55b0a0b37c6f4f9f99789f4740243a6dd7995bee2b5fa6a4
+  data.tar.gz: 4f082d61109e02db43b06b2ff345dd2fdc697f8a6dc30336b7e6226e352a5e79
 SHA512:
-  metadata.gz: 83f0d540b272203c2c7ec315472ca27310683961e71857127a16f4574fcdadb0dab40cf385d0c6f92f80c14523e116c839f57acdd080474c5fa2171a4420833e
-  data.tar.gz: ae31236645fc987acfd875d3056f2aa32e35925afbf7e7e95544cb3014cbcc90bcfda2a4fefa796ce1a02f3ac67b0cfaef7b85a331f8045ffe29cc20114379b2
+  metadata.gz: 58202b58608b54a184ed5831672ebafbd39b216cee19908139b4c9ee6e2874197ed5609fcb2bcd592074e101e77ddce8b1e250db5777c55427a37e7f19abc7be
+  data.tar.gz: ee4949a68c77cf7ea0b945f4f79d4a5ba6de9e491c64abb472f8091b01c8181512beafbaa16ca66bbecd8cc64b33c8891d2b3d2589659610ad0149c29dfdf6e0

data/README.md

@@ -78,6 +78,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
@@ -111,6 +151,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

@@ -31,6 +31,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

@@ -31,6 +31,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

@@ -31,6 +31,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,42 @@
+# frozen_string_literal: true
+
+require_relative './active_storage_base'
+
+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,42 @@
+# frozen_string_literal: true
+
+require_relative './active_storage_base'
+
+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.2.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/graphql/sources.rb

@@ -5,6 +5,9 @@ require 'graphql'
 require_relative './sources/active_record_count'
 require_relative './sources/active_record_collection'
 require_relative './sources/active_record_object'
+require_relative './sources/active_storage_has_many_attached'
+require_relative './sources/active_storage_has_one_attached'
+require_relative './sources/rails_cache'
 
 module GraphQL
   # A collection of common GraphQL dataloader classes.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-sources
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -150,6 +150,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 +179,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: