kredis 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7614f548dde6852fd7e654215ba56f103fec5ac7ad6ae477fe2621f3b9964a
-  data.tar.gz: a023026462ec8a09f1e26550ce56abaeb95b1f0582665787cda48ef91e9048d1
+  metadata.gz: 6977b6ccbe9dba3574b4f0fe0c107fde3e1ff8a4e8a52f46076fe8df3acab2db
+  data.tar.gz: b3b9fb9c0e82a898168c6a9442cba36938bc4f7b9046dca16be052d28074c3ef
 SHA512:
-  metadata.gz: e3755bc5be9370676ac5b2a4a6100a26d0ed09b1248d87114911020ec1b9eb6ab094d25ec6686478069add02197d5188f59edcab04ccc69fed9bb80d1db9966f
-  data.tar.gz: 6f97f9ad814700b69b5663697add1f4b2d3468d05752c053c883ca0e8d93703b91af06f6a2593ee6ba79835435663c51c78cd17df32dafb1d7efc666150e77f6
+  metadata.gz: aa0715d6e188a7261f2f4c27f13a1b4dc919c5bf339c29435836693c3ae8df19f63ae54ff0d0ca28712f984a238df124bdc06ab268b85c88fd28179ae1534560
+  data.tar.gz: 9bb31956f1c666e64fc50c12a35b1a9ebefad8ec7f139b67c73033e745c48b8f271736b533c91eb6a4c84a892f541edb634688663219bd1285a1c3aafb996efd

data/README.md

@@ -144,7 +144,8 @@ true == flag.marked?            # => EXISTS myflag
 flag.remove                     # => DEL myflag  
 false == flag.marked?           # => EXISTS myflag
 
-flag.mark(expires_in: 1.second) #=> SET myflag 1 EX 1
+true == flag.mark(expires_in: 1.second, force: false)    #=> SET myflag 1 EX 1 NX
+false == flag.mark(expires_in: 10.seconds, force: false) #=> SET myflag 10 EX 1 NX
 true == flag.marked?            #=> EXISTS myflag
 sleep 0.5.seconds
 true == flag.marked?            #=> EXISTS myflag
@@ -174,9 +175,9 @@ end
 
 person = Person.find(5)
 person.names.append "David", "Heinemeier", "Hansson" # => RPUSH people:5:names "David" "Heinemeier" "Hansson"
-true == person.morning.bright?                       # => GET people:1:morning
-person.morning.value = "blue"                        # => SET people:1:morning
-true == person.morning.blue?                         # => GET people:1:morning
+true == person.morning.bright?                       # => GET people:5:morning
+person.morning.value = "blue"                        # => SET people:5:morning
+true == person.morning.blue?                         # => GET people:5:morning
 ```
 
 You can also define `after_change` callbacks that trigger on mutations:
@@ -243,6 +244,16 @@ Kredis::Connections.connections[:shared] = Redis.new(
 
 The above code could be added to either `config/environments/production.rb` or an initializer. Please ensure that your client private key, if used, is stored your credentials file or another secure location.
 
+### Configure how the redis client is created
+
+You can configure how the redis client is created by setting `config.connector` in your `application.rb`:
+
+```ruby
+config.kredis.connector = ->(config) { SomeRedisProxy.new(config) }
+```
+
+By default Kredis will use `Redis.new(config)`.
+
 ## License
 
 Kredis is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/kredis/attributes.rb

@@ -22,8 +22,8 @@ module Kredis::Attributes
       kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_flag(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_flag(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
 
       define_method("#{name}?") do
         send(name).marked?

data/lib/kredis/connections.rb

@@ -3,11 +3,12 @@ require "redis"
 module Kredis::Connections
   mattr_accessor :connections, default: Hash.new
   mattr_accessor :configurator
+  mattr_accessor :connector, default: ->(config) { Redis.new(config) }
 
   def configured_for(name)
     connections[name] ||= begin
       Kredis.instrument :meta, message: "Connected to #{name}" do
-        Redis.new configurator.config_for("redis/#{name}")
+        connector.call configurator.config_for("redis/#{name}")
       end
     end
   end

data/lib/kredis/railtie.rb

@@ -12,6 +12,10 @@ class Kredis::Railtie < ::Rails::Railtie
     Kredis::LogSubscriber.logger = config.kredis.logger || Rails.logger
   end
 
+  initializer "kredis.configuration" do
+    Kredis::Connections.connector = config.kredis.connector || ->(config) { Redis.new(config) }
+  end
+
   initializer "kredis.configurator" do
     Kredis.configurator = Rails.application
   end

data/lib/kredis/types/counter.rb

@@ -1,5 +1,5 @@
 class Kredis::Types::Counter < Kredis::Types::Proxying
-  proxying :multi, :set, :incrby, :decrby, :get, :del
+  proxying :multi, :set, :incrby, :decrby, :get, :del, :exists?
 
   attr_accessor :expires_in
 

data/lib/kredis/types/enum.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/object/inclusion"
 
 class Kredis::Types::Enum < Kredis::Types::Proxying
-  proxying :set, :get, :del
+  proxying :set, :get, :del, :exists?
 
   attr_accessor :values, :default
 

data/lib/kredis/types/flag.rb

@@ -1,8 +1,10 @@
 class Kredis::Types::Flag < Kredis::Types::Proxying
   proxying :set, :exists?, :del
 
-  def mark(expires_in: nil)
-    set 1, ex: expires_in
+  attr_accessor :expires_in
+
+  def mark(expires_in: nil, force: true)
+    set 1, ex: expires_in || self.expires_in, nx: !force
   end
 
   def marked?

data/lib/kredis/types/hash.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/hash"
 
 class Kredis::Types::Hash < Kredis::Types::Proxying
-  proxying :hget, :hset, :hmget, :hdel, :hgetall, :hkeys, :hvals, :del
+  proxying :hget, :hset, :hmget, :hdel, :hgetall, :hkeys, :hvals, :del, :exists?
 
   attr_accessor :typed
 

data/lib/kredis/types/list.rb

@@ -1,5 +1,5 @@
 class Kredis::Types::List < Kredis::Types::Proxying
-  proxying :lrange, :lrem, :lpush, :rpush
+  proxying :lrange, :lrem, :lpush, :rpush, :exists?
 
   attr_accessor :typed
 

data/lib/kredis/types/set.rb

@@ -1,5 +1,5 @@
 class Kredis::Types::Set < Kredis::Types::Proxying
-  proxying :smembers, :sadd, :srem, :multi, :del, :sismember, :scard, :spop
+  proxying :smembers, :sadd, :srem, :multi, :del, :sismember, :scard, :spop, :exists?
 
   attr_accessor :typed
 

data/lib/kredis/types/slots.rb

@@ -1,7 +1,7 @@
 class Kredis::Types::Slots < Kredis::Types::Proxying
   class NotAvailable < StandardError; end
 
-  proxying :incr, :decr, :get, :del
+  proxying :incr, :decr, :get, :del, :exists?
 
   attr_accessor :available
 

data/lib/kredis/types/unique_list.rb

@@ -1,6 +1,6 @@
 # You'd normally call this a set, but Redis already has another data type for that
 class Kredis::Types::UniqueList < Kredis::Types::List
-  proxying :multi, :ltrim
+  proxying :multi, :ltrim, :exists?
 
   attr_accessor :typed, :limit
 

data/lib/kredis/types.rb

@@ -47,8 +47,8 @@ module Kredis::Types
     type_from(Cycle, config, key, after_change: after_change, values: values, expires_in: expires_in)
   end
 
-  def flag(key, config: :shared, after_change: nil)
-    type_from(Flag, config, key, after_change: after_change)
+  def flag(key, config: :shared, after_change: nil, expires_in: nil)
+    type_from(Flag, config, key, after_change: after_change, expires_in: expires_in)
   end
 
   def enum(key, values:, default:, config: :shared, after_change: nil)

data/lib/kredis/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: 
+description:
 email: david@hey.com
 executables: []
 extensions: []
@@ -91,7 +91,7 @@ homepage: https://github.com/rails/kredis
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Higher-level data structures built on Redis.
 test_files: []