kredis 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90d8ba8eadeb9cc6dbd2ca4bbb8532629281595e5a1feccd42487b98f248e67
-  data.tar.gz: 3d5e2768e7647d27bb004bc7167f9b35b97702bdcc3e3f6f76032abd3b85bb5d
+  metadata.gz: c7b578a8b9d0b956e519c324d7ba9dd6036124637801366d9f1a2719a7d340d5
+  data.tar.gz: a4bc7d1a74540a7bd41691105833123bffd27ff32f07b01ce82986820d6068e3
 SHA512:
-  metadata.gz: 590e5baac4b4a2c85c4867f6ee55d4598c3b21e9c9b22961556626f59e8b17524cc4e4e9040f9109d30671ba4b615b074edcad5723df459f75a10dd1da956a23
-  data.tar.gz: 8ad76868f04ac0c0828485f2e03ce93fc8514eb32e2661028adcbc6ff9866f6016d26530b6af30f8df15009723e01797fc913084bb6bcb219f36558db7ed2768
+  metadata.gz: 5ca284918aa9079b5265f1603a9ff33c7fe6f562b4cf76a97ce571542a7dccb9265d2d94441b578570729e415d0ea1adf29786612a31635660cebe82917172df
+  data.tar.gz: 569e06a45f6696800372a6f11a953e12267faf009596767366a860c0f6f691c40668d5a0e94ea7cd0c9bf09370870bca209a3e9081d8f0489be79fce64864ae1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Basecamp
+Copyright (c) 2020-2025 37signals LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -48,11 +48,13 @@ There are data structures for counters, enums, flags, lists, unique lists, sets,
 list = Kredis.list "mylist"
 list << "hello world!"               # => RPUSH mylist "hello world!"
 [ "hello world!" ] == list.elements  # => LRANGE mylist 0, -1
+list.clear                           # => DEL mylist
 
 integer_list = Kredis.list "myintegerlist", typed: :integer, default: [ 1, 2, 3 ] # => EXISTS? myintegerlist, RPUSH myintegerlist "1" "2" "3"
 integer_list.append([ 4, 5, 6 ])                                                  # => RPUSH myintegerlist "4" "5" "6"
 integer_list << 7                                                                 # => RPUSH myintegerlist "7"
 [ 1, 2, 3, 4, 5, 6, 7 ] == integer_list.elements                                  # => LRANGE myintegerlist 0 -1
+integer_list.clear                                                                # => DEL myintegerlist
 
 unique_list = Kredis.unique_list "myuniquelist"
 unique_list.append(%w[ 2 3 4 ])                # => LREM myuniquelist 0, "2" + LREM myuniquelist 0, "3" + LREM myuniquelist 0, "4"  + RPUSH myuniquelist "2", "3", "4"
@@ -61,6 +63,7 @@ unique_list.append([])
 unique_list << "5"                             # => LREM myuniquelist 0, "5" + RPUSH myuniquelist "5"
 unique_list.remove(3)                          # => LREM myuniquelist 0, "3"
 [ "4", "2", "1", "5" ] == unique_list.elements # => LRANGE myuniquelist 0, -1
+unique_list.clear                              # => DEL myuniquelist
 
 ordered_set = Kredis.ordered_set "myorderedset"
 ordered_set.append(%w[ 2 3 4 ])                # => ZADD myorderedset 1646131025.4953232 2 1646131025.495326 3 1646131025.4953272 4
@@ -75,6 +78,7 @@ set.add(DateTime.tomorrow, DateTime.yesterday)           # => SADD myset "2021-0
 set << DateTime.tomorrow                                 # => SADD myset "2021-02-03 00:00:00 +0100"
 2 == set.size                                            # => SCARD myset
 [ DateTime.tomorrow, DateTime.yesterday ] == set.members # => SMEMBERS myset
+set.clear                                                # => DEL myset
 
 hash = Kredis.hash "myhash"
 hash.update("key" => "value", "key2" => "value2")     # => HSET myhash "key", "value", "key2", "value2"
@@ -102,6 +106,7 @@ counter.increment by: 2         # => SET mycounter 0 EX 5 NX + INCRBY "mycounter
 2 == counter.value              # => GET "mycounter"
 sleep 6.seconds
 0 == counter.value              # => GET "mycounter"
+counter.reset                   # => DEL mycounter
 
 cycle = Kredis.cycle "mycycle", values: %i[ one two three ]
 :one == cycle.value             # => GET mycycle
@@ -111,6 +116,7 @@ cycle.next                      # => GET mycycle + SET mycycle 2
 :three == cycle.value           # => GET mycycle
 cycle.next                      # => GET mycycle + SET mycycle 0
 :one == cycle.value             # => GET mycycle
+cycle.reset                     # => DEL mycycle
 
 enum = Kredis.enum "myenum", values: %w[ one two three ], default: "one"
 "one" == enum.value             # => GET myenum
@@ -161,6 +167,18 @@ sleep 0.5.seconds
 true == flag.marked?            #=> EXISTS myflag
 sleep 0.6.seconds
 false == flag.marked?           #=> EXISTS myflag
+
+limiter = Kredis.limiter "mylimit", limit: 3, expires_in: 5.seconds
+0 == limiter.value              # => GET "limiter"
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+false == limiter.exceeded?      # => GET "limiter"
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+true == limiter.exceeded?       # => GET "limiter"
+sleep 6
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+false == limiter.exceeded?      # => GET "limiter"
 ```
 
 ### Models
@@ -249,7 +267,7 @@ If you don't have `config/redis/shared.yml` (or use another named configuration)
 
 ### Redis support
 
-Kredis works with Redis server 4.0+, with the [Redis Ruby](https://github.com/redis/redis-rb) client version 4.2+.
+Kredis works with Redis server 4.0+, with the [Redis Ruby](https://github.com/redis/redis-rb) client version 4.2+. Redis Cluster is not supported.
 
 ### Setting SSL options on Redis Connections
 

data/lib/kredis/attributes.rb

@@ -72,6 +72,10 @@ module Kredis::Attributes
       kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
+    def kredis_limiter(name, limit:, key: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, limit: limit, config: config, after_change: after_change, expires_in: expires_in
+    end
+
     def kredis_hash(name, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end

data/lib/kredis/namespace.rb

@@ -1,14 +1,31 @@
 # frozen_string_literal: true
 
 module Kredis::Namespace
-  def namespace=(namespace)
-    Thread.current[:kredis_namespace] = namespace
-  end
+  attr_accessor :global_namespace
 
   def namespace
-    Thread.current[:kredis_namespace]
+    if global_namespace
+      if value = thread_namespace
+        "#{global_namespace}:#{value}"
+      else
+        global_namespace
+      end
+    else
+      thread_namespace
+    end
+  end
+
+  def thread_namespace
+    Thread.current[:kredis_thread_namespace]
   end
 
+  def thread_namespace=(value)
+    Thread.current[:kredis_thread_namespace] = value
+  end
+
+  # Backward compatibility
+  alias_method :namespace=, :thread_namespace=
+
   def namespaced_key(key)
     namespace ? "#{namespace}:#{key}" : key
   end

data/lib/kredis/railtie.rb

@@ -5,7 +5,7 @@ class Kredis::Railtie < ::Rails::Railtie
 
   initializer "kredis.testing" do
     ActiveSupport.on_load(:active_support_test_case) do
-      parallelize_setup { |worker| Kredis.namespace = "test-#{worker}" }
+      parallelize_setup { |worker| Kredis.global_namespace = [ Kredis.global_namespace, :test, worker ].compact.join("-") }
       teardown { Kredis.clear_all }
     end
   end

data/lib/kredis/types/hash.rb

@@ -18,7 +18,7 @@ class Kredis::Types::Hash < Kredis::Types::Proxying
   end
 
   def update(**entries)
-    hset entries.transform_values { |val| type_to_string(val, typed) } if entries.flatten.any?
+    hset entries.transform_values { |val| type_to_string(val, typed) }.compact if entries.flatten.any?
   end
 
   def values_at(*keys)

data/lib/kredis/types/limiter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# A limiter is a specialized form of a counter that can be checked whether it has been exceeded and is provided fail safe. This means it can be used to guard login screens from brute force attacks without denying access in case Redis is offline.
+#
+# It will usually be used as an expiring limiter. Note that the limiter expires in total after the `expires_in` time used upon the first poke.
+#
+# It offers no guarentee that you can't poke yourself above the limit. You're responsible for checking `#exceeded?` yourself first, and this may produce a race condition. So only use this when the exact number of pokes is not critical.
+class Kredis::Types::Limiter < Kredis::Types::Counter
+  class LimitExceeded < StandardError; end
+
+  attr_accessor :limit
+
+  def poke
+    failsafe returning: true do
+      increment
+    end
+  end
+
+  def exceeded?
+    failsafe returning: false do
+      value >= limit
+    end
+  end
+end

data/lib/kredis/types/set.rb

@@ -3,10 +3,13 @@
 class Kredis::Types::Set < Kredis::Types::Proxying
   prepend Kredis::DefaultValues
 
-  proxying :smembers, :sadd, :srem, :multi, :del, :sismember, :scard, :spop, :exists?, :srandmember
+  proxying :smembers, :sadd, :srem, :multi, :del, :sismember, :scard, :spop, :exists?, :srandmember, :smove
 
   attr_accessor :typed
-
+  def move(set, member)
+    destination = set.respond_to?(:key) ? set.key : set
+    smove(destination, member)
+  end
   def members
     strings_to_types(smembers || [], typed).sort
   end

data/lib/kredis/types.rb

@@ -85,6 +85,10 @@ module Kredis::Types
     type_from(Slots, config, key, after_change: after_change, available: available)
   end
 
+  def limiter(key, limit:, expires_in: nil, config: :shared, after_change: nil)
+    type_from(Limiter, config, key, after_change: after_change, expires_in: expires_in, limit: limit)
+  end
+
   private
     def type_from(type_klass, config, key, after_change: nil, **options)
       type_klass.new(configured_for(config), namespaced_key(key), **options).then do |type|
@@ -107,3 +111,4 @@ require "kredis/types/unique_list"
 require "kredis/types/set"
 require "kredis/types/ordered_set"
 require "kredis/types/slots"
+require "kredis/types/limiter"

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.6.1"
+  VERSION = "1.8.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 - David Heinemeier Hansson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,7 +72,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description:
 email: david@hey.com
 executables: []
 extensions: []
@@ -102,6 +100,7 @@ files:
 - lib/kredis/types/enum.rb
 - lib/kredis/types/flag.rb
 - lib/kredis/types/hash.rb
+- lib/kredis/types/limiter.rb
 - lib/kredis/types/list.rb
 - lib/kredis/types/ordered_set.rb
 - lib/kredis/types/proxy.rb
@@ -117,7 +116,6 @@ homepage: https://github.com/rails/kredis
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Higher-level data structures built on Redis.
 test_files: []