readthis 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f4a5828855f99da7d47944ea9053283d8481426
-  data.tar.gz: 86868fd07d2e020d9944ca1fd10345537e001512
+  metadata.gz: d99b745b536b4761198212736eba995173cf7dd0
+  data.tar.gz: fb66dd2f67cc90114ad5037ea10b684722d6d468
 SHA512:
-  metadata.gz: 90a353e3ffa46d266b1cd99a28ec9494161078195f5ed2e2f2ec50ae46029b2938597fbeff02d8eef7a17cbe04cdbdf67117caa932b5b339a84d93ea90e9b234
-  data.tar.gz: 9438c2fc7b9460ba9e1996686142023afd4e929f06f43250d2af1e1a71d19e62284e73b32f3ad5e77afd8c01a3c87e27c933b2ba871a0243cccea30b96909a53
+  metadata.gz: 992a39d5b3c6fde1796dbd8ac8dc8c03aa44cd79152a15e6b1ca553327d4dec95f754ddb68a2275aa636d75d13658e43b712ebd95ae4b49ae21f6a164ad66b87
+  data.tar.gz: e5521f55739341901c7bbe6d9743127686643ca44cb82bf338f046a81fd16a522f364ee757e5f548f3ed9c647b495904c0faa1144470e47f4610f510cebc23e1

data/README.md

@@ -183,9 +183,7 @@ Rails.cache.pool.with { |client| client.expire('foo-key', 60) }
 Readthis supports all of standard cache methods except for the following:
 
 * `cleanup` - Redis does this with TTL or LRU already.
-* `delete_matched` - You really don't want to perform key matching operations in
-  Redis. They are linear time and only support basic globbing.
-* `mute` and `silence!` - You can subscribe to the events `/cache*.active_support/`
+* `mute` and `silence!` - You must subscribe to the events `/cache*.active_support/`
   with `ActiveSupport::Notifications` to [log cache calls manually][notifications].
 
 [notifications]: https://github.com/sorentwo/readthis/issues/22#issuecomment-142595938

data/lib/readthis/cache.rb

@@ -115,6 +115,49 @@ module Readthis
       end
     end
 
+    # Delete all values that match a given pattern. The pattern must be defined
+    # using Redis compliant globs. The following examples are borrowed from the
+    # `KEYS` documentation:
+    #
+    # * `h?llo` matches hello, hallo and hxllo
+    # * `h*llo` matches hllo and heeeello
+    # * `h[ae]llo` matches hello and hallo, but not hillo
+    # * `h[^e]llo` matches hallo, hbllo, ... but not hello
+    # * `h[a-b]llo` matches hallo and hbllo
+    #
+    # Note that `delete_matched` does *not* use the `KEYS` command, making it
+    # safe for use in production.
+    #
+    # @param [String] pattern The glob pattern for matching keys
+    # @option [String] :namespace Prepend a namespace to the pattern
+    # @option [Number] :count Configure the number of keys deleted at once
+    #
+    # @example Delete all 'cat' keys
+    #
+    #   cache.delete_matched('*cats') #=> 47
+    #   cache.delete_matched('*dogs') #=> 0
+    #
+    def delete_matched(pattern, options = {})
+      namespaced = namespaced_key(pattern, merged_options(options))
+
+      invoke(:delete, pattern) do |store|
+        cursor  = nil
+        count   = options.fetch(:count, 1000)
+        deleted = 0
+
+        until cursor == '0'.freeze
+          cursor, matched = store.scan(cursor || 0, match: namespaced, count: count)
+
+          if matched.any?
+            store.del(*matched)
+            deleted += matched.length
+          end
+        end
+
+        deleted
+      end
+    end
+
     # Fetches data from the cache, using the given key. If there is data in the
     # cache with the given key, then that data is returned.
     #

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/spec/readthis/cache_spec.rb

@@ -327,6 +327,32 @@ RSpec.describe Readthis::Cache do
     end
   end
 
+  describe '#delete_matched' do
+    it 'deletes all matching keys' do
+      cache.write('tomcat', 'cat')
+      cache.write('wildcat', 'cat')
+      cache.write('bobcat', 'cat')
+      cache.write('cougar', 'cat')
+
+      expect(cache.delete_matched('tomcat')).to eq(1)
+      expect(cache.read('tomcat')).to be_nil
+      expect(cache.read('bobcat')).not_to be_nil
+      expect(cache.read('wildcat')).not_to be_nil
+
+      expect(cache.delete_matched('*cat', count: 1)).to eq(2)
+      expect(cache.read('wildcat')).to be_nil
+      expect(cache.read('bobcat')).to be_nil
+
+      expect(cache.delete_matched('*cat')).to eq(0)
+    end
+
+    it 'respects namespacing when matching keys' do
+      cache.write('tomcat', 'cat', namespace: 'feral')
+
+      expect(cache.delete_matched('tom*', namespace: 'feral')).to eq(1)
+    end
+  end
+
   describe '#increment' do
     it 'atomically increases the stored integer' do
       cache.write('counter', 10)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis