kredis 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6977b6ccbe9dba3574b4f0fe0c107fde3e1ff8a4e8a52f46076fe8df3acab2db
-  data.tar.gz: b3b9fb9c0e82a898168c6a9442cba36938bc4f7b9046dca16be052d28074c3ef
+  metadata.gz: ef7140930b42a8d19b49568c233c1b0c9b1e799f5d8d6948e96442a2bc74e7c1
+  data.tar.gz: 205fc23eb761dba14f10ffd52506ad748b0a19c2799d75a059841d17fbe9080e
 SHA512:
-  metadata.gz: aa0715d6e188a7261f2f4c27f13a1b4dc919c5bf339c29435836693c3ae8df19f63ae54ff0d0ca28712f984a238df124bdc06ab268b85c88fd28179ae1534560
-  data.tar.gz: 9bb31956f1c666e64fc50c12a35b1a9ebefad8ec7f139b67c73033e745c48b8f271736b533c91eb6a4c84a892f541edb634688663219bd1285a1c3aafb996efd
+  metadata.gz: e95afce53e43f5ee10f527f41854a058ccd98c34d0d52394d99addcd0e774409c5aa1bf26d06e291fc12a3f5e7e50fffdffc686ed26e2926fe36709a08da90be
+  data.tar.gz: c03d6654a1cdb7680bad60efd2287b82f4ac720362d3c65935629beeeb466c54ff08341e5016173dca19ac1bb67cf48de52c296ddfd3a17fbb6d230090c6b38a

data/README.md

@@ -105,24 +105,26 @@ cycle.next                      # => GET mycycle + SET mycycle 0
 :one == cycle.value             # => GET mycycle
 
 enum = Kredis.enum "myenum", values: %w[ one two three ], default: "one"
-"one" == enum.value             # => GET myenum  
+"one" == enum.value             # => GET myenum
 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  
+"one" == enum.value             # => GET myenum
 
 slots = Kredis.slots "myslots", available: 3
 true == slots.available?        # => GET myslots
 slots.reserve                   # => INCR myslots
 true == slots.available?        # => GET myslots
-slots.reserve                   # => INCR myslots     
+slots.reserve                   # => INCR myslots
 true == slots.available?        # => GET myslots
 slots.reserve                   # => INCR myslots
 false == slots.available?       # => GET myslots
-slots.reserve                   # => INCR myslots + DECR myslots  
+slots.reserve                   # => INCR myslots + DECR myslots
 false == slots.available?       # => GET myslots
 slots.release                   # => DECR myslots
 true == slots.available?        # => GET myslots
@@ -141,7 +143,7 @@ flag = Kredis.flag "myflag"
 false == flag.marked?           # => EXISTS myflag
 flag.mark                       # => SET myflag 1
 true == flag.marked?            # => EXISTS myflag
-flag.remove                     # => DEL myflag  
+flag.remove                     # => DEL myflag
 false == flag.marked?           # => EXISTS myflag
 
 true == flag.mark(expires_in: 1.second, force: false)    #=> SET myflag 1 EX 1 NX
@@ -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,28 +203,16 @@ end
 
 ## Installation
 
-1. Add the `kredis` gem to your Gemfile: `gem 'kredis'`
-2. Run `./bin/bundle install`
-3. Add a default configuration under `config/redis/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)
 
-A default configuration can look like this for `config/redis/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`.
 
-```yaml
-production: &production
-  host: <%= ENV.fetch("REDIS_SHARED_HOST", "127.0.0.1") %>
-  port: <%= ENV.fetch("REDIS_SHARED_PORT", "6379") %>
-  timeout: 1
+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.
 
-development: &development
-  host: <%= ENV.fetch("REDIS_SHARED_HOST", "127.0.0.1") %>
-  port: <%= ENV.fetch("REDIS_SHARED_PORT", "6379") %>
-  timeout: 1
-
-test:
-  <<: *development
-```
+### Redis support
 
-Additional configurations can be added under `config/redis/*.yml` and referenced when a type is created, e.g. `Kredis.string("mystring", config: :strings)` would lookup `config/redis/strings.yml`. Under the hood `Kredis.configured_for` is called which'll pass the configuration on to `Redis.new`.
+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
 
@@ -246,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/install/install.rb

@@ -0,0 +1,6 @@
+yaml_path = Rails.root.join("config/redis/shared.yml")
+unless yaml_path.exist?
+  say "Adding `config/redis/shared.yml`"
+  empty_directory yaml_path.parent.to_s
+  copy_file "#{__dir__}/shared.yml", yaml_path
+end

data/lib/install/shared.yml

@@ -0,0 +1,15 @@
+production: &production
+  url: <%= ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379/0") %>
+  timeout: 1
+
+development: &development
+  url: <%= ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379/0") %>
+  timeout: 1
+
+  # You can also specify host, port, and db instead of url
+  # host: <%= ENV.fetch("REDIS_SHARED_HOST", "127.0.0.1") %>
+  # port: <%= ENV.fetch("REDIS_SHARED_PORT", "6379") %>
+  # db: <%= ENV.fetch("REDIS_SHARED_DB", "11") %>
+
+test:
+  <<: *development

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,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/railtie.rb

@@ -30,4 +30,9 @@ class Kredis::Railtie < ::Rails::Railtie
       include Kredis::Attributes
     end
   end
+
+  rake_tasks do
+    path = File.expand_path("..", __dir__)
+    Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+  end
 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 ],
+    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

@@ -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/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, :rpush, :exists?, :del
 
   attr_accessor :typed
 
@@ -8,16 +8,20 @@ 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
+
+  def clear
+    del
+  end
 end

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

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

data/lib/kredis/version.rb

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

data/lib/tasks/kredis/install.rake

@@ -0,0 +1,6 @@
+namespace :kredis do
+  desc "Install kredis"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/install.rb",  __dir__)}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,6 +61,8 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- lib/install/install.rb
+- lib/install/shared.yml
 - lib/kredis.rb
 - lib/kredis/attributes.rb
 - lib/kredis/connections.rb
@@ -87,6 +89,7 @@ files:
 - lib/kredis/types/slots.rb
 - lib/kredis/types/unique_list.rb
 - lib/kredis/version.rb
+- lib/tasks/kredis/install.rake
 homepage: https://github.com/rails/kredis
 licenses:
 - MIT
@@ -106,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Higher-level data structures built on Redis.