godredis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 997523d959196b0d1f84f05ca4d2a1658aa97f46
+  data.tar.gz: 6ff84c78859b12c8a9f1ad6c4528c761fcf8de15
+SHA512:
+  metadata.gz: 1c8194aace19d508f635cc8b2e6be57815a09f182c301a835aa1ed2bc956a4c14e0aeedf79af899223fc6abb4c43562631d4f8c300155481ee65ae01798bfcee
+  data.tar.gz: 999b140c98f51e8f81c9b3a4b1ca47dd5a12564bd062a14abf6e44ed4c14d3dd7930aba6a5281edc4e811d8d8b9358d80709c7efafee66651d38f79041741e90

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in godredis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anton
+
+MIT License
+
+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,89 @@
+# Godredis: bulk managing multiply Redis instances
+
+Godredis gem provides unified interface for mass managing [Redis](http://redis.io) connections which could be initialized in different modules having each own custom API.
+
+It is useful when you need to close or reset connections on forking, for example, with [puma](http://github.com/puma/puma) server in the `on_restart` block:
+
+    on_restart do
+      # Rails.cache.instance_variable_get('@data').quit
+      # Redis::Objects.redis.quit
+      # Sidekiq.redis(&:quit)
+      Godredis.quit_all!  # instead of commented lines above
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'godredis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install godredis
+
+## Usage
+
+There are several ways to call bulk commands with Godredis:
+
+    # Godredis.command_all! -- will output command execution result
+    Godredis.reconnect_all! # => Redis [cache_store]: reconnect... [OK]
+                            # => Redis [objects]: reconnect... [OK]
+                            # => Redis [sidekiq]: reconnect... [OK]
+    
+    # Godredis.command_all -- silent
+    Godredis.quit_all
+    
+    # Just different syntax
+    Godredis.redises(&:quit) 
+    Godredis.redises(&:quit!)
+    
+    # It's also return an enumerator, so you can do something like this:
+    Godredis.redises.map(&:connected?)
+
+Subclass `Godredis::Base` class to collect Redis-related objects and use simple DSL to set mapping for the common methods such as `quit` or `reconnect` if they are different from the defaults.
+
+    class CacheStoreGodredis < Godredis::Base
+      redis ->{ Rails.cache.instance_variable_get('@data') }
+    end
+    
+    class ObjectsGodredis < Godredis::Base
+      redis ->{ Redis::Objects.redis }
+    end
+    
+    class SidekiqGodredis < Godredis::Base
+      # define mappings with blocks or lambdas
+      redis  ->(&block){ Sidekiq.redis &block }
+      client { redis &:client }
+      quit   { redis &:quit }
+    end
+
+Default mapping:
+
+    redis      { Redis.current }
+    client     { redis.client }
+    connected? { client.connected? }
+    reconnect  { client.reconnect.connected? }
+    quit       { redis.quit }
+
+You may also add custom commands:
+
+    class SomeGodredis < Godredis::Base
+      del_some_key { redis.del('some_key') }
+    end
+    
+    Godredis.redises(&:del_some_key!)
+    # etc...
+
+Every commands (except question-marked) also has a banged wrapper `command!`, which calls an itself command and puts a short message about its execution result.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/godredis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/godredis.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "godredis"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Tõnis Simo"]
+  spec.email         = ["anton.estum@gmail.com"]
+  spec.summary       = %q{Godredis: bulk managing multiply Redis instances.}
+  spec.description   = %q{Godredis provides unified interface for mass managing 
+                          Redis connections which could be initialized in 
+                          different modules having each own custom API.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "activesupport", ">= 3.0.0"
+end

data/lib/godredis.rb

@@ -0,0 +1,133 @@
+require 'active_support/core_ext/class/subclasses'
+
+# = Godredis: bulk managing multiply Redis instances
+# 
+# Godredis provides unified interface for mass managing Redis connections which
+# could be initialized in different modules having each own custom API. 
+# 
+# It is useful when you need to close or reset connections on forking, for 
+# example, with puma server in the <tt>on_restart</tt> block: 
+# 
+#   on_restart do
+#     # Rails.cache.instance_variable_get('@data').quit
+#     # Redis::Objects.redis.quit
+#     # Sidekiq.redis(&:quit)
+#     Godredis.quit_all!  # instead of commented lines above
+#   end
+# 
+# There are several ways to call bulk commands with Godredis:
+#   
+#   # Godredis.command_all! -- will output command execution result
+#   Godredis.reconnect_all! # => Redis [cache_store]: reconnect... [OK]
+#                           # => Redis [objects]: reconnect... [OK]
+#                           # => Redis [sidekiq]: reconnect... [OK]
+#   
+#   # Godredis.command_all -- silent
+#   Godredis.quit_all
+#   
+#   # Just different syntax
+#   Godredis.redises(&:quit) 
+#   Godredis.redises(&:quit!)
+# 
+#   # It's also return an enumerator, so you can do something like this:
+#   Godredis.redises.map(&:connected?)
+# 
+# See Godredis::Base documentation for collecting your Redis-related objects.
+module Godredis
+  # :nodoc:
+  def self.redises(&block)
+    Base.subclasses.map(&:new).each(&block)
+  end
+  
+  def self.method_missing(method, *args, &blk)
+    if /^(?<action>.+)_all(?<bang>!)?$/ =~ method.to_s
+      redises &:"#{action}#{bang}"
+    else
+      super
+    end
+  end
+  
+  # Subclass Godredis base class to collect Redis-related objects and use
+  # simple DSL to set mapping for the common methods such as <tt>quit</tt> or
+  # <tt>reconnect</tt> if they are different from the defaults.
+  # 
+  #   class CacheStoreGodredis < Godredis::Base
+  #     redis ->{ Rails.cache.instance_variable_get('@data') }
+  #   end
+  # 
+  #   class ObjectsGodredis < Godredis::Base
+  #     redis ->{ Redis::Objects.redis }
+  #   end
+  #   
+  #   class SidekiqGodredis < Godredis::Base
+  #     # define mappings with blocks or lambdas
+  #     redis  ->(&block){ Sidekiq.redis &block }
+  #     client { redis &:client }
+  #     quit   { redis &:quit }
+  #   end
+  # 
+  # Default mapping:
+  # 
+  #   redis      { Redis.current }
+  #   client     { redis.client }
+  #   connected? { client.connected? }
+  #   reconnect  { client.reconnect.connected? }
+  #   quit       { redis.quit }
+  # 
+  # You may also add custom commands:
+  # 
+  #   class SomeGodredis < Godredis::Base
+  #     del_some_key { redis.del('some_key') }
+  #   end
+  #   
+  #   Godredis.redises(&:del_some_key!)
+  #   # etc...
+  # 
+  # Every commands (except question-marked) also has a banged wrapper
+  # <tt>command!</tt>, which calls an itself command and puts a short message
+  # about its execution result
+  class Base
+    class << self
+      def tag
+        @tag ||= name.demodulize[/^(.+?)((?:god)?redis)?$/i, 1].underscore
+      end
+      
+      protected
+      def method_missing(method, proc = nil, *args, &block)
+        if block_given? || proc.respond_to?(:to_proc)
+          define_method method, &(block || proc)
+        else
+          super
+        end
+      end
+    end
+    
+    # Default command mapping
+    redis      { Redis.current }
+    client     { redis.client }
+    connected? { client.connected? }
+    reconnect  { client.reconnect.connected? }
+    quit       { redis.quit }
+    
+    def method_missing(method, *args, &block)
+      if /^(?<action>.+[^\?])!$/ =~ method.to_s && respond_to?(action)
+        say(action) { send action }
+      else
+        super
+      end
+    end
+    
+    delegate :tag, to: :class
+    
+    private
+    def say(action, &block)
+      result = _get_short_status_calling(&block)
+      puts "Redis [#{tag}]: #{action}... #{result}"
+    end
+    
+    def _get_short_status_calling(&block)
+      result = begin; block.call rescue nil; end
+      result == true ? '[OK]' : result || '[FAIL]'
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: godredis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tõnis Simo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: "Godredis provides unified interface for mass managing \n                          Redis
+  connections which could be initialized in \n                          different
+  modules having each own custom API."
+email:
+- anton.estum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- godredis.gemspec
+- lib/godredis.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 'Godredis: bulk managing multiply Redis instances.'
+test_files: []