bigrails-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a759e01aab33407d58cedf4e5920130bc302fb72bdf1f31d9946a6315bade497
+  data.tar.gz: bce916691075cb892b279bc14aa152ffd4dd436470d4204199f19f0b9d0c18ba
+SHA512:
+  metadata.gz: 5f9d4a1d5c7d237ecd5ef4dfafc4dcb60a000a417992fc133097b96858b0c092e8707584757c5f6d42b7d204431b2dace0857013e9e19299d7e56da8b72d5916
+  data.tar.gz: 67b9273fbbcc1f4ccbcd1883499c6acf841ef02aa477b742cbc03e4ac19e358f9859c61e5cfcf7bf4a0cb356ce20b4209bf26799759dea11eef44829d8fd5d1f

data/README.md

@@ -0,0 +1,118 @@
+# BigRails::Redis [![Ruby](https://github.com/BigRails/bigrails-redis/actions/workflows/main.yml/badge.svg)](https://github.com/BigRails/bigrails-redis/actions/workflows/main.yml)
+
+A simple Redis connection manager for Rails applications with distributed and [ConnectionPool](https://github.com/mperham/connection_pool) support.
+
+## Installation
+
+Add to your Gemfile:
+
+    $ bundle add bigrails-redis
+
+Create a redis configuration file:
+
+    $ touch config/redis.rb
+
+## Usage
+
+### Configuring Connections
+
+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.
+
+```ruby
+# Simple hardcoded example.
+connection(:default) do
+  {
+    url: "redis://localhost"
+  }
+end
+
+# Do something more dynamic.
+%w(
+  cache
+  foobar
+).each do |name|
+  connection(name) do
+    {
+      url: Rails.application.credentials.fetch("#{name}_redis")
+    }.tap do |options|
+      # Maybe in CI, you need to change the host.
+      if ENV['CI']
+        options[:host] = "redishost"
+      end
+    end
+  end
+end
+
+# Connection pool support.
+connection(:sidekiq) do
+  {
+    url: "redis://localhost/2"
+    pool_timeout: 5,
+    pool_size: 5
+  }
+end
+
+# Distributed Redis support.
+connection(:baz) do
+  {
+    url: [
+      "redis://host1",
+      "redis://host2",
+      "redis://host3"
+    ]
+  }
+end
+```
+
+### Accessing Connections
+
+To access connections inside the application, you can do the following:
+
+```ruby
+Rails.application.redis #=> Redis Registry
+
+Rails.application.redis.for(:default) #=> Redis
+Rails.application.redis.for(:cache) #=> Redis
+Rails.application.redis.for(:foobar) #=> Redis
+Rails.application.redis.for(:sidekiq) #=> ConnectionPool
+```
+
+If needed, you can request a [wrapped connection pool](https://github.com/mperham/connection_pool#migrating-to-a-connection-pool):
+
+```ruby
+Rails.application.redis.for(:pooled_connection, wrapped: true)
+```
+
+If you request a wrapped connection for a non-pooled connection, it'll just return the original, plain `Redis` connection object. Rails already modifies `Redis` to add `ConnectionPool`-like behavior by adding a `with` method that yields the connection itself.
+
+### Verifying Connections
+
+This library also allows you to verify connections on demand. If you want, perform the verification in a startup health check to make sure all your connections are valid. It will perform a simple [`PING` command](https://redis.io/commands/PING). An error will be raised if the connection bad.
+
+```ruby
+# Verify all connections:
+Rails.application.redis.verify!
+
+# Verify a single connection:
+Rails.application.redis.verify!(:foobar)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ngan/bigrails-redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ngan/bigrails-redis/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BigRails::Redis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ngan/bigrails-redis/blob/master/CODE_OF_CONDUCT.md).

data/lib/big_rails/redis/application_extension.rb

@@ -0,0 +1,9 @@
+module BigRails
+  module Redis
+    module ApplicationExtension
+      def redis
+        @redis ||= Registry.new
+      end
+    end
+  end
+end

data/lib/big_rails/redis/configuration.rb

@@ -0,0 +1,29 @@
+require "active_support/cache/redis_cache_store"
+
+module BigRails
+  module Redis
+    class Configuration
+      attr_reader :redis_options
+      attr_reader :pool_options
+
+      def initialize(redis_options)
+        @redis_options = redis_options
+        @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
+end

data/lib/big_rails/redis/configuration_dsl.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BigRails
+  module Redis
+    class ConfigurationDsl
+      FILENAME = "redis.rb"
+
+      attr_reader :__configurations
+
+      def self.resolve
+        new.__configurations
+      end
+
+      def initialize
+        @__configurations = {}
+
+        file = File.join(Rails.application.paths["config"].first, FILENAME)
+        instance_eval(File.read(file), file, 1)
+
+        @__configurations.freeze
+      end
+
+      # DSL Methods
+
+      def connection(name)
+        name = name.to_s
+        if @__configurations.key?(name)
+          raise ArgumentError, "connection named '#{name}' already registered"
+        end
+
+        @__configurations[name.to_s] = Configuration.new(yield)
+      end
+    end
+  end
+end

data/lib/big_rails/redis/railtie.rb

@@ -0,0 +1,11 @@
+require "rails"
+
+module BigRails
+  module Redis
+    class Railtie < Rails::Railtie
+      config.before_configuration do |app|
+        app.include(ApplicationExtension)
+      end
+    end
+  end
+end

data/lib/big_rails/redis/registry.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module BigRails
+  module Redis
+    class Registry
+      class UnknownConnection < StandardError
+      end
+
+      attr_accessor :builder
+
+      def initialize
+        @connections = {}
+        @wrapped_connections = {}
+
+        # Default redis builder.
+        @builder = ->(config) {
+          ActiveSupport::Cache::RedisCacheStore.build_redis(**config.redis_options)
+        }
+      end
+
+      def for(name, wrapped: false)
+        name = validate_name(name)
+
+        if wrapped
+          @wrapped_connections[name] ||= build_wrapped_connection(self.for(name))
+        else
+          @connections[name] ||= build_connection(name)
+        end
+      end
+
+      def config_for(name)
+        configurations[validate_name(name)]
+      end
+
+      def each(&block)
+        configurations.keys.map { self.for(name) }.each(&block)
+      end
+
+      def verify!(name = nil)
+        if name
+          verify_connection(self.for(name))
+        else
+          each { |connection| verify_connection(connection) }
+        end
+
+        true
+      end
+
+      private
+
+      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
+      end
+
+      def build_wrapped_connection(connection)
+        if connection.is_a?(::Redis)
+          connection
+        else
+          ::ConnectionPool.wrap(pool: connection)
+        end
+      end
+
+      def verify_connection(connection)
+        connection.with do |redis|
+          redis.ping == "PONG"
+        end
+      end
+
+      def validate_name(name)
+        name = name.to_s
+        unless configurations.key?(name)
+          raise UnknownConnection, "connection for '#{name}' is not registered"
+        end
+        name
+      end
+
+      def configurations
+        @configurations ||= ConfigurationDsl.resolve
+      end
+    end
+  end
+end

data/lib/big_rails/redis/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BigRails
+  module Redis
+    VERSION = "0.1.0"
+  end
+end

data/lib/big_rails/redis.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "redis/version"
+require "active_support"
+
+module BigRails
+  module Redis
+    extend ActiveSupport::Autoload
+
+    autoload :ApplicationExtension
+    autoload :ConfigurationDsl
+    autoload :Configuration
+    autoload :Registry
+  end
+end
+
+require "big_rails/redis/railtie"

data/lib/bigrails-redis.rb

@@ -0,0 +1 @@
+require "big_rails/redis"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: bigrails-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ngan Pham
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description:
+email:
+- ngan@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/big_rails/redis.rb
+- lib/big_rails/redis/application_extension.rb
+- lib/big_rails/redis/configuration.rb
+- lib/big_rails/redis/configuration_dsl.rb
+- lib/big_rails/redis/railtie.rb
+- lib/big_rails/redis/registry.rb
+- lib/big_rails/redis/version.rb
+- lib/bigrails-redis.rb
+homepage: https://github.com/bigrails/bigrails-redis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bigrails/bigrails-redis
+  source_code_uri: https://github.com/BigRails/bigrails-redis
+  changelog_uri: https://github.com/bigrails/bigrails-redis/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Redis connection manager for Rails applications.
+test_files: []