redis-objects 1.5.1 → 2.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c7bc592d203647a8b7e9fd574a78eec1ec466e85fef95d30fac6d831f5d086a
-  data.tar.gz: e89a8a50ddac32cc8b0fd5692697c21620ef97bac6f28c1841c0e50e9a833429
+  metadata.gz: 22b6b39234249ccd4c9485061bb918a211c539b3612d1a916a56eab0e13e031f
+  data.tar.gz: 9465be0b72fb8d160421eae75cf5cc5996a2aaa6b507bac6492f6a0b66fad788
 SHA512:
-  metadata.gz: 7a91ab932b94a4a36ab4da40d173804b71c46b21c28e917acefb5f1720da1dd60fe3e4c0d06e124c172118789c31fa11f0f4b96b7b27da97cbd8f7a90f01dd6c
-  data.tar.gz: d92e900d1fcec537a439e99ad7d311a83ad23c1e5c28ecc84e8922a0c7da56b4fdcfc9cadcb48aca382c4a6c8045dd24ecbeb81d681aa4fcad2c9d13b3cf9a8f
+  metadata.gz: ff4f516b5618e2a010c32ee0360dbfdbc172d400d3570cae3e5078aff845188171f3900849bdbb9c9c8cc869cc419d1995c9162b79e09a2a7d750d05b0591987
+  data.tar.gz: 75677a0da407ad97925c69ea51a55d51d4fc3b7a036768e4c5cb2457adbeefdeb924160d3ec8656949b4d2369785c8de4a272a4284ccc12f379eb89b3a7496b3

data/.gitignore

@@ -9,3 +9,5 @@ spec/redis.pid
 dump.rdb
 Gemfile.lock
 redis-objects-*.gem
+coverage/
+.DS_Store

data/.travis.yml

@@ -5,7 +5,12 @@ before_install:
   - gem install bundler
 
 rvm:
-  - 2.3.3
-  - 2.4.0
-  - 2.5.1
-  - 2.6.4
+  - 2.3.8
+  - 2.4.10
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
+
+# For code coverage reports
+script: bundle exec rake

data/CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 = Changelog for Redis::Objects
 
+== 1.7.0 (29 Apr 2022)
+
+* Bumped version to 1.7.0 to revert redis-rb version lock [Nate Wiger]
+
+== 1.6.0 (29 Apr 2022)
+
+* Upgrade version to 1.6.0 due to redis-rb changes to Redis.current [Nate Wiger]
+
 == 1.5.1 (10 Jul 2021)
 
 * Added double-splat for **options to account for Ruby 3.0  [Nate Wiger]

data/README.md

@@ -1,9 +1,60 @@
 Redis::Objects - Map Redis types directly to Ruby objects
 =========================================================
 
-[![Build Status](https://travis-ci.org/nateware/redis-objects.png)](https://travis-ci.org/nateware/redis-objects)
+[![Build Status](https://app.travis-ci.com/nateware/redis-objects.svg?branch=master)](https://travis-ci.com/github/nateware/redis-objects)
+[![Code Coverage](https://codecov.io/gh/nateware/redis-objects/branch/master/graph/badge.svg)](https://codecov.io/gh/nateware/redis-objects)
 [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MJF7JU5M7F8VL)
 
+Important 2.0 changes
+---------------------
+Redis::Objects 2.0 introduces several important backwards incompatible changes.
+Currently 2.0 can be installed with `gem install redis-objects --pre` or by listing it
+explicitly in your Gemfile:
+~~~ruby
+# Gemfile
+gem 'redis-objects', '>= 2.0.0.alpha'
+~~~
+You're encouraged to try it out in test code (not production) to ensure it works for you.
+Official release is expected later in 2022.
+
+Key Naming Changes
+==================
+The internal key naming scheme has changed for `Nested::Class::Namespaces` to fix a longstanding bug.
+**This means your existing data in Redis will not be accessible until you call `migrate_redis_legacy_keys`.**
+
+To fix this (only needed once), create a script like this:
+
+~~~ruby
+class YouClassNameHere < ActiveRecord::Base
+  include Redis::Objects
+  # ... your relevant definitions here ...
+end
+
+YourClassName.migrate_redis_legacy_keys
+~~~
+
+Then, you need to find a time when you can temporarily pause writes to your redis server
+so that you can run that script. It uses `redis.scan` internally so it should be able to
+handle a high number of keys. For large data sets, it could take a while.
+
+For more details on the issue and fix refer to [#213](https://github.com/nateware/redis-objects/issues/231).
+
+Rename of `lock` Method
+=======================
+The `lock` method that collided with `ActiveRecord::Base` has been renamed `redis_lock`.
+This means your classes need to be updated to call `redis_lock` instead:
+
+~~~ruby
+class YouClassNameHere < ActiveRecord::Base
+  include Redis::Objects
+  redis_lock :mylock  # formerly just "lock"
+end 
+~~~
+
+For more details on the issue and fix refer to [#213](https://github.com/nateware/redis-objects/issues/231).
+
+Overview
+--------
 This is **not** an ORM. People that are wrapping ORM’s around Redis are missing the point.
 
 The killer feature of Redis is that it allows you to perform _atomic_ operations
@@ -118,7 +169,7 @@ Here's an example that integrates several data types with an ActiveRecord model:
 class Team < ActiveRecord::Base
   include Redis::Objects
 
-  lock :trade_players, :expiration => 15  # sec
+  redis_lock :trade_players, :expiration => 15  # sec
   value :at_bat
   counter :hits
   counter :runs
@@ -523,7 +574,7 @@ Locks work similarly. On completion or exception the lock is released:
 
 ~~~ruby
 class Team < ActiveRecord::Base
-  lock :reorder # declare a lock
+  redis_lock :reorder # declare a lock
 end
 
 @team.reorder_lock.lock do
@@ -547,7 +598,7 @@ lock time.
 
 ~~~ruby
 class Team < ActiveRecord::Base
-  lock :reorder, :expiration => 15.minutes
+  redis_lock :reorder, :expiration => 15.minutes
 end
 ~~~
 
@@ -595,5 +646,5 @@ end
 
 Author
 =======
-Copyright (c) 2009-2019 [Nate Wiger](http://nateware.com).  All Rights Reserved.
+Copyright (c) 2009-2022 [Nate Wiger](http://nateware.com).  All Rights Reserved.
 Released under the [Artistic License](http://www.opensource.org/licenses/artistic-license-2.0.php).

data/lib/redis/hash_key.rb

@@ -123,24 +123,20 @@ class Redis
       hsh
     end
 
-    # Get values in bulk, takes an array of keys as arguments.
+    # Get values in bulk, takes an array of fields as arguments.
     # Values are returned in a collection in the same order than their keys in *keys Redis: HMGET
-    def bulk_values(*keys)
-      get_keys = *keys.flatten
-      return [] if get_keys.empty?
-      res = redis.hmget(key, get_keys)
-      get_keys.inject([]){|collection, k| collection << unmarshal(res.shift, options[:marshal_keys][k])}
+    def bulk_values(*fields)
+      get_fields = *fields.flatten
+      return [] if get_fields.empty?
+      res = redis.hmget(key, get_fields)
+      get_fields.collect{|k| unmarshal(res.shift, options[:marshal_keys][k])}
     end
 
     # Increment value by integer at field. Redis: HINCRBY
     def incrby(field, by=1)
       allow_expiration do
         ret = redis.hincrby(key, field, by)
-        unless ret.is_a? Array
-          ret.to_i
-        else
-          nil
-        end
+        ret.to_i
       end
     end
     alias_method :incr, :incrby
@@ -155,11 +151,7 @@ class Redis
     def incrbyfloat(field, by=1.0)
       allow_expiration do
         ret = redis.hincrbyfloat(key, field, by)
-        unless ret.is_a? Array
-          ret.to_f
-        else
-          nil
-        end
+        ret.to_f
       end
     end
 

data/lib/redis/helpers/core_commands.rb

@@ -2,6 +2,10 @@ class Redis
   module Helpers
     # These are core commands that all types share (rename, etc)
     module CoreCommands
+      def exists
+        redis.exists key
+      end
+
       def exists?
         redis.exists? key
       end

data/lib/redis/objects/locks.rb

@@ -14,7 +14,7 @@ class Redis
       module ClassMethods
         # Define a new lock.  It will function like a model attribute,
         # so it can be used alongside ActiveRecord/DataMapper, etc.
-        def lock(name, options={})
+        def redis_lock(name, options={})
           options[:timeout] ||= 5  # seconds
           lock_name = "#{name}_lock"
           redis_objects[lock_name.to_sym] = options.merge(:type => :lock)

data/lib/redis/objects/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Objects
-    VERSION = "1.5.1"
+    VERSION = "2.0.0.alpha"
   end
 end

data/lib/redis/objects.rb

@@ -101,16 +101,93 @@ class Redis
         @redis_objects ||= {}
       end
 
-      # Set the Redis redis_prefix to use. Defaults to model_name
-      def redis_prefix=(redis_prefix) @redis_prefix = redis_prefix end
+      # Toggles whether to use the legacy redis key naming scheme, which causes
+      # naming conflicts in certain cases.
+      attr_accessor :redis_legacy_naming
+      attr_accessor :redis_silence_warnings
+
+      # Set the Redis redis_prefix to use. Defaults to class_name.
+      def redis_prefix=(redis_prefix)
+        @silence_warnings_as_redis_prefix_was_set_manually = true
+        @redis_prefix = redis_prefix
+      end
+
       def redis_prefix(klass = self) #:nodoc:
-        @redis_prefix ||= klass.name.to_s.
-          sub(%r{(.*::)}, '').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        @redis_prefix ||=
+          if redis_legacy_naming
+            redis_legacy_prefix(klass)
+          else
+            redis_legacy_naming_warning_message(klass)
+            redis_modern_prefix(klass)
+          end
+
+        @redis_prefix
+      end
+
+      def redis_modern_prefix(klass = self) #:nodoc:
+        klass.name.to_s.
+          gsub(/::/, '__').                     # Nested::Class => Nested__Class
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). # ClassName => Class_Name
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').     # className => class_Name
+          downcase
+      end
+
+      def redis_legacy_prefix(klass = self) #:nodoc:
+        klass.name.to_s.
+          sub(%r{(.*::)}, '').                  # Nested::Class => Class (problematic)
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). # ClassName => Class_Name
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').     # className => class_Name
           downcase
       end
 
+        # Temporary warning to help with migrating key names
+      def redis_legacy_naming_warning_message(klass)
+        # warn @silence_warnings_as_redis_prefix_was_set_manually.inspect
+        unless redis_legacy_naming || redis_silence_warnings || @silence_warnings_as_redis_prefix_was_set_manually
+          modern = redis_modern_prefix(klass)
+          legacy = redis_legacy_prefix(klass)
+          if modern != legacy
+            warn <<EOW
+WARNING: In redis-objects 2.0.0, key naming will change to fix longstanding bugs.
+Your class #{klass.name.to_s} will be affected by this change!
+Current key prefix: #{legacy.inspect}
+Future  key prefix: #{modern.inspect}
+Read more at https://github.com/nateware/redis-objects/issues/231
+EOW
+          end
+        end
+      end
+
+      def migrate_redis_legacy_keys
+        cursor = 0
+        legacy = redis_legacy_prefix
+        total_keys = 0
+        if legacy == redis_prefix
+          raise "Failed to migrate keys for #{self.name.to_s} as legacy and new redis_prefix are the same (#{redis_prefix})"
+        end
+        warn "Migrating keys from #{legacy} prefix to #{redis_prefix}"
+
+        loop do
+          cursor, keys = redis.scan(cursor, :match => "#{legacy}:*")
+          total_keys += keys.length
+          keys.each do |key|
+            # Split key name apart on ':'
+            base_class, id, name = key.split(':')
+
+            # Figure out the new name
+            new_key = redis_field_key(name, id=id, context=self)
+
+            # Rename the key
+            warn "Rename '#{key}', '#{new_key}'"
+            ok = redis.rename(key, new_key)
+            warn "Warning: Rename '#{key}', '#{new_key}' failed: #{ok}" if ok != 'OK'
+          end
+          break if cursor == "0"
+        end
+
+        warn "Migrated #{total_keys} total number of redis keys"
+      end
+
       def redis_options(name)
         klass = first_ancestor_with(name)
         return klass.redis_objects[name.to_sym] || {}

data/redis-objects.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Only fix this one version or else tests break
-  spec.add_dependency "redis", "~> 4.2"
+  spec.add_dependency "redis"
 
   # Ignore gemspec warnings on these.  Trying to fix them to versions breaks TravisCI
   spec.add_development_dependency "bundler"
@@ -29,6 +29,10 @@ Gem::Specification.new do |spec|
 
   # Compatibility testing
   spec.add_development_dependency "redis-namespace"
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
+
+  # Code coverage
+  spec.add_development_dependency "simplecov-cobertura"
 end

data/spec/redis_autoload_objects_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 # tests whether autoload functionality works correctly; had issues previously
 
 require 'redis/objects'
-# $redis used automatically
+Redis::Objects.redis = REDIS_HANDLE
 
 describe 'Redis::Objects' do
   it "should autoload everything" do