kredis 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4960df7b832b98970196c71cff95825187bbc49e7457ee13436a5408b841ef96
-  data.tar.gz: 3e6bf39db78519fd2a15e405a46d59cc20d0b789581487f968e7b32efd4c173f
+  metadata.gz: ef7140930b42a8d19b49568c233c1b0c9b1e799f5d8d6948e96442a2bc74e7c1
+  data.tar.gz: 205fc23eb761dba14f10ffd52506ad748b0a19c2799d75a059841d17fbe9080e
 SHA512:
-  metadata.gz: 4f5bf3d8078530a6a28a2f4f34e85f384ea3e452777902831b0bb144d28dfaa7d95c2bf7d8646c4e1eab427d5f3c293ef351eb069ca23f6bebce8a644ba6df85
-  data.tar.gz: b6a0eaa250c74167473ade0f3ea77636d19faf3dd0c26a563fb22f3adf9602d98fb159fb352a188ad1abb08f3b5f6c805a1fd5657f4b16e3484b4a8703ed3839
+  metadata.gz: e95afce53e43f5ee10f527f41854a058ccd98c34d0d52394d99addcd0e774409c5aa1bf26d06e291fc12a3f5e7e50fffdffc686ed26e2926fe36709a08da90be
+  data.tar.gz: c03d6654a1cdb7680bad60efd2287b82f4ac720362d3c65935629beeeb466c54ff08341e5016173dca19ac1bb67cf48de52c296ddfd3a17fbb6d230090c6b38a

data/README.md

@@ -109,8 +109,10 @@ enum = Kredis.enum "myenum", values: %w[ one two three ], default: "one"
 true == enum.one?               # => GET myenum
 enum.value = "two"              # => SET myenum "two"
 "two" == enum.value             # => GET myenum
+enum.three!                     # => SET myenum "three"
+"three" == enum.value           # => GET myenum
 enum.value = "four"
-"two" == enum.value             # => GET myenum
+"three" == enum.value           # => GET myenum
 enum.reset                      # => DEL myenum
 "one" == enum.value             # => GET myenum
 
@@ -168,10 +170,16 @@ You can use all these structures in models:
 ```ruby
 class Person < ApplicationRecord
   kredis_list :names
-  kredis_list :names_with_custom_key, key: ->(p) { "person:#{p.id}:names_customized" }
+  kredis_list :names_with_custom_key_via_lambda, key: ->(p) { "person:#{p.id}:names_customized" }
+  kredis_list :names_with_custom_key_via_method, key: :generate_names_key
   kredis_unique_list :skills, limit: 2
   kredis_enum :morning, values: %w[ bright blue black ], default: "bright"
   kredis_counter :steps, expires_in: 1.hour
+
+  private
+    def generate_names_key
+      "key-generated-from-private-method"
+    end
 end
 
 person = Person.find(5)
@@ -195,14 +203,17 @@ end
 
 ## Installation
 
-1. Add the `kredis` gem to your Gemfile: `gem 'kredis'`
-2. Run `./bin/bundle install`
-3. Run `./bin/rails kredis:install` to add a default configuration at [`config/redis/shared.yml`](lib/install/shared.yml)
+1. Run `./bin/bundle add kredis`
+2. Run `./bin/rails kredis:install` to add a default configuration at [`config/redis/shared.yml`](lib/install/shared.yml)
 
 Additional configurations can be added under `config/redis/*.yml` and referenced when a type is created. For example, `Kredis.string("mystring", config: :strings)` would lookup `config/redis/strings.yml`.
 
 Kredis passes the configuration to `Redis.new` to establish the connection. See the [Redis documentation](https://github.com/redis/redis-rb) for other configuration options.
 
+### Redis support
+
+Kredis works with Redis server 4.0+, with the [Redis Ruby](https://github.com/redis/redis-rb) client version 4.2+.
+
 ### Setting SSL options on Redis Connections
 
 If you need to connect to Redis with SSL, the recommended approach is to set your Redis instance manually by adding an entry to the `Kredis::Connections.connections` hash. Below an example showing how to connect to Redis using Client Authentication:

data/lib/kredis/attributes.rb

@@ -97,6 +97,7 @@ module Kredis::Attributes
       case key
       when String then key
       when Proc   then key.call(self)
+      when Symbol then send(key)
       end
     end
 

data/lib/kredis/migration.rb

@@ -10,20 +10,20 @@ class Kredis::Migration
   end
 
   def migrate_all(key_pattern)
-    each_key_batch_matching(key_pattern) do |keys|
+    each_key_batch_matching(key_pattern) do |keys, pipeline|
       keys.each do |key|
         ids = key.scan(/\d+/).map(&:to_i)
-        migrate from: key, to: yield(key, *ids)
+        migrate from: key, to: yield(key, *ids), pipeline: pipeline
       end
     end
   end
 
-  def migrate(from:, to:)
+  def migrate(from:, to:, pipeline: nil)
     namespaced_to = Kredis.namespaced_key(to)
 
     if to.present? && from != namespaced_to
       log_migration "Migrating key #{from} to #{namespaced_to}" do
-        @redis.evalsha @copy_sha, keys: [ from, namespaced_to ]
+        (pipeline || @redis).evalsha @copy_sha, keys: [ from, namespaced_to ]
       end
     else
       log_migration "Skipping blank/unaltered migration key #{from} → #{to}"
@@ -31,8 +31,8 @@ class Kredis::Migration
   end
 
   def delete_all(key_pattern)
-    each_key_batch_matching(key_pattern) do |keys|
-      @redis.del *keys
+    each_key_batch_matching(key_pattern) do |keys, pipeline|
+      pipeline.del *keys
     end
   end
 
@@ -43,7 +43,7 @@ class Kredis::Migration
       cursor = "0"
       begin
         cursor, keys = @redis.scan(cursor, match: key_pattern, count: SCAN_BATCH_SIZE)
-        @redis.pipelined { yield keys }
+        @redis.multi { |pipeline| yield keys, pipeline }
       end until cursor == "0"
     end
 

data/lib/kredis/types/callbacks_proxy.rb

@@ -4,7 +4,7 @@ class Kredis::Types::CallbacksProxy
 
   AFTER_CHANGE_OPERATIONS = {
     Kredis::Types::Counter => %i[ increment decrement reset ],
-    Kredis::Types::Cycle => %i[ next ],
+    Kredis::Types::Cycle => %i[ next reset ],
     Kredis::Types::Enum => %i[ value= reset ],
     Kredis::Types::Flag => %i[ mark remove ],
     Kredis::Types::Hash => %i[ update delete []= remove ],

data/lib/kredis/types/counter.rb

@@ -4,17 +4,17 @@ class Kredis::Types::Counter < Kredis::Types::Proxying
   attr_accessor :expires_in
 
   def increment(by: 1)
-    multi do
-      set 0, ex: expires_in, nx: true
-      incrby by
-    end
+    multi do |pipeline|
+      pipeline.set 0, ex: expires_in, nx: true
+      pipeline.incrby by
+    end[-1]
   end
 
   def decrement(by: 1)
-    multi do
-      set 0, ex: expires_in, nx: true
-      decrby by
-    end
+    multi do |pipeline|
+      pipeline.set 0, ex: expires_in, nx: true
+      pipeline.decrby by
+    end[-1]
   end
 
   def value

data/lib/kredis/types/enum.rb

@@ -28,6 +28,7 @@ class Kredis::Types::Enum < Kredis::Types::Proxying
     def define_predicates_for_values
       values.each do |defined_value|
         define_singleton_method("#{defined_value}?") { value == defined_value }
+        define_singleton_method("#{defined_value}!") { self.value = defined_value }
       end
     end
 end

data/lib/kredis/types/list.rb

@@ -8,16 +8,16 @@ class Kredis::Types::List < Kredis::Types::Proxying
   end
   alias to_a elements
 
-  def remove(*elements)
-    types_to_strings(elements, typed).each { |element| lrem 0, element }
+  def remove(*elements, pipeline: nil)
+    types_to_strings(elements, typed).each { |element| (pipeline || proxy).lrem 0, element }
   end
 
-  def prepend(*elements)
-    lpush types_to_strings(elements, typed) if elements.flatten.any?
+  def prepend(*elements, pipeline: nil)
+    (pipeline || proxy).lpush types_to_strings(elements, typed) if elements.flatten.any?
   end
 
-  def append(*elements)
-    rpush types_to_strings(elements, typed) if elements.flatten.any?
+  def append(*elements, pipeline: nil)
+    (pipeline || proxy).rpush types_to_strings(elements, typed) if elements.flatten.any?
   end
   alias << append
 

data/lib/kredis/types/proxy.rb

@@ -9,8 +9,13 @@ class Kredis::Types::Proxy
     options.each { |key, value| send("#{key}=", value) }
   end
 
-  def multi(...)
-    redis.multi(...)
+  def multi(&block)
+    # NOTE: to be removed when Redis 4 compatibility gets dropped
+    return redis.multi unless block
+
+    redis.multi do |pipeline|
+      block.call(Kredis::Types::Proxy.new(pipeline, key))
+    end
   end
 
   def method_missing(method, *args, **kwargs)

data/lib/kredis/types/set.rb

@@ -8,19 +8,19 @@ class Kredis::Types::Set < Kredis::Types::Proxying
   end
   alias to_a members
 
-  def add(*members)
-    sadd types_to_strings(members, typed) if members.flatten.any?
+  def add(*members, pipeline: nil)
+    (pipeline || proxy).sadd types_to_strings(members, typed) if members.flatten.any?
   end
   alias << add
 
-  def remove(*members)
-    srem types_to_strings(members, typed) if members.flatten.any?
+  def remove(*members, pipeline: nil)
+    (pipeline || proxy).srem types_to_strings(members, typed) if members.flatten.any?
   end
 
   def replace(*members)
-    multi do
-      del
-      add members
+    multi do |pipeline|
+      pipeline.del
+      add members, pipeline: pipeline
     end
   end
 

data/lib/kredis/types/slots.rb

@@ -19,10 +19,10 @@ class Kredis::Types::Slots < Kredis::Types::Proxying
           release
         end
       else
-        if incr <= available
+        if available?
+          incr
           true
         else
-          release
           false
         end
       end
@@ -30,16 +30,25 @@ class Kredis::Types::Slots < Kredis::Types::Proxying
   end
 
   def release
-    decr
+    if taken > 0
+      decr
+      true
+    else
+      false
+    end
   end
 
   def available?
     failsafe returning: false do
-      get.to_i < available
+      taken < available
     end
   end
 
   def reset
     del
   end
+
+  def taken
+    get.to_i
+  end
 end

data/lib/kredis/types/unique_list.rb

@@ -8,10 +8,10 @@ class Kredis::Types::UniqueList < Kredis::Types::List
     elements = Array(elements).uniq
     return if elements.empty?
 
-    multi do
-      remove elements
-      super
-      ltrim 0, (limit - 1) if limit
+    multi do |pipeline|
+      remove elements, pipeline: pipeline
+      super(elements, pipeline: pipeline)
+      pipeline.ltrim 0, (limit - 1) if limit
     end
   end
 
@@ -19,10 +19,10 @@ class Kredis::Types::UniqueList < Kredis::Types::List
     elements = Array(elements).uniq
     return if elements.empty?
 
-    multi do
-      remove elements
-      super
-      ltrim -limit, -1 if limit
+    multi do |pipeline|
+      remove elements, pipeline: pipeline
+      super(elements, pipeline: pipeline)
+      pipeline.ltrim -limit, -1 if limit
     end
   end
   alias << append

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-19 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport