kredis 0.3.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26f56df1898716dc3a37d357857dcf9418709d826a5efdbf7d46f03bac29fcb
-  data.tar.gz: efb14c911678c9205c54aa06030371a8b0a12944bb93b9e4ba2d83d259321a10
+  metadata.gz: 4960df7b832b98970196c71cff95825187bbc49e7457ee13436a5408b841ef96
+  data.tar.gz: 3e6bf39db78519fd2a15e405a46d59cc20d0b789581487f968e7b32efd4c173f
 SHA512:
-  metadata.gz: ea3c23f42567b578efe70cf266c13202b1c8f51284baabaec040091268ec7b6804939892cf99883dd7601c380efd3eb3ec76092945b89d77b0e412c1f4749b35
-  data.tar.gz: 3b44e4b1d721374be329e567623e1a0d40918173897ca0b688f1bc4c9d2452791ffce2361c95d51f82fd9b726c1a6be7abb636fd5d4907e334227ab9051cedd8
+  metadata.gz: 4f5bf3d8078530a6a28a2f4f34e85f384ea3e452777902831b0bb144d28dfaa7d95c2bf7d8646c4e1eab427d5f3c293ef351eb069ca23f6bebce8a644ba6df85
+  data.tar.gz: b6a0eaa250c74167473ade0f3ea77636d19faf3dd0c26a563fb22f3adf9602d98fb159fb352a188ad1abb08f3b5f6c805a1fd5657f4b16e3484b4a8703ed3839

data/README.md

@@ -105,24 +105,24 @@ 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.value = "four"
 "two" == 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,10 +141,11 @@ 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
 
-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
@@ -170,13 +171,14 @@ class Person < ApplicationRecord
   kredis_list :names_with_custom_key, key: ->(p) { "person:#{p.id}:names_customized" }
   kredis_unique_list :skills, limit: 2
   kredis_enum :morning, values: %w[ bright blue black ], default: "bright"
+  kredis_counter :steps, expires_in: 1.hour
 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:
@@ -195,26 +197,11 @@ end
 
 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`
-
-A default configuration can look like this for `config/redis/shared.yml`:
-
-```yaml
-production: &production
-  host: <%= ENV.fetch("REDIS_SHARED_HOST", "127.0.0.1") %>
-  port: <%= ENV.fetch("REDIS_SHARED_PORT", "6379") %>
-  timeout: 1
+3. Run `./bin/rails kredis:install` to add a default configuration at [`config/redis/shared.yml`](lib/install/shared.yml)
 
-development: &development
-  host: <%= ENV.fetch("REDIS_SHARED_HOST", "127.0.0.1") %>
-  port: <%= ENV.fetch("REDIS_SHARED_PORT", "6379") %>
-  timeout: 1
+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`.
 
-test:
-  <<: *development
-```
-
-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 passes the configuration to `Redis.new` to establish the connection. See the [Redis documentation](https://github.com/redis/redis-rb) for other configuration options.
 
 ### Setting SSL options on Redis Connections
 
@@ -243,6 +230,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.kredis.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/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

@@ -6,40 +6,40 @@ module Kredis::Attributes
       kredis_connection_with __method__, name, key, config: config, after_change: after_change
     end
 
-    def kredis_string(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_string(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_integer(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_integer(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_decimal(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_decimal(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_datetime(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_datetime(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_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?
       end
     end
 
-    def kredis_float(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_float(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_enum(name, key: nil, values:, default:, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, values: values, default: default, config: config, after_change: after_change
     end
 
-    def kredis_json(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_json(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_list(name, key: nil, typed: :string, config: :shared, after_change: nil)
@@ -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}"

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
@@ -26,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

@@ -7,11 +7,12 @@ class Kredis::Types::CallbacksProxy
     Kredis::Types::Cycle => %i[ next ],
     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

@@ -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
 
@@ -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
+  proxying :lrange, :lrem, :lpush, :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/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,23 +1,29 @@
 # 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
 
   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), -1 if limit
-    end if Array(elements).flatten.any?
+      ltrim -limit, -1 if limit
+    end
   end
   alias << append
 end

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.3.1"
+  VERSION = "1.1.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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2022-02-19 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: []
@@ -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,11 +89,12 @@ 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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,8 +109,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.32
+signing_key:
 specification_version: 4
 summary: Higher-level data structures built on Redis.
 test_files: []