artirix_cache_service 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5871260d413d0b379be074fd68456dbf560e65b5
-  data.tar.gz: fe55cfc25c52328783ee5544fefa543b93532b14
+  metadata.gz: 2a01c290d04ff11dacda29d2c61f5ef7b8dece7d
+  data.tar.gz: a39368fac963a4ecd34d344c54fdfcb1deee31c0
 SHA512:
-  metadata.gz: 00633e6912fc6549966c6f5f039140139d0416603ba29de9d62a492543e6e9073193a0bbbd87a0070258e1d0c8d86dd4e897ad14c72f23d0e0bb12db7bbcf0e3
-  data.tar.gz: a20524d2819fc873444925ce2e17da77ac9ebc9407d6f36e0e3668469bc44bd4a930dc3c0590c16c93d0edd7da82f86648eacd22e77e02f12f656482e1ccf5da
+  metadata.gz: cc6809a9de4d95d41c6e8a8799b60e93a3dd736551e4b4b9bb5cb52645889eff0afcafe3e6577795b1bed4efcb85c03a38f4ea4a543b92b07f5b3dfd268ff3eb
+  data.tar.gz: 47803491fe5289afc35b01c82ac713fa568dda16ab5db3c850c5ac08fa3f81a9c9ad32ff8adceb77f399a2fed0a6821c87cd0185e5ac3cedaf22f1d9d8f38ec4

data/README.md

@@ -6,9 +6,8 @@
 [![Code Climate Coverage](https://codeclimate.com/github/artirix/artirix_cache_service/coverage.png)](https://codeclimate.com/github/artirix/artirix_cache_service)
 
 The basic use of this gem is to compile a cache key based on a given key prefix 
-and some extra variables or options, with some helper methods.
-
-TODO: also help with the cache options.
+and some extra variables or arguments, with some helper methods. It also helps 
+with the cache options.
 
 ## Usage: `.key`
 
@@ -82,6 +81,27 @@ ArtirixCacheService.key :some_key, :arg1, 'arg2', digest: [arg3, arg4]
   # => "prfx/some_key/arg1/arg2/7448a071aeee91fc9ee1c705f15445fdd8411224"
 ```
 
+### `request` as special digest part
+
+we can pass the request as a special argument. The Service will invoke `fullpath` 
+on it in the final digest.
+
+It uses a parameterized version of the fullpath followed by a untouched version, 
+to avoid any collision.
+
+```ruby
+request 
+  # => an ActionDispatch::Request, or any object that responds to `fullpath` 
+ 
+request.fullpath # => "/some/path?with=arguments"
+
+ArtirixCacheService.key :some_key, :arg1, 'arg2', request: request
+  # => "prfx/some_key/arg1/arg2/1d3c96f449b8d21df75ebcf378c8f2455bf4e93c"
+
+# >> Digest::SHA1.hexdigest [request.fullpath.parameterize, request.fullpath].to_s
+# => "1d3c96f449b8d21df75ebcf378c8f2455bf4e93c"
+```
+
 ## Usage: `.options`
 
 used for getting the cache options based on the registered defaults and the registered options.
@@ -257,6 +277,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/artiri
 
 # Changeset
 
+## v0.3.1
+
+- add request support
+
 ## v0.3.0
 
 - add Redis support

data/lib/artirix_cache_service/key.rb

@@ -40,18 +40,32 @@ module ArtirixCacheService
     def cache_key_from_options(hash)
       return nil unless hash.kind_of? Hash
 
-      d = hash[:digest].presence
-      v = variables_hash(Array(hash[:variables])).presence
+      parts = digest_hash_parts(hash).map(&:presence).compact
 
-      return nil unless d || v
-
-      if d && v
-        digest [d, v]
+      case parts.size
+      when 0
+        nil
+      when 1
+        digest parts.first
       else
-        digest d || v
+        digest parts
       end
     end
 
+    def digest_hash_parts(hash)
+      [
+        hash[:digest],
+        variables_hash(Array(hash[:variables])),
+        request_list(hash[:request]),
+      ]
+    end
+
+    def request_list(request)
+      return nil unless request.present? && request.fullpath.present?
+
+      [request.fullpath.parameterize, request.fullpath]
+    end
+
     def variables_hash(variable_names)
       Hash[variable_names.map { |var| [var, variable_get(var)] }]
     end

data/lib/artirix_cache_service/version.rb

@@ -1,3 +1,3 @@
 module ArtirixCacheService
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_cache_service
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Eduardo Turiño