graphql-sources 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c950f4402666974cd24dd441f3b51caac7d337429518753e6886cecc9d9a46dd
-  data.tar.gz: 88194279dc3f9ea1f3a1e47349cc5620b7cf550badbe6c0720fa35fcbf20a340
+  metadata.gz: e99e1d718952f3ee55b0a0b37c6f4f9f99789f4740243a6dd7995bee2b5fa6a4
+  data.tar.gz: 4f082d61109e02db43b06b2ff345dd2fdc697f8a6dc30336b7e6226e352a5e79
 SHA512:
-  metadata.gz: 4f63d94f097e6c72665be2086ee3736ba11c87ceb41935afcfcefb1fbb4b64d9b0fe71f93eea66bdc0ddb8f4846e637b320e6f1117631d2a6522638869fc2df2
-  data.tar.gz: 620fe9b524a7a0af4a67dbdfcc1f558f419977c25116830b3c46c42ed32f1fc86b1eba92c6a857c5ffc4d8814781cc989dca5b78519eefe6e04ef0b08f0c6b6a
+  metadata.gz: 58202b58608b54a184ed5831672ebafbd39b216cee19908139b4c9ee6e2874197ed5609fcb2bcd592074e101e77ddce8b1e250db5777c55427a37e7f19abc7be
+  data.tar.gz: ee4949a68c77cf7ea0b945f4f79d4a5ba6de9e491c64abb472f8091b01c8181512beafbaa16ca66bbecd8cc64b33c8891d2b3d2589659610ad0149c29dfdf6e0

data/README.md

@@ -151,9 +151,23 @@ 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/rhino)
+[![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)
 

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_has_many_attached.rb

@@ -28,6 +28,8 @@ module GraphQL
     #       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

data/lib/graphql/sources/active_storage_has_one_attached.rb

@@ -28,6 +28,8 @@ module GraphQL
     #       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

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.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/graphql/sources.rb

@@ -7,6 +7,7 @@ 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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -182,6 +182,7 @@ files:
 - 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: