Merge remote-tracking branch 'origin/main' into default-values-on-initialize

lewispb · lewispb · commit 4b1ab120aeba · 2023-07-08T13:48:58.000+01:00
* origin/main: (22 commits) Add kredis_ordered_set for OrderedSet usage in models Add a development console Bump version for 1.5.0 Fix ordered set prepend bug (#115) Unique list with sorted set (#114) Eliminating Ruby Warnings (#112) CI against Redis 7, Ruby 3.1, and Ruby 3.2 (#113) Bump version for 1.4.0 Update nokogiri for compatibility Revert "Improved version of UniqueList: OrderedSet (#76)" (#111) Add `last` to lists (#97) Improved version of UniqueList: OrderedSet (#76) Return Time objects instead of deprecated DateTime (#106) Fix possible deserialization of untrusted data Typecast return of Set#take (#105) Declare Active Model dependency (#107) Address LogSubscriber deprecation (#98) Account for time zones in DateTime serializations (#102) Add sample to set (#100) Bump version for 1.3.0 ...
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,13 +5,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        redis_server: ["4", "5", "6.2"]
-        ruby: ["2.7", "3.0"]
+        redis_server: ["4", "5", "6", "7"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
 
     name: Redis server ${{ matrix.redis_server }} - Ruby ${{ matrix.ruby }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    kredis (1.2.0)
+    kredis (1.5.0)
+      activemodel (>= 6.0.0)
       activesupport (>= 6.0.0)
-      redis (~> 4.2)
+      redis (>= 4.2, < 6)
 
 GEM
   remote: https://rubygems.org/
@@ -70,6 +71,7 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     concurrent-ruby (1.1.8)
+    connection_pool (2.4.1)
     crass (1.0.6)
     erubi (1.10.0)
     globalid (0.4.2)
@@ -84,17 +86,17 @@ GEM
     marcel (1.0.1)
     method_source (1.0.0)
     mini_mime (1.0.3)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.8.2)
     minitest (5.14.4)
     nio4r (2.5.7)
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.11.2-arm64-darwin)
+    nokogiri (1.15.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.11.2-x86_64-darwin)
+    nokogiri (1.15.2-x86_64-darwin)
       racc (~> 1.4)
-    racc (1.5.2)
+    racc (1.7.1)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -125,7 +127,10 @@ GEM
       rake (>= 0.8.7)
       thor (~> 1.0)
     rake (13.0.3)
-    redis (4.6.0)
+    redis (5.0.6)
+      redis-client (>= 0.9.0)
+    redis-client (0.14.1)
+      connection_pool
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -142,9 +147,9 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
-  arm64-darwin-20
+  arm64-darwin
   ruby
-  x86_64-darwin-20
+  x86_64-darwin
 
 DEPENDENCIES
   byebug
diff --git a/README.md b/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"
diff --git a/bin/console b/bin/console
@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require "bundler/inline"
+
+gemfile do
+  source "https://rubygems.org"
+  gem "kredis", path: "../"
+end
+
+
+Kredis.configurator = Class.new { def config_for(name) { db: "2" } end }.new
+ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT)
+
+IRB.start
diff --git a/kredis.gemspec b/kredis.gemspec
@@ -11,7 +11,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.7.0"
   s.add_dependency "activesupport", ">= 6.0.0"
-  s.add_dependency "redis", "~> 4.2"
+  s.add_dependency "activemodel", ">= 6.0.0"
+  s.add_dependency "redis", ">= 4.2", "< 6"
   s.add_development_dependency "rails", ">= 6.0.0"
 
   s.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
diff --git a/lib/kredis/attributes.rb b/lib/kredis/attributes.rb
@@ -54,6 +54,10 @@ def kredis_set(name, key: nil, default: nil, typed: :string, config: :shared, af
       kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end
 
+    def kredis_ordered_set(name, limit: nil, default: nil, key: nil, typed: :string, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, limit: limit, typed: typed, config: config, after_change: after_change
+    end
+
     def kredis_slot(name, key: nil, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, config: config, after_change: after_change
     end
diff --git a/lib/kredis/log_subscriber.rb b/lib/kredis/log_subscriber.rb
@@ -15,7 +15,7 @@ def meta(event)
 
   private
     def formatted_in(color, event, type: nil)
-      color "  Kredis #{type} (#{event.duration.round(1)}ms)  #{event.payload[:message]}", color, true
+      color "  Kredis #{type} (#{event.duration.round(1)}ms)  #{event.payload[:message]}", color, bold: true
     end
 end
 
diff --git a/lib/kredis/migration.rb b/lib/kredis/migration.rb
@@ -33,10 +33,10 @@ def migrate(from:, to:, pipeline: nil)
   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
diff --git a/lib/kredis/type/datetime.rb b/lib/kredis/type/datetime.rb
@@ -4,11 +4,11 @@ module Kredis
   module Type
     class DateTime < ActiveModel::Type::DateTime
       def serialize(value)
-        super&.iso8601(9)
+        super&.utc&.iso8601(9)
       end
 
       def cast_value(value)
-        super&.to_datetime
+        super&.to_time
       end
     end
   end
diff --git a/lib/kredis/type/json.rb b/lib/kredis/type/json.rb
@@ -8,11 +8,7 @@ def type
       end
 
       def cast_value(value)
-        if value.is_a? Hash
-          value.stringify_keys
-        else
-          JSON.load(value)
-        end
+        JSON.parse(value)
       end
 
       def serialize(value)
diff --git a/lib/kredis/types.rb b/lib/kredis/types.rb
@@ -71,6 +71,10 @@ def set(key, default: nil, typed: :string, config: :shared, after_change: nil)
     type_from(Set, config, key, after_change: after_change, default: default, 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 @@ def type_from(type_klass, config, key, after_change: nil, **options)
 require "kredis/types/list"
 require "kredis/types/unique_list"
 require "kredis/types/set"
+require "kredis/types/ordered_set"
 require "kredis/types/slots"
diff --git a/lib/kredis/types/ordered_set.rb b/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
diff --git a/lib/kredis/version.rb b/lib/kredis/version.rb
@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.2.0"
+  VERSION = "1.5.0"
 end
diff --git a/test/attributes_test.rb b/test/attributes_test.rb
@@ -13,6 +13,7 @@ class Person
   kredis_list :names_with_default_via_lambda, default: ->(p) { ["Random", p.name] }
   kredis_unique_list :skills, limit: 2
   kredis_unique_list :skills_with_default_via_lambda, default: ->(p) { ["Random", "Random", p.name] }
+  kredis_ordered_set :reading_list, limit: 2
   kredis_flag :special
   kredis_flag :temporary_special, expires_in: 1.second
   kredis_string :address
@@ -148,6 +149,11 @@ class AttributesTest < ActiveSupport::TestCase
     assert_equal %w[ Random Jason ], Kredis.redis.lrange("people:8:skills_with_default_via_lambda", 0, -1)
   end
 
+  test "ordered set" do
+    @person.reading_list.prepend(%w[ rework shapeup remote ])
+    assert_equal %w[ remote shapeup ], @person.reading_list.elements
+  end
+
   test "flag" do
     assert_not @person.special?
 
diff --git a/test/migration_test.rb b/test/migration_test.rb
@@ -62,7 +62,7 @@ class MigrationTest < ActiveSupport::TestCase
   test "delete_all with keys" do
     3.times { |index| Kredis.proxy("mykey:#{index}").set "hello there #{index}" }
 
-    Kredis::Migration.delete_all *3.times.map { |index| "mykey:#{index}" }
+    Kredis::Migration.delete_all(*3.times.map { |index| "mykey:#{index}" })
 
     3.times { |index| assert_nil Kredis.proxy("mykey:#{index}").get }
   end
diff --git a/test/types/list_test.rb b/test/types/list_test.rb
@@ -55,10 +55,20 @@ class ListTest < ActiveSupport::TestCase
     assert_equal [], @list.elements
   end
 
+  test "last" do
+    @list.append(%w[ 1 2 3 ])
+    assert_equal "3", @list.last
+  end
+
+  test "last(n)" do
+    @list.append(%w[ 1 2 3 ])
+    assert_equal %w[ 2 3 ], @list.last(2)
+  end
+
   test "typed as datetime" do
     @list = Kredis.list "mylist", typed: :datetime
 
-    @list.append [ 1.day.from_now.midnight, 2.days.from_now.midnight ]
+    @list.append [ 1.day.from_now.midnight.in_time_zone("Pacific Time (US & Canada)"), 2.days.from_now.midnight.in_time_zone("UTC") ]
     assert_equal [ 1.day.from_now.midnight, 2.days.from_now.midnight ], @list.elements
 
     @list.remove(2.days.from_now.midnight)
@@ -72,6 +82,13 @@ class ListTest < ActiveSupport::TestCase
     assert @list.exists?
   end
 
+  test "ltrim" do
+    @list.append(%w[ 1 2 3 4 ])
+    @list.ltrim(-3, -2)
+    assert_equal %w[ 2 3 ], @list.elements
+  end
+
+
   test "default" do
     @list = Kredis.list "mylist", default: %w[ 1 2 3 ]
 
diff --git a/test/types/ordered_set_test.rb b/test/types/ordered_set_test.rb
diff --git a/test/types/scalar_test.rb b/test/types/scalar_test.rb
diff --git a/test/types/set_test.rb b/test/types/set_test.rb
