redis-rb-global-config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f3a59e52b445fd9b97acc9d3edc71847fb5e1369860d1326d317592841d568f
+  data.tar.gz: 31145a4744087d53023073631470a584efc82a734ac4755fa535ff7c1737281e
+SHA512:
+  metadata.gz: 50e23875b7c1c778164958bd1a18b0c30895b0415de3491b1b956978290510fa7ab78f80a530da17c2c27286a28057b8982c45a88470a8127e53cb6abd91e430
+  data.tar.gz: 23e6388bf8a6d7e9af721a68c8e92014029c2018814e3e5cab21ddc8f6a056654b181f2161112d0a9ca6adfd2ffc56243b06a81428847a3eba3e8c4e4249d21e

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sebi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# redis-rb-global-config 🌟
+
+[![Gem Version](https://badge.fury.io/rb/redis-rb-global-config.svg)](https://badge.fury.io/rb/redis-rb-global-config)
+
+Simplify your Redis configuration management across your Ruby applications! 🚀
+
+## 🎯 Purpose
+
+RedisRbGlobalConfig allows you to set default configurations for Redis connections across your Ruby application. This is particularly useful when you're using Redis for multiple purposes in a Rails application, such as:
+
+- 🚂 Rails sessions
+- 🗄️ Caching on a separate database
+- 🧵 Sidekiq for background jobs
+- 📡 ActionCable/AnyCable for real-time features
+
+It also makes it easy to ensure all Redis connections use the high-performance Hiredis driver for improved speed! 💨
+
+## 🛠️ Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-rb-global-config'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install redis-rb-global-config
+```
+
+## 🚀 Usage
+
+Here's how you can use RedisRbGlobalConfig in your application:
+
+```ruby
+require 'redis-rb-global-config'
+
+# Set global configuration
+Redis.default_configuration = {
+  host: ENV['REDIS_HOST'] || 'localhost',
+  port: ENV['REDIS_PORT'] || 6379,
+  db: 0,
+  driver: :hiredis  # Use the high-performance Hiredis driver
+}
+
+# Create Redis instances with specific configurations
+redis_cache = Redis.new(db: 1)
+redis_sessions = Redis.new(db: 2)
+redis_sidekiq = Redis.new(db: 3)
+
+# The global configuration is merged with the specific options
+```
+
+### 🔧 Rails Configuration Example
+
+In your `config/initializers/redis.rb`:
+
+```ruby
+require 'redis-rb-global-config'
+
+Redis.default_configuration = {
+  host: ENV['REDIS_HOST'] || 'localhost',
+  port: ENV['REDIS_PORT'] || 6379,
+  driver: :hiredis
+}
+
+# Cache Store
+Rails.application.config.cache_store = :redis_cache_store, { db: 1 }
+
+# Action Cable
+Rails.application.config.action_cable.backend = :redis
+Rails.application.config.action_cable.url = "redis://localhost:6379/2"
+
+# Sessions
+Rails.application.config.session_store :redis_store, 
+  servers: [{ db: 3 }],
+  expire_after: 90.minutes
+
+# Sidekiq
+Sidekiq.configure_server do |config|
+  config.redis = { db: 4 }
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { db: 4 }
+end
+```
+
+This setup ensures that all Redis connections use the same host and port, and all benefit from the Hiredis driver, while still allowing you to use different databases for different purposes.
+
+## 🧪 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/sebyx07/redis-rb-global-config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](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 RedisRbGlobalConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/redis-rb-global-config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RedisRbGlobalConfig
+  VERSION = '1.0.0'
+end

data/lib/redis-rb-global-config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'redis'
+require_relative './redis-rb-global-config/version'
+
+module RedisRbGlobalConfig
+  def self.prepended(base)
+    class << base
+      attr_accessor :default_configuration
+    end
+  end
+
+  def initialize(options = {})
+    options = __configure_options(options)
+    super(options)
+  end
+
+  private
+    def __configure_options(options)
+      default_configuration = self.class.default_configuration
+      return options unless default_configuration
+
+      h_deep_merge(default_configuration, options)
+    end
+
+    def h_deep_merge(hash1, hash2)
+      result = hash1.dup
+      hash2.each do |key, value|
+        result[key] = if value.is_a?(Hash) && result[key].is_a?(Hash)
+          h_deep_merge(result[key], value)
+        else
+          value
+        end
+      end
+      result
+    end
+end
+
+Redis.prepend(RedisRbGlobalConfig)

data/sig/redis/rb/global/config.rbs

@@ -0,0 +1,10 @@
+module Redis
+  module Rb
+    module Global
+      module Config
+        VERSION: String
+        # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: redis-rb-global-config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: RedisRbGlobalConfig allows you to set default configurations for Redis
+  connections across your Ruby application.
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis-rb-global-config.rb
+- lib/redis-rb-global-config/version.rb
+- sig/redis/rb/global/config.rbs
+homepage: https://github.com/sebyx07/redis-rb-global-config
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sebyx07/redis-rb-global-config
+  source_code_uri: https://github.com/sebyx07/redis-rb-global-config
+  changelog_uri: https://github.com/sebyx07/redis-rb-global-config/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: A gem to provide global configuration for the redis-rb gem
+test_files: []