graphql-fragment_cache 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bcaf1bb938f830b5ae34b7b034e2ccbf8ce139e5da10db08e8ca52b658c0ed3
-  data.tar.gz: 5842f5166dc9cf69a276b3dee9836a43b757485ffe46f54031ce42341dfe797a
+  metadata.gz: e2c544bc2742643748c5e36c59b3414def73c22e6f7c4b5080504751ea564ecd
+  data.tar.gz: b61980525863502ea4f30eeb96fee11dbc11a906ab98b863ed0ece7f9d97d1e9
 SHA512:
-  metadata.gz: e218c2d46cb5cc545d0374c86c64f46380b82a4c31dd67d0dcb06890e23c4156ed16cef838d3965ae54283e28ea7ba155d965920dbc1c9a722a64fff7c174b69
-  data.tar.gz: caa35cd10a7c657b838088b0ffd449b981ee3565483691619af1c839a184febccacf19620c31bfee26f434929218e2ecd4478a6edbca7bf97ae3a68245bbe316
+  metadata.gz: aac16bb6d2541e573796043ebf2da2ffa171918730ad95f4613db1f6b20cb1156a4a1cb3d70b7e0c39be57a6d56d2cfd3a27d95470c0c316f8f95a756bf83377
+  data.tar.gz: 85349b218d754a716db3aa8165e8de64a92b48c22e4b4b1615e612d041000701a090c643fa6b6e68326bb51a3688df2eb71f84604a1bfd19034eb01201453b26

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.17.0 (2022-11-09)
+
+- [PR#92](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/92) Make cache keys human-readable ([@jeromedalbert][])
+
 ## 1.16.0 (2022-11-06)
 
 - [PR#42](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/42) Raise helpful errors when write or write_multi fails  ([@DmitryTsepelev][])

data/README.md

@@ -1,4 +1,4 @@
-# GraphQL::FragmentCache ![CI](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/workflows/CI/badge.svg?branch=master)
+# GraphQL::FragmentCache ![CI](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/actions/workflows/rspec.yml/badge.svg?branch=master) ![](https://ruby-gem-downloads-badge.herokuapp.com/graphql-fragment_cache?type=total)
 
 `GraphQL::FragmentCache` powers up [graphql-ruby](https://graphql-ruby.org) with the ability to cache response _fragments_: you can mark any field as cached and it will never be resolved again (at least, while cache is valid). For instance, the following code caches `title` for each post:
 
@@ -9,12 +9,6 @@ class PostType < BaseObject
 end
 ```
 
-<p align="center">
-  <a href="https://evilmartians.com/?utm_source=graphql-ruby-fragment_cache">
-    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-  </a>
-</p>
-
 ## Getting started
 
 Add the gem to your Gemfile `gem 'graphql-fragment_cache'` and add the plugin to your schema class:
@@ -489,6 +483,8 @@ end
 
 Based on the original [gist](https://gist.github.com/palkan/faad9f6ff1db16fcdb1c071ec50e4190) by [@palkan](https://github.com/palkan) and [@ssnickolay](https://github.com/ssnickolay).
 
+Initially sponsored by [Evil Martians](http://evilmartians.com).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache).

data/lib/.rbnext/2.3/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

data/lib/.rbnext/2.7/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

data/lib/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

data/lib/graphql/fragment_cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.16.0"
+    VERSION = "1.17.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql