kredis 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1cd3c7afcd05236cdb9ed3980d0969077f594da2fe1ca0be383610be4a4b37c
-  data.tar.gz: 912cd1ed2ff7d0b05df1fcacb07e0272ba098b86645a0607a80aa69e65107223
+  metadata.gz: 3e96a50da4e56bf4088baa6bb6cb7583820ca235a52139b4aa9144b9f9d8585b
+  data.tar.gz: f975deffae4581e3a5d8c208ac2c1bed13686b7d4c1c367289b3f8e5f803b235
 SHA512:
-  metadata.gz: 8d7fa6004370d1d75c8b2567397ab88d65351af3d42d381cfc602d3db2a12eb10cdf0e42d190c802dea9d02fee112130cd6786ef60a125581924d82630191ebc
-  data.tar.gz: '07286763861b342cb8dd67c55f1df2e84d2496aa41a626bf23bd186ab7b8c698018cc7cb42bf65128cfb2a88eb22a9f73c84fa8a8a0516aaedb56d8c18624b19'
+  metadata.gz: ffc338f0f5f0d975c85d5b207c0ace88bd96d7f5047bd0bcd5ad7b600b1e0165df30d6c8af3ef6f51f89b97ea0bf696a2a440b337921076f5676d5562323761e
+  data.tar.gz: de2eb9f5e51df31f9765b2dc5dec59105dc61019818aacacaecc6f1df9a0e99547c5d684baae17f14eeaee1acb64c12a9fb0de919741bffde71e3b55746218f4

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,9 +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)
@@ -194,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:
@@ -231,7 +243,7 @@ The above code could be added to either `config/environments/production.rb` or a
 
 ### Configure how the redis client is created
 
-You can configure how the redis client is created by setting `config.connector` in your `application.rb`:
+You can configure how the redis client is created by setting `config.kredis.connector` in your `application.rb`:
 
 ```ruby
 config.kredis.connector = ->(config) { SomeRedisProxy.new(config) }

data/lib/kredis/attributes.rb

@@ -62,14 +62,18 @@ module Kredis::Attributes
       kredis_connection_with __method__, name, key, available: available, config: config, after_change: after_change
     end
 
-    def kredis_counter(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_counter(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
     end
 
     def kredis_hash(name, key: nil, typed: :string, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, typed: typed, config: config, after_change: after_change
     end
 
+    def kredis_boolean(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    end
+
     private
       def kredis_connection_with(method, name, key, **options)
         ivar_symbol = :"@#{name}_#{method}"
@@ -93,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,29 +10,35 @@ 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}"
     end
   end
 
-  def delete_all(key_pattern)
-    each_key_batch_matching(key_pattern) do |keys|
-      @redis.del *keys
+  def delete_all(*key_patterns)
+    log_migration "DELETE ALL #{key_patterns.inspect}" do
+      if key_patterns.length > 1
+        @redis.del *key_patterns
+      else
+        each_key_batch_matching(key_patterns.first) do |keys, pipeline|
+          pipeline.del *keys
+        end
+      end
     end
   end
 
@@ -43,7 +49,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,14 +4,15 @@ 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 ],
     Kredis::Types::List => %i[ remove prepend append << ],
     Kredis::Types::Scalar => %i[ value= clear ],
     Kredis::Types::Set => %i[ add << remove replace take clear ],
-    Kredis::Types::Slots => %i[ reserve release reset ]
+    Kredis::Types::Slots => %i[ reserve release reset ],
+    Kredis::Types::UniqueList => %i[ remove prepend append << ]
   }
 
   def initialize(type, callback)

data/lib/kredis/types/counter.rb

@@ -7,14 +7,14 @@ class Kredis::Types::Counter < Kredis::Types::Proxying
     multi do
       set 0, ex: expires_in, nx: true
       incrby by
-    end
+    end[-1]
   end
 
   def decrement(by: 1)
     multi do
       set 0, ex: expires_in, nx: true
       decrby by
-    end
+    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/hash.rb

@@ -28,6 +28,7 @@ class Kredis::Types::Hash < Kredis::Types::Proxying
   def remove
     del
   end
+  alias clear remove
 
   def entries
     (hgetall || {}).transform_values { |val| string_to_type(val, typed) }.with_indifferent_access

data/lib/kredis/types/list.rb

@@ -1,5 +1,5 @@
 class Kredis::Types::List < Kredis::Types::Proxying
-  proxying :lrange, :lrem, :lpush, :rpush, :exists?
+  proxying :lrange, :lrem, :lpush, :ltrim, :rpush, :exists?, :del
 
   attr_accessor :typed
 
@@ -20,4 +20,8 @@ class Kredis::Types::List < Kredis::Types::Proxying
     rpush types_to_strings(elements, typed) if elements.flatten.any?
   end
   alias << append
+
+  def clear
+    del
+  end
 end

data/lib/kredis/types/proxy.rb

@@ -2,15 +2,22 @@ class Kredis::Types::Proxy
   require_relative "proxy/failsafe"
   include Failsafe
 
-  attr_accessor :redis, :key
+  attr_accessor :key
+
+  thread_mattr_accessor :pipeline
 
   def initialize(redis, key, **options)
     @redis, @key = redis, key
     options.each { |key, value| send("#{key}=", value) }
   end
 
-  def multi(...)
-    redis.multi(...)
+  def multi(*args, **kwargs, &block)
+    redis.multi(*args, **kwargs) do |pipeline|
+      self.pipeline = pipeline
+      block.call
+    ensure
+      self.pipeline = nil
+    end
   end
 
   def method_missing(method, *args, **kwargs)
@@ -22,6 +29,10 @@ class Kredis::Types::Proxy
   end
 
   private
+    def redis
+      pipeline || @redis
+    end
+
     def log_message(method, *args, **kwargs)
       args      = args.flatten.reject(&:blank?).presence
       kwargs    = kwargs.reject { |_k, v| v.blank? }.presence

data/lib/kredis/types/proxying.rb

@@ -1,14 +1,14 @@
 require "active_support/core_ext/module/delegation"
 
 class Kredis::Types::Proxying
-  attr_accessor :proxy, :redis, :key
+  attr_accessor :proxy, :key
 
   def self.proxying(*commands)
     delegate *commands, to: :proxy
   end
 
   def initialize(redis, key, **options)
-    @redis, @key = redis, key
+    @key = key
     @proxy = Kredis::Types::Proxy.new(redis, key)
     options.each { |key, value| send("#{key}=", value) }
   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

@@ -5,19 +5,25 @@ class Kredis::Types::UniqueList < Kredis::Types::List
   attr_accessor :typed, :limit
 
   def prepend(elements)
+    elements = Array(elements).uniq
+    return if elements.empty?
+
     multi do
       remove elements
       super
       ltrim 0, (limit - 1) if limit
-    end if Array(elements).flatten.any?
+    end
   end
 
   def append(elements)
+    elements = Array(elements).uniq
+    return if elements.empty?
+
     multi do
       remove elements
       super
       ltrim -limit, -1 if limit
-    end if Array(elements).flatten.any?
+    end
   end
   alias << append
 end

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.0.1"
+  VERSION = "1.3.0"
 end

data/lib/kredis.rb

@@ -1,5 +1,6 @@
 require "active_support"
 require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 require "kredis/version"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -29,16 +29,22 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.30
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Higher-level data structures built on Redis.