bigrails-redis 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0504974f840e1eed2db5ae02f3a08507cf6e220232d2011f3308ca99d856f7c2'
-  data.tar.gz: 7e6f88e57302136b6f0b3c8c5ec5a4ddd23ecdbc07bdd2bc5b63c5d46ff1f082
+  metadata.gz: 8a2638608a5a80ec36cf93efccc3b761d9d1b976b0529dc407901f42c4269f7d
+  data.tar.gz: 677a8e2fbd028515253f3fac94a29b0cde604053cda39521fcc1efe6354e0020
 SHA512:
-  metadata.gz: fe2c1cd64f7b06b90114a424978ebb1ee081be067c5916ade99e4b324e4e0128c2e5b3c47738614c0f67d2e5c125da518b67a418a36d7ed6af7e44f985c1737a
-  data.tar.gz: 4393c6af1661d65fd7cf2f7d867aab8ae6f5e800d96d3e0f1db89d761af2f99d624fc932b3af4438576c3ebd639a8f9c57e9917ccfb9374b53026446f85585c4
+  metadata.gz: 41ea96f64d5f57dcb9f058420e007dc2e84a106ea9d7232402483c16105f3b42a6f96c33f4a2514c20cf961ee44a1b8bbad8790124c9c93ffa94a042e5d6137e
+  data.tar.gz: 561b0610a79041b670f4b11036ea0ee0c1fbad843580726f1e694f3c9695b5b93df6b02cf59cd222060cdf152dad7e0ff9300e8372ec568211e4fc829c99f2e7

data/README.md

@@ -18,9 +18,15 @@ Create a redis configuration file:
 
 The configuration file (`config/redis.rb`) is just a plain Ruby file that will be evaluated when a connection is requested. Use the `connection` DSL method to declare your connections. The method will yield a block and you're expected to return a configuration hash.
 
-A configuration hash, by default, is passed to `ActiveSupport::Cache::RedisCacheStore.build_redis(...)`. This is a Rails supplied helper which allows for more options than demostrated above. You'll want to [check out its source](https://github.com/rails/rails/blob/main/activesupport/lib/active_support/cache/redis_cache_store.rb#L77-L100) to get a better idea of what it supports.
+The configuration hash is passed to the default `Builder`. You can customize the builder with your own object/proc that responds to `#call`.
 
 ```ruby
+# Change the default builder.
+Rails.application.redis.builder = ->(options) {
+  # options is the hash returned from the connection block.
+  Redis.new(...)
+}
+
 # Simple hardcoded example.
 connection(:default) do
   {

data/lib/big_rails/redis/builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module BigRails
+  module Redis
+    class Builder
+      class << self
+        def call(options)
+          config = Configuration.new(options)
+
+          if config.pool_options.any?
+            ensure_connection_pool_added!
+
+            ::ConnectionPool.new(config.pool_options) { build(config) }
+          else
+            build(config)
+          end
+        end
+
+        private
+
+        def build(config)
+          if config.urls.size > 1
+            build_redis_distributed_client(urls: config.urls, **config.redis_options)
+          else
+            build_redis_client(url: config.urls.first, **config.redis_options)
+          end
+        end
+
+        def build_redis_distributed_client(urls:, **redis_options)
+          ::Redis::Distributed.new([], redis_options).tap do |dist|
+            urls.each { |u| dist.add_node(url: u) }
+          end
+        end
+
+        def build_redis_client(url:, **redis_options)
+          ::Redis.new(redis_options.merge(url: url))
+        end
+
+        def ensure_connection_pool_added!
+          require "connection_pool"
+        rescue LoadError => e
+          warn "You don't have connection_pool installed in your application. Please add it to your Gemfile and run bundle install"
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/big_rails/redis/configuration.rb

@@ -5,24 +5,15 @@ module BigRails
     class Configuration
       attr_reader :redis_options
       attr_reader :pool_options
+      attr_reader :urls
 
       def initialize(redis_options)
         @redis_options = redis_options
+        @urls = Array(redis_options.delete(:url))
         @pool_options ||= {}.tap do |pool_options|
           pool_options[:size] = redis_options.delete(:pool_size) if redis_options[:pool_size]
           pool_options[:timeout] = redis_options.delete(:pool_timeout) if redis_options[:pool_timeout]
         end
-
-        ensure_connection_pool_added! if pool_options.any?
-      end
-
-      private
-
-      def ensure_connection_pool_added!
-        require "connection_pool"
-      rescue LoadError => e
-        warn "You don't have connection_pool installed in your application. Please add it to your Gemfile and run bundle install"
-        raise e
       end
     end
   end

data/lib/big_rails/redis/configuration_dsl.rb

@@ -28,7 +28,7 @@ module BigRails
           raise ArgumentError, "connection named '#{name}' already registered"
         end
 
-        @__configurations[name.to_s] = Configuration.new(yield)
+        @__configurations[name.to_s] = yield
       end
     end
   end

data/lib/big_rails/redis/registry.rb

@@ -5,7 +5,6 @@ module BigRails
     class Registry
       class UnknownConnection < StandardError
       end
-
       class VerificationError < StandardError
       end
 
@@ -14,11 +13,7 @@ module BigRails
       def initialize
         @connections = {}
         @wrapped_connections = {}
-
-        # Default redis builder.
-        @builder = ->(config) {
-          ActiveSupport::Cache::RedisCacheStore.build_redis(**config.redis_options)
-        }
+        @builder = Builder
       end
 
       def for(name, wrapped: false)
@@ -71,12 +66,7 @@ module BigRails
 
       def build_connection(name)
         config = configurations.fetch(name)
-
-        if config.pool_options.any?
-          ::ConnectionPool.new(config.pool_options) { builder.call(config) }
-        else
-          builder.call(config)
-        end
+        builder.call(config)
       end
 
       def build_wrapped_connection(connection)

data/lib/big_rails/redis/version.rb

@@ -2,6 +2,6 @@
 
 module BigRails
   module Redis
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/big_rails/redis.rb

@@ -8,8 +8,9 @@ module BigRails
     extend ActiveSupport::Autoload
 
     autoload :ApplicationExtension
-    autoload :ConfigurationDsl
+    autoload :Builder
     autoload :Configuration
+    autoload :ConfigurationDsl
     autoload :Registry
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigrails-redis
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
 description:
 email:
 - ngan@users.noreply.github.com
@@ -34,6 +48,7 @@ files:
 - README.md
 - lib/big_rails/redis.rb
 - lib/big_rails/redis/application_extension.rb
+- lib/big_rails/redis/builder.rb
 - lib/big_rails/redis/configuration.rb
 - lib/big_rails/redis/configuration_dsl.rb
 - lib/big_rails/redis/railtie.rb