modis 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f75b1f2591f788a511391d33f34ee1700d4c5aac164d46b7c41c0022afe1c6c8
-  data.tar.gz: 36ae08b35f2cc34166322ff2933d42717fd826779501eb135e815fccfaddecd5
+  metadata.gz: 9a9d3d05277e2ddf26b7c14547b3e03f37cb6fbb771ba9b2a6b61acce6485bd9
+  data.tar.gz: 031d2f34a15d5f077b5b01c2e4286b73285ed2171f4029577c2d812a22f6da6d
 SHA512:
-  metadata.gz: ff27792407942c2b3618ae6751e0397ba7c510d7852a758eb9e21219c8d111ebf3b0f28c2be3db40ec846de20bda4a9dc53d65051e1ad15d5ccfe6b6f3588118
-  data.tar.gz: 9ec6aaf991906929d9101ebf502bfd0f4d669af5c70df4b04b835ea714cc6602497a291aeb03f84ca436785aa0b0601a0404f1c44e79e147fe457f372f8527a7
+  metadata.gz: 9b76390c567d8ba5495c226cb7425372797fe9b3d5e2d2a07a8f891bed7e5aa4f3c66d84f54c6cac7814f07f156e958687a62da8179c4d1922da2efb065412c1
+  data.tar.gz: dba384ff8ad647615016ed340c21e72088d45b1186b91e96f28c579b73ff7d45cd2616b10c70d42fcb17e1f4cfe4889074c0eb8a6ab41b0e92082d83d663c026

data/.github/workflows/test.yml

@@ -26,6 +26,7 @@ jobs:
           - 6379:6379
 
     strategy:
+      fail-fast: false
       matrix:
         gemfile: ['rails_5.2', 'rails_6.0', 'rails_6.1', 'rails_7.0']
 
@@ -55,7 +56,7 @@ jobs:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
-## [v4.1.0](https://github.com/rpush/modis/tree/v4.1.0) (2023-08-01)
+## [v4.1.0](https://github.com/rpush/modis/tree/v4.1.0) (2024-07-31)
 
-[Full Changelog](https://github.com/rpush/modis/compare/v4.1.0...v4.1.0)
+[Full Changelog](https://github.com/rpush/modis/compare/v4.2.0...v4.1.0)
+
+**Merged pull requests:**
+
+- Add support for multiple redis connections [\#49](https://github.com/rpush/modis/pull/49) ([SxDx](https://github.com/SxDx))
+- Fix deprecation warning [\#48](https://github.com/rpush/modis/pull/48) ([SxDx](https://github.com/SxDx))
+
+## [v4.2.0](https://github.com/rpush/modis/tree/v4.2.0) (2023-08-01)
+
+[Full Changelog](https://github.com/rpush/modis/compare/v4.1.0...v4.2.0)
 
 **Merged pull requests:**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    modis (4.2.0)
+    modis (4.3.0)
       activemodel (>= 5.2)
       activesupport (>= 5.2)
       connection_pool (>= 2)
@@ -48,8 +48,8 @@ GEM
       parallel
     codeclimate-test-reporter (1.0.7)
       simplecov
-    concurrent-ruby (1.2.0)
-    connection_pool (2.3.0)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     console (1.16.2)
       fiber-local
     diff-lcs (1.4.4)
@@ -71,12 +71,12 @@ GEM
       rainbow (>= 2.2.1)
       rake (>= 10.0)
     hiredis (0.6.3)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-event (1.1.6)
     jaro_winkler (1.5.4)
-    minitest (5.17.0)
-    msgpack (1.6.0)
+    minitest (5.19.0)
+    msgpack (1.7.2)
     multi_json (1.15.0)
     octokit (4.25.1)
       faraday (>= 1, < 3)
@@ -94,9 +94,9 @@ GEM
     public_suffix (5.0.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (5.0.6)
-      redis-client (>= 0.9.0)
-    redis-client (0.12.1)
+    redis (5.2.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.22.2)
       connection_pool
     rexml (3.2.5)
     rspec (3.9.0)

data/lib/modis/deprecator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Modis
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('5.0', 'modis')
+  end
+end

data/lib/modis/finder.rb

@@ -18,7 +18,7 @@ module Modis
             "because you disabled all index. See :enable_all_index for more."
         end
 
-        records = Modis.with_connection do |redis|
+        records = Modis.with_connection(modis_connection) do |redis|
           ids = redis.smembers(key_for(:all))
           redis.pipelined do |pipeline|
             ids.map { |id| record_for(pipeline, id) }
@@ -41,7 +41,7 @@ module Modis
       def find_all(ids)
         raise RecordNotFound, "Couldn't find #{name} without an ID" if ids.empty?
 
-        records = Modis.with_connection do |redis|
+        records = Modis.with_connection(modis_connection) do |redis|
           if ids.count == 1
             ids.map { |id| record_for(redis, id) }
           else

data/lib/modis/index.rb

@@ -36,7 +36,7 @@ module Modis
       end
 
       def index_for(attribute, value)
-        Modis.with_connection do |redis|
+        Modis.with_connection(modis_connection) do |redis|
           key = index_key(attribute, value)
           redis.smembers(key).map(&:to_i)
         end

data/lib/modis/model.rb

@@ -21,6 +21,8 @@ module Modis
         include Modis::Index
 
         base.extend(ClassMethods)
+        base.class_attribute :modis_connection
+        base.modis_connection = :default
       end
     end
 

data/lib/modis/persistence.rb

@@ -150,7 +150,7 @@ module Modis
     end
 
     def reload
-      new_attributes = Modis.with_connection { |redis| self.class.attributes_for(redis, id) }
+      new_attributes = Modis.with_connection(modis_connection) { |redis| self.class.attributes_for(redis, id) }
       initialize(new_attributes)
       self
     end
@@ -166,7 +166,7 @@ module Modis
     end
 
     alias update_attributes update
-    deprecate update_attributes: 'please, use update instead'
+    deprecate update_attributes: 'please, use update instead', deprecator: Modis.deprecator
 
     def update!(attrs)
       assign_attributes(attrs)
@@ -174,7 +174,7 @@ module Modis
     end
 
     alias update_attributes! update!
-    deprecate update_attributes!: 'please, use update! instead'
+    deprecate update_attributes!: 'please, use update! instead', deprecator: Modis.deprecator
 
     private
 
@@ -253,7 +253,7 @@ module Modis
 
     def set_id
       namespace = self.class.sti_child? ? self.class.sti_base_absolute_namespace : self.class.absolute_namespace
-      Modis.with_connection do |redis|
+      Modis.with_connection(modis_connection) do |redis|
         self.id = redis.incr("#{namespace}_id_seq")
       end
     end

data/lib/modis/transaction.rb

@@ -8,7 +8,7 @@ module Modis
 
     module ClassMethods
       def transaction
-        Modis.with_connection { |redis| redis.multi { |transaction| yield(transaction) } }
+        Modis.with_connection(modis_connection) { |redis| redis.multi { |transaction| yield(transaction) } }
       end
     end
   end

data/lib/modis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modis
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 end

data/lib/modis.rb

@@ -7,6 +7,7 @@ require 'active_support/all'
 require 'msgpack'
 
 require 'modis/version'
+require 'modis/deprecator'
 require 'modis/configuration'
 require 'modis/attribute'
 require 'modis/errors'
@@ -18,13 +19,20 @@ require 'modis/model'
 
 module Modis
   @mutex = Mutex.new
-
   class << self
-    attr_writer :redis_options, :connection_pool_size, :connection_pool_timeout,
-                :connection_pool
+    attr_writer :connection_pool_size, :connection_pool_timeout,
+                :connection_pools
 
     def redis_options
-      @redis_options ||= {}
+      @redis_options ||= { default: {} }
+    end
+
+    def redis_options=(options)
+      if options.is_a?(Hash) && options.values.first.is_a?(Hash)
+        @redis_options = options.transform_values(&:dup)
+      else
+        @redis_options[:default] = options
+      end
     end
 
     def connection_pool_size
@@ -35,17 +43,25 @@ module Modis
       @connection_pool_timeout ||= 5
     end
 
-    def connection_pool
-      return @connection_pool if @connection_pool
+    def connection_pools
+      @connection_pools ||= {}
+    end
 
-      @mutex.synchronize do
-        options = { size: connection_pool_size, timeout: connection_pool_timeout }
-        @connection_pool = ConnectionPool.new(options) { Redis.new(redis_options) }
+    def connection_pool(pool_name = :default)
+      connection_pools[pool_name] ||= begin
+        @mutex.synchronize do
+          ConnectionPool.new(
+            size: connection_pool_size,
+            timeout: connection_pool_timeout
+          ) do
+            Redis.new(redis_options[pool_name])
+          end
+        end
       end
     end
 
-    def with_connection
-      connection_pool.with { |connection| yield(connection) }
+    def with_connection(pool_name = :default)
+      connection_pool(pool_name).with { |connection| yield(connection) }
     end
   end
 end

data/spec/multi_redis_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module MultiRedisSpec
+  class DefaultUserModel
+    include Modis::Model
+
+    attribute :name, :string
+  end
+
+  class CustomUserModel
+    include Modis::Model
+    self.modis_connection = :custom
+
+    attribute :name, :string
+  end
+end
+
+describe 'Multiple redis support' do
+  before do
+    Modis.redis_options = {
+      default: { url: 'redis://localhost:6379/0' },
+      custom: { url: 'redis://localhost:6379/1' }
+    }
+  end
+
+  it 'uses the default redis connection' do
+    expect(Modis).to receive(:with_connection).with(:default).at_least(3).times.and_call_original
+    user = MultiRedisSpec::DefaultUserModel.create!(name: 'Ian')
+
+    expect(Modis).to receive(:with_connection).with(:default).at_least(3).times.and_call_original
+    MultiRedisSpec::DefaultUserModel.find(user.id)
+  end
+
+  it 'uses the specified redis connection when set up' do
+    expect(Modis).to receive(:with_connection).with(:custom).at_least(3).times.and_call_original
+    user = MultiRedisSpec::CustomUserModel.create!(name: 'Tanya')
+
+    expect(Modis).to receive(:with_connection).with(:custom).at_least(3).times.and_call_original
+    MultiRedisSpec::CustomUserModel.find(user.id)
+  end
+end
+
+describe 'backwards compatibility' do
+  before do
+    Modis.redis_options = {
+      url: 'redis://localhost:6379/0'
+    }
+  end
+
+  it 'uses the default redis connection' do
+    expect(Modis).to receive(:with_connection).with(:default).at_least(3).times.and_call_original
+    MultiRedisSpec::DefaultUserModel.create!(name: 'Ian')
+  end
+end

data/spec/spec_helper.rb

@@ -20,9 +20,12 @@ end
 
 RSpec.configure do |config|
   config.after :each do
-    Modis.with_connection do |connection|
-      keys = connection.keys "#{Modis.config.namespace}:*"
-      connection.del(*keys) unless keys.empty?
+    RSpec::Mocks.space.proxy_for(Modis).reset
+    Modis.connection_pools.each do |key, _|
+      Modis.with_connection(key) do |connection|
+        keys = connection.keys "#{Modis.config.namespace}:*"
+        connection.del(*keys) unless keys.empty?
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modis
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Ian Leitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -236,6 +236,7 @@ files:
 - lib/modis.rb
 - lib/modis/attribute.rb
 - lib/modis/configuration.rb
+- lib/modis/deprecator.rb
 - lib/modis/errors.rb
 - lib/modis/finder.rb
 - lib/modis/index.rb
@@ -249,6 +250,7 @@ files:
 - spec/errors_spec.rb
 - spec/finder_spec.rb
 - spec/index_spec.rb
+- spec/multi_redis_spec.rb
 - spec/persistence_spec.rb
 - spec/spec_helper.rb
 - spec/support/simplecov_helper.rb
@@ -283,6 +285,7 @@ test_files:
 - spec/errors_spec.rb
 - spec/finder_spec.rb
 - spec/index_spec.rb
+- spec/multi_redis_spec.rb
 - spec/persistence_spec.rb
 - spec/spec_helper.rb
 - spec/support/simplecov_helper.rb