kredis 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aa90994f3d30a19d52df3fbc284d43d2637e940de06f221ecffc2853eeda459
-  data.tar.gz: 713137c0ec2c28bfb80df9c94b3e61c4b8f5906c9d68631fd5e26e4ac8ef0771
+  metadata.gz: 8f1ad5de0aa1b64c083109609ec185ea81e35b3550fced4347f5bff12ff35832
+  data.tar.gz: 85d287eb15524b0b668524a51820ffb3a64d4bccda398f07802abb5867b49b92
 SHA512:
-  metadata.gz: afcbb020c7e7c412090a7798c433882adf7d54e293728eff3a7d39b655d41531a3bae5f307ea10faa72a39e6ed1cb1f7db1f3f6535351299d26f65fd20e728fb
-  data.tar.gz: 7de324aa868056600c28d82911ef654c7d9f58c5d85823ab1271a7518c76f9dbb31a2be23082cb9ab2bf210401eac0ceca698412a38f01779af310bcf5893624
+  metadata.gz: cfb7cfa924d9a6ecb79febf81cc2b2479694b0e275219d53e031b01fe2296a23862eee96f6359d05f33fc333808638b39c187c9f641252de3435488df3f6e372
+  data.tar.gz: cd06423690991d2a5364804e240aac27b88f792bc951623ce1e5f4f5a17946b817a05cfda9a4defb831e8e6c1d79ee0c3ab8523342d94c3a2259caca8609f1d9

data/README.md

@@ -9,29 +9,41 @@ Kredis provides namespacing support for keys such that you can safely run parall
 
 ## Examples
 
-Kredis provides typed scalars for strings, integers, decimals, floats, booleans, datetimes, and json hashes:
+Kredis provides typed scalars for strings, integers, decimals, floats, booleans, datetimes, and JSON hashes:
 
 ```ruby
 string = Kredis.string "mystring"
 string.value = "hello world!"  # => SET mystring "hello world"
 "hello world!" == string.value # => GET mystring
 
-integer = Kredis.string "myinteger"
+integer = Kredis.integer "myinteger"
 integer.value = 5  # => SET myinteger "5"
-5 == string.value # => GET myinteger
+5 == integer.value # => GET myinteger
 
 json = Kredis.json "myjson"
-integer.value = { "one" => 1, "two" => "2" }  # => SET myjson "{\"one\":1,\"two\":\"2\"}"
-{ "one" => 1, "two" => "2" } == string.value  # => GET myjson
+json.value = { "one" => 1, "two" => "2" }  # => SET myjson "{\"one\":1,\"two\":\"2\"}"
+{ "one" => 1, "two" => "2" } == json.value  # => GET myjson
 ```
 
-There are data structures for counters, enums, flags, lists, uniqe lists, sets, and slots:
+There are data structures for counters, enums, flags, lists, unique lists, sets, and slots:
 
 ```ruby
-list = Kredis.list "mylist", typed: :integer
-list.append([ 1, 2, 3 ])        # => LPUSH mylist "1" "2" "3"
-list << 4                       # => LPUSH mylist "4"
-[ 1, 2, 3, 4 ] == list.elements # LRANGE 0 -1
+list = Kredis.list "mylist"
+list << "hello world!"
+[ "hello world!" ] == list.elements
+
+integer_list = Kredis.list "myintegerlist", typed: :integer
+integer_list.append([ 1, 2, 3 ])        # => LPUSH myintegerlist "1" "2" "3"
+integer_list << 4                       # => LPUSH myintegerlist "4"
+[ 1, 2, 3, 4 ] == integer_list.elements # LRANGE 0 -1
+
+unique_list = Kredis.unique_list "myuniquelist"
+unique_list.append(%w[ 2 3 4 ])
+unique_list.prepend(%w[ 1 2 3 4 ])
+unique_list.append([])
+unique_list << "5"
+unique_list.remove(3)
+[ "1", "2", "4", "5" ] == unique_list.elements
 
 set = Kredis.set "myset", typed: :datetime
 set.add(DateTime.tomorrow, DateTime.yesterday)            # => SADD myset "2021-02-03 00:00:00 +0100" "2021-02-01 00:00:00 +0100"
@@ -39,11 +51,66 @@ set << DateTime.tomorrow                                  # => SADD myset "2021-
 2 == set.size                                             # => SCARD myset
 [ DateTime.tomorrow, DateTime.yesterday ] == set.elements # => SMEMBERS myset
 
-counter = Kredis.counter "mycounter", expires_in: 15.minutes
+head_count = Kredis.counter "headcount"
+0 == head_count.value              # => GET "headcount"
+head_count.increment
+head_count.increment
+head_count.decrement
+1 == head_count.value              # => GET "headcount"
+
+counter = Kredis.counter "mycounter", expires_in: 5.seconds
 counter.increment by: 2         # => SETEX "mycounter" 900 0 + INCR "mycounter" 2
 2 == counter.value              # => GET "mycounter"
-travel 16.minutes
+sleep 6.seconds
 0 == counter.value              # => GET "mycounter"
+
+enum = Kredis.enum "myenum", values: %w[ one two three ], default: "one"
+"one" == enum.value
+true == enum.one?
+enum.value = "two"
+"two" == enum.value
+enum.value = "four"
+"two" == enum.value
+enum.reset
+"one" == enum.value
+
+slots = Kredis.slots "myslots", available: 3
+true == slots.available?
+slots.reserve
+true == slots.available?
+slots.reserve
+true == slots.available?
+slots.reserve
+true == slots.available?
+slots.reserve
+false == slots.available?
+slots.release
+true == slots.available?
+slots.reset
+
+flag = Kredis.flag "myflag"
+false == flag.marked?
+flag.mark
+true == flag.marked?
+flag.remove
+false == flag.marked?
+
+flag.mark(expires_in: 1.second)
+true == flag.marked?
+sleep 0.5.seconds
+true == flag.marked?
+sleep 0.6.seconds
+false == flag.marked?
+```
+
+And using structures on a different than the default `shared` redis instance, relying on `config/redis/secondary.yml`:
+
+```ruby
+one_string = Kredis.string "mystring"
+two_string = Kredis.string "mystring", config: :secondary
+
+one_string.value = "just on shared"
+two_string.value != one_string.value
 ```
 
 You can use all these structures in models:

data/lib/kredis/attributes.rb

@@ -78,6 +78,10 @@ module Kredis::Attributes
     end
 
     def kredis_key_for_attribute(name)
-      "#{self.class.name.tableize.gsub("/", ":")}:#{id}:#{name}"
+      "#{self.class.name.tableize.gsub("/", ":")}:#{extract_kredis_id}:#{name}"
+    end
+
+    def extract_kredis_id
+      try(:id) or raise NotImplementedError, "kredis needs a unique id, either implement an id method or pass a custom key."
     end
 end

data/lib/kredis/migration.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/module/delegation"
 
 class Kredis::Migration
-  singleton_class.delegate :migrate_all, :migrate, to: :new
+  singleton_class.delegate :migrate_all, :migrate, :delete_all, to: :new
 
   def initialize(config = :shared)
     @redis = Kredis.configured_for config
@@ -9,35 +9,39 @@ class Kredis::Migration
   end
 
   def migrate_all(key_pattern)
-    find_keys_in_batches_matching(key_pattern) do |keys|
-      @redis.multi do
-        keys.each do |key|
-          ids = key.scan(/\d+/).map(&:to_i)
-          migrate from: key, to: yield(key, *ids)
-        end
+    each_key_batch_matching(key_pattern) do |keys|
+      keys.each do |key|
+        ids = key.scan(/\d+/).map(&:to_i)
+        migrate from: key, to: yield(key, *ids)
       end
     end
   end
 
   def migrate(from:, to:)
-    to = Kredis.namespaced_key(to)
+    namespaced_to = Kredis.namespaced_key(to)
 
-    if from != to
-      log_migration "Migrating key #{from} to #{to}"
-      @redis.evalsha @copy_sha, keys: [ from, to ]
+    if to.present? && from != namespaced_to
+      log_migration "Migrating key #{from} to #{namespaced_to}"
+      @redis.evalsha @copy_sha, keys: [ from, namespaced_to ]
     else
-      log_migration "Skipping unaltered migration key #{from}"
+      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
     end
   end
 
   private
     SCAN_BATCH_SIZE = 1_000
 
-    def find_keys_in_batches_matching(key_pattern, &block)
+    def each_key_batch_matching(key_pattern, &block)
       cursor = "0"
       begin
         cursor, keys = @redis.scan(cursor, match: key_pattern, count: SCAN_BATCH_SIZE)
-        yield keys
+        @redis.multi { yield keys }
       end until cursor == "0"
     end
 

data/lib/kredis/railtie.rb

@@ -20,9 +20,9 @@ module Kredis
     end
 
     initializer "kredis.attributes" do
-      # TODO: Add run_load_hooks to ActiveModel::Model so this runs.
-      ActiveSupport.on_load(:active_model) do
-        include Kredis::Attributes
+      # No load hook for Active Model, just defer until after initialization.
+      config.after_initialize do
+        ActiveModel::Model.include Kredis::Attributes if defined?(ActiveModel::Model)
       end
 
       ActiveSupport.on_load(:active_record) do

data/lib/kredis/types/counter.rb

@@ -1,5 +1,5 @@
 class Kredis::Types::Counter < Kredis::Types::Proxying
-  proxying :multi, :set, :incrby, :get
+  proxying :multi, :set, :incrby, :decrby, :get
 
   attr_accessor :expires_in
 
@@ -10,6 +10,13 @@ class Kredis::Types::Counter < Kredis::Types::Proxying
     end
   end
 
+  def decrement(by: 1)
+    multi do
+      set 0, ex: expires_in, nx: true
+      decrby by
+    end
+  end
+
   def value
     get.to_i
   end

data/lib/kredis/types/proxy.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/enumerable"
+
 class Kredis::Types::Proxy
   attr_accessor :redis, :key
 

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 description: 
 email: david@hey.com
 executables: []
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="