kredis 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd8725b73c1bac9541b7b48ee62ebb46a8c51eaf78abe367fda75a12ee8c425
-  data.tar.gz: fcee76b43f62b3bd0a99fe7d258cb1b5edab0a8d7f408f15f7e11be01a40b219
+  metadata.gz: 72d301175c0d6bac257d10d925bddcaaa4d9fda78f0aa75264fc3b6c5a8af677
+  data.tar.gz: aa7dd573678ca4f8bb18478cf6b606fe2afc3833e6c9b9bb9b693e361f7706ee
 SHA512:
-  metadata.gz: 1bd30168c4efb0e23f65f15eb0e0b34c0b3a62a6c871da6be82192187482f0fddc55405ffb52c12f8dad4397246b55f7d292aa3bbbd8d3dc75a4fdd2e94e009e
-  data.tar.gz: 7dc32845d42347bcabe655447174d9cfb8b5e1d738fdf59af96557a455dc55ca52fced20fd76e514a21628dd725312120cbb6f0577e7925d6a6da585e77ffbf8
+  metadata.gz: e12490fc43dd3e73dcc39dfe3af5ab0f44405eae7a071b08edb14b1cba08c4b96bdb968af61072b2329e0f5e449c8c281252f4e32f423656d77bcc5ebf0e95e0
+  data.tar.gz: f047ac1e52365a7b25e10b2d2187df699abe34ced746f4d34b8e47511c019019eee3e9e6f69a5e46d58286a5ad5e38899d0db8517015d809b278ea46526f81b4

data/README.md

@@ -62,6 +62,14 @@ unique_list << "5"                             # => LREM myuniquelist 0, "5" + R
 unique_list.remove(3)                          # => LREM myuniquelist 0, "3"
 [ "4", "2", "1", "5" ] == unique_list.elements # => LRANGE myuniquelist 0, -1
 
+ordered_set = Kredis.ordered_set "myorderedset"
+ordered_set.append(%w[ 2 3 4 ])                # => ZADD myorderedset 1646131025.4953232 2 1646131025.495326 3 1646131025.4953272 4
+ordered_set.prepend(%w[ 1 2 3 4 ])             # => ZADD myorderedset -1646131025.4957051 1 -1646131025.495707 2 -1646131025.4957082 3 -1646131025.4957092 4
+ordered_set.append([])
+ordered_set << "5"                             # => ZADD myorderedset 1646131025.4960442 5
+ordered_set.remove(3)                          # => ZREM myorderedset 3
+[ "4", "2", "1", "5" ] == ordered_set.elements # => ZRANGE myorderedset 0 -1
+
 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"
 set << DateTime.tomorrow                                 # => SADD myset "2021-02-03 00:00:00 +0100"

data/lib/kredis/migration.rb

@@ -33,10 +33,10 @@ class Kredis::Migration
   def delete_all(*key_patterns)
     log_migration "DELETE ALL #{key_patterns.inspect}" do
       if key_patterns.length > 1
-        @redis.del *key_patterns
+        @redis.del(*key_patterns)
       else
         each_key_batch_matching(key_patterns.first) do |keys, pipeline|
-          pipeline.del *keys
+          pipeline.del(*keys)
         end
       end
     end

data/lib/kredis/types/ordered_set.rb

@@ -0,0 +1,75 @@
+class Kredis::Types::OrderedSet < Kredis::Types::Proxying
+  proxying :multi, :zrange, :zrem, :zadd, :zremrangebyrank, :zcard, :exists?, :del
+
+  attr_accessor :typed
+  attr_reader :limit
+
+  def elements
+    strings_to_types(zrange(0, -1) || [], typed)
+  end
+  alias to_a elements
+
+  def remove(*elements)
+    zrem(types_to_strings(elements, typed))
+  end
+
+  def prepend(elements)
+    insert(elements, prepending: true)
+  end
+
+  def append(elements)
+    insert(elements)
+  end
+  alias << append
+
+  def limit=(limit)
+    raise "Limit must be greater than 0" if limit && limit <= 0
+
+    @limit = limit
+  end
+
+  private
+    def insert(elements, prepending: false)
+      elements = Array(elements)
+      return if elements.empty?
+
+      elements_with_scores = types_to_strings(elements, typed).map.with_index do |element, index|
+        incremental_score = index * 0.000001
+
+        score = if prepending
+          -base_score - incremental_score
+        else
+          base_score + incremental_score
+        end
+
+        [ score , element ]
+      end
+
+      multi do
+        zadd(elements_with_scores)
+        trim(from_beginning: prepending)
+      end
+    end
+
+    def base_score
+      process_start_time + process_uptime
+    end
+
+    def process_start_time
+      @process_start_time ||= unproxied_redis.time.join(".").to_f - process_uptime
+    end
+
+    def process_uptime
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def trim(from_beginning:)
+      return unless limit
+
+      if from_beginning
+        zremrangebyrank(limit, -1)
+      else
+        zremrangebyrank(0, -(limit + 1))
+      end
+    end
+end

data/lib/kredis/types/proxying.rb

@@ -4,10 +4,11 @@ class Kredis::Types::Proxying
   attr_accessor :proxy, :key
 
   def self.proxying(*commands)
-    delegate *commands, to: :proxy
+    delegate(*commands, to: :proxy)
   end
 
   def initialize(redis, key, **options)
+    @redis = redis
     @key = key
     @proxy = Kredis::Types::Proxy.new(redis, key)
     options.each { |key, value| send("#{key}=", value) }
@@ -17,6 +18,12 @@ class Kredis::Types::Proxying
     proxy.suppress_failsafe_with(returning: returning, &block)
   end
 
+  def unproxied_redis
+    # Generally, this should not be used. It's only here for the rare case where we need to
+    # call Redis commands that don't reference a key and don't want to be pipelined.
+    @redis
+  end
+
   private
     delegate :type_to_string, :string_to_type, :types_to_strings, :strings_to_types, to: :Kredis
 end

data/lib/kredis/types/unique_list.rb

@@ -22,7 +22,7 @@ class Kredis::Types::UniqueList < Kredis::Types::List
     multi do
       remove elements
       super
-      ltrim -limit, -1 if limit
+      ltrim(-limit, -1) if limit
     end
   end
   alias << append

data/lib/kredis/types.rb

@@ -71,6 +71,10 @@ module Kredis::Types
     type_from(Set, config, key, after_change: after_change, typed: typed)
   end
 
+  def ordered_set(key, typed: :string, limit: nil, config: :shared, after_change: nil)
+    type_from(OrderedSet, config, key, after_change: after_change, typed: typed, limit: limit)
+  end
+
   def slot(key, config: :shared, after_change: nil)
     type_from(Slots, config, key, after_change: after_change, available: 1)
   end
@@ -99,4 +103,5 @@ require "kredis/types/hash"
 require "kredis/types/list"
 require "kredis/types/unique_list"
 require "kredis/types/set"
+require "kredis/types/ordered_set"
 require "kredis/types/slots"

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-18 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,6 +101,7 @@ files:
 - lib/kredis/types/flag.rb
 - lib/kredis/types/hash.rb
 - lib/kredis/types/list.rb
+- lib/kredis/types/ordered_set.rb
 - lib/kredis/types/proxy.rb
 - lib/kredis/types/proxy/failsafe.rb
 - lib/kredis/types/proxying.rb