graphql-cache 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90827abbbae2111c06ea2a0afc7f9daea103098064949eba4bbd84cd791c2fdb
-  data.tar.gz: 2efebce54277a3fef786d189b9c9bcb9a46dfa22c412a9b51f29f6652e3031c6
+  metadata.gz: c6f7002428257c6c015fc0a9db823de56c129732591098f7c44a7ce254fe769e
+  data.tar.gz: 74581f477076619693e234c3d7082ab518d463d98de40947f66625901ce24079
 SHA512:
-  metadata.gz: d85a82ed4c3dae977475ad723fd6a2c61c676f3e887db196ef1aaa5100c81c2a54a5fc3874ae427baa023a2d00b8e9446a16536cef656c7c7c623b670118032a
-  data.tar.gz: b0abbd392cc526d552dc5a1296187f053e1a1d66d6f7127eb779602bdbb74b9dec6848308e6d6d94bb199ef94a8b4071def6126a262d6e90b8c8048a3a124a67
+  metadata.gz: d6abff3fd6c798263f98da3c4ff2f7f443c14c8e59a9f9d221b37199d7e8a635bab9a32f22c976c4c428facb72c455c82af3c996c5afd4ec7a9bab49489d297a
+  data.tar.gz: 7c86dbe1316af159b5872ba668a1600e79d1affbe8b8592a1981f7fbe14842117af3bc09782965e1240240f992ea96af60a217af09e4e7dee41041e7d3b871f9

data/lib/graphql/cache/fetcher.rb

@@ -1,6 +1,16 @@
 module GraphQL
   module Cache
+    # Represents the "instrumenter" passed to GraphQL::Schema#instrument
+    # when the plugin in initialized (i.e. `use GraphQL::Cache`)
     class Fetcher
+      # Redefines the given field's resolve proc to use our
+      # custom cache wrapping resolver proc. Called from
+      # graphql-ruby internals. This is the "instrumenter"
+      # entrypoint.
+      #
+      # @param type [GraphQL::Schema::Object] graphql-ruby passes the defined type for the field being instrumented
+      # @param field [GraphQL::Schema::Field] graphql-ruby passes the field definition to be re-defined
+      # @return [GraphQL::Schema::Field]
       def instrument(type, field)
         return field unless field.metadata[:cache]
 

data/lib/graphql/cache/field.rb

@@ -5,7 +5,7 @@ module GraphQL
     # Custom field class implementation to allow for
     # cache config keyword parameters
     class Field < ::GraphQL::Schema::Field
-      # Override #initialize to take a new argument:
+      # Overriden to take a new cache keyword argument
       def initialize(
         *args,
         cache: false,
@@ -16,6 +16,7 @@ module GraphQL
         super(*args, **kwargs, &block)
       end
 
+      # Overriden to provide custom cache config to internal definition
       def to_graphql
         field_defn = super # Returns a GraphQL::Field
         field_defn.metadata[:cache] = @cache_config

data/lib/graphql/cache/key.rb

@@ -19,6 +19,11 @@ module GraphQL
       attr_accessor :metadata
 
       # Initializes a new Key with the given graphql query context
+      #
+      # @param obj [Object] The resolved parent object for a field's resolution
+      # @param args [GraphQL::Arguments] The internal graphql-ruby wrapper for field arguments
+      # @param type [GraphQL::Schema::Type] The type definition of the parent object
+      # @param field [GraphQL::Schema::Field] The field being resolved
       def initialize(obj, args, type, field)
         @object    = obj.object
         @arguments = args
@@ -31,6 +36,12 @@ module GraphQL
 
       # Returns the string representation of this cache key
       # suitable for using as a key when writing to cache
+      #
+      # The key is constructed with this structure:
+      #
+      # ```
+      # namespace:type:field:arguments:object-id
+      # ```
       def to_s
         @to_s ||= [
           GraphQL::Cache.namespace,
@@ -79,6 +90,7 @@ module GraphQL
 
       # @private
       def guess_id
+        return object.cache_key_with_version if object.respond_to?(:cache_key_with_version)
         return object.cache_key if object.respond_to?(:cache_key)
         return object.id if object.respond_to?(:id)
         object.object_id

data/lib/graphql/cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Cache
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-cache
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal