kredis 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678d0983bf3cb50abb7732dc3c3e4da93764173dbdf03ce367254dbdb9297ef2
-  data.tar.gz: 7209773f020b0d1055171f30f6ff204786f3edf84e5938cd09f55789fd86e934
+  metadata.gz: c1cd3c7afcd05236cdb9ed3980d0969077f594da2fe1ca0be383610be4a4b37c
+  data.tar.gz: 912cd1ed2ff7d0b05df1fcacb07e0272ba098b86645a0607a80aa69e65107223
 SHA512:
-  metadata.gz: 2aa0b22042910eaa558f1bf8e5fed47aa7385d16ba46f63024f9311760a4f2ee74c42dadb3f333388755d1862a04999ca83cc016bf023a3e1a48491f089c7e03
-  data.tar.gz: ff37e6f461fc3117fd7d02116da43931550683581c6327a176f58d3f09ba06b2da538cd27976f01d7922a7ce7bf9768a8c03445b25e3dc62e635f3ac953093e0
+  metadata.gz: 8d7fa6004370d1d75c8b2567397ab88d65351af3d42d381cfc602d3db2a12eb10cdf0e42d190c802dea9d02fee112130cd6786ef60a125581924d82630191ebc
+  data.tar.gz: '07286763861b342cb8dd67c55f1df2e84d2496aa41a626bf23bd186ab7b8c698018cc7cb42bf65128cfb2a88eb22a9f73c84fa8a8a0516aaedb56d8c18624b19'

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
@@ -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:
@@ -195,26 +196,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 +229,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/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,36 +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, 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)

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/type/datetime.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kredis
+  module Type
+    class DateTime < ActiveModel::Type::DateTime
+      def serialize(value)
+        super&.iso8601(9)
+      end
+
+      def cast_value(value)
+        super&.to_datetime
+      end
+    end
+  end
+end

data/lib/kredis/type/json.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kredis
+  module Type
+    class Json < ActiveModel::Type::Value
+      def type
+        :json
+      end
+
+      def cast_value(value)
+        JSON.load(value)
+      end
+
+      def serialize(value)
+        JSON.dump(value)
+      end
+    end
+  end
+end

data/lib/kredis/type_casting.rb

@@ -1,47 +1,35 @@
 require "json"
+require "active_model/type"
+require "kredis/type/json"
+require "kredis/type/datetime"
 
 module Kredis::TypeCasting
   class InvalidType < StandardError; end
 
-  VALID_TYPES = %i[ string integer decimal float boolean datetime json ]
-
-  def type_to_string(value)
-    case value
-    when nil
-      ""
-    when Integer
-      value.to_s
-    when BigDecimal
-      value.to_d
-    when Float
-      value.to_s
-    when TrueClass, FalseClass
-      value ? "t" : "f"
-    when Time, DateTime, ActiveSupport::TimeWithZone
-      value.iso8601(9)
-    when Hash
-      JSON.dump(value)
-    else
-      value
-    end
+  TYPES = {
+    string: ActiveModel::Type::String.new,
+    integer: ActiveModel::Type::Integer.new,
+    decimal: ActiveModel::Type::Decimal.new,
+    float: ActiveModel::Type::Float.new,
+    boolean: ActiveModel::Type::Boolean.new,
+    datetime: Kredis::Type::DateTime.new,
+    json: Kredis::Type::Json.new
+  }
+
+  def type_to_string(value, type)
+    raise InvalidType if type && !TYPES.key?(type)
+
+    TYPES[type || :string].serialize(value)
   end
 
   def string_to_type(value, type)
-    raise InvalidType if type && !VALID_TYPES.include?(type)
-
-    case type
-    when nil, :string then value
-    when :integer     then value.to_i
-    when :decimal     then value.to_d
-    when :float       then value.to_f
-    when :boolean     then value == "t" ? true : false
-    when :datetime    then Time.iso8601(value)
-    when :json        then JSON.load(value)
-    end if value.present?
+    raise InvalidType if type && !TYPES.key?(type)
+
+    TYPES[type || :string].cast(value)
   end
 
-  def types_to_strings(values)
-    Array(values).flatten.map { |value| type_to_string(value) }
+  def types_to_strings(values, type)
+    Array(values).flatten.map { |value| type_to_string(value, type) }
   end
 
   def strings_to_types(values, type)

data/lib/kredis/types/callbacks_proxy.rb

@@ -7,7 +7,7 @@ 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 ],

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,5 +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
 
@@ -13,9 +13,8 @@ class Kredis::Types::Hash < Kredis::Types::Proxying
     update key => value
   end
 
-
   def update(**entries)
-    hset types_to_strings(entries) if entries.flatten.any?
+    hset entries.transform_values{ |val| type_to_string(val, typed) } if entries.flatten.any?
   end
 
   def values_at(*keys)
@@ -23,11 +22,11 @@ class Kredis::Types::Hash < Kredis::Types::Proxying
   end
 
   def delete(*keys)
-    hdel types_to_strings(keys) if keys.flatten.any?
+    hdel keys if keys.flatten.any?
   end
 
   def remove
-    del 
+    del
   end
 
   def entries

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
 
@@ -9,15 +9,15 @@ class Kredis::Types::List < Kredis::Types::Proxying
   alias to_a elements
 
   def remove(*elements)
-    types_to_strings(elements).each { |element| lrem 0, element }
+    types_to_strings(elements, typed).each { |element| lrem 0, element }
   end
 
   def prepend(*elements)
-    lpush types_to_strings(elements) if elements.flatten.any?
+    lpush types_to_strings(elements, typed) if elements.flatten.any?
   end
 
   def append(*elements)
-    rpush types_to_strings(elements) if elements.flatten.any?
+    rpush types_to_strings(elements, typed) if elements.flatten.any?
   end
   alias << append
 end

data/lib/kredis/types/scalar.rb

@@ -4,12 +4,12 @@ class Kredis::Types::Scalar < Kredis::Types::Proxying
   attr_accessor :typed, :default, :expires_in
 
   def value=(value)
-    set type_to_string(value), ex: expires_in
+    set type_to_string(value, typed), ex: expires_in
   end
 
   def value
     value_after_casting = string_to_type(get, typed)
-    
+
     if value_after_casting.nil?
       default
     else

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
 
@@ -9,12 +9,12 @@ class Kredis::Types::Set < Kredis::Types::Proxying
   alias to_a members
 
   def add(*members)
-    sadd types_to_strings(members) if members.flatten.any?
+    sadd types_to_strings(members, typed) if members.flatten.any?
   end
   alias << add
 
   def remove(*members)
-    srem types_to_strings(members) if members.flatten.any?
+    srem types_to_strings(members, typed) if members.flatten.any?
   end
 
   def replace(*members)
@@ -25,7 +25,7 @@ class Kredis::Types::Set < Kredis::Types::Proxying
   end
 
   def include?(member)
-    sismember type_to_string(member)
+    sismember type_to_string(member, typed)
   end
 
   def size

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
 
@@ -16,7 +16,7 @@ class Kredis::Types::UniqueList < Kredis::Types::List
     multi do
       remove elements
       super
-      ltrim (limit - 1), -1 if limit
+      ltrim -limit, -1 if limit
     end if Array(elements).flatten.any?
   end
   alias << append

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.0"
+  VERSION = "1.0.1"
 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.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kasper Timm Hansen
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2021-12-02 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
@@ -68,6 +70,8 @@ files:
 - lib/kredis/migration.rb
 - lib/kredis/namespace.rb
 - lib/kredis/railtie.rb
+- lib/kredis/type/datetime.rb
+- lib/kredis/type/json.rb
 - lib/kredis/type_casting.rb
 - lib/kredis/types.rb
 - lib/kredis/types/callbacks_proxy.rb
@@ -85,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
@@ -104,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.30
+signing_key:
 specification_version: 4
 summary: Higher-level data structures built on Redis.
 test_files: []