redisable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33c1cbd877def31fda7be5d4acbcd80a577ad51e
+  data.tar.gz: 71449a1feee54a530e45cc7cb467cb4d28eaf65b
+SHA512:
+  metadata.gz: baa2e1cc3c9393c2f343fac7afa2f264e75de330935784d5bf9579b36b71d5ff469298dd8265062d12f21e23ff4c456bc6e617a8ebdb8425581351c46a3bacb0
+  data.tar.gz: de00dfb8e9fb9df9f48b47d874f072a1f231a20dbd08f5beb54194c908d3e784ecee23bbf1450815bb518aa2a4750ee5df25e603cf6b99006e2ea59e0279c97f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yoppi
+
+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,97 @@
+# Redisable
+
+Thin wrapper library for Redis, enable any Ruby class to access Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redisable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redisable
+
+## Usage
+
+Use in Rails application. Below redis settings in `config/redis.yml`.
+
+```yaml
+# condig/redis.yml
+development:
+  host: localhost
+  port: 6379
+  db: 1
+test:
+  host: localhost
+  port: 6379
+  db: 0
+production:
+  master_name: apps
+  failover_reconnect_timeout: 30
+  sentinels:
+    - host: redis1.example.com
+      port: 26379
+    - host: redis2.example.com
+      port: 26379
+```
+
+Then, initialize Redisable at `config/initializers/redis.rb`.
+
+```ruby
+Redisable::Config.load YAML.load_file(File.join(Rails.root, "config/redis.yml"))
+```
+
+In model, `users`, User is ActiveRecord object, but some `user_status` is ephemeral or volatile data, so won't record to RDBMS.
+Below code is store `user_stauts` in Redis.
+
+```ruby
+class User < ActiveRecord::Base
+  def user_status
+    @user_status ||= UserStatus.new(id)
+  end
+end
+
+class UserStatus
+  include Redisable
+  kvs_key :followers_ids
+  kvs_key :unread_news_ids
+
+  def initialize(id)
+    @user_id = id
+  end
+
+  def id
+    @user_id
+  end
+
+  def followers
+    redis.get followers_ids
+  end
+
+  def unread_news
+    redis.lrange unread_news_ids, 0, -1
+  end
+  ...
+end
+
+class UsersController
+  def show(id)
+    user_status = current_user.user_status
+    user_status.followers
+    user_status.unread_news
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/redisable.rb

@@ -0,0 +1,29 @@
+require "redisable/version"
+require "redis"
+
+module Redisable
+  autoload :Config, "redisable/config"
+  autoload :Connection, "redisable/connection"
+  autoload :KVSKey, "redisable/kvs_key"
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+    base.send :include, KVSKey
+  end
+
+  module ClassMethods
+    attr_accessor :redis_server
+    def redis
+      server = redis_server || :application
+      Redisable::Connection.conn(server)
+    end
+  end
+
+  module InstanceMethods
+    private
+    def redis
+      @_redis ||= self.class.redis
+    end
+  end
+end

data/lib/redisable/config.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Redisable
+  class Config
+    def self.load(conf, server=:application)
+      @conf ||= {}
+      @conf[server] = conf
+    end
+
+    def self.conf(server=:application)
+      @conf[server]
+    end
+  end
+end
+

data/lib/redisable/connection.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+module Redisable
+  module Connection
+    def self.conn(server)
+      @pool ||= {}
+      @pool[server] ||=
+        begin
+          conf = Redisable::Config.conf(server)
+          redis = ::Redis.new(conf)
+          raise "Redis server[#{conf["host"]}:#{conf["port"]}] is down!" unless reachable?(redis)
+          redis
+        end
+    end
+
+    def self.quit(server)
+      redis = @pool[server]
+      redis.quit if redis && reachable?(redis)
+      @pool[server] = nil
+    end
+
+    def self.reset(server)
+      quit(server)
+      conn(server)
+    end
+
+    private
+    def self.reachable?(redis)
+      redis.ping == "PONG"
+    end
+  end
+end

data/lib/redisable/kvs_key.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+module Redisable
+  module KVSKey
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # return model_name:id:field_name
+      def kvs_key(name, options={})
+        klass_name ||= self.name
+        define_method(name) do |id_=nil|
+          id_ ||= if options[:id]
+                    options[:id].call(self)
+                  else
+                    self.id
+                  end
+          KVSKey.join_key(klass_name, id_, name, options[:blank_field])
+        end
+        define_singleton_method(name) do |id_=nil|
+          id_ ||= opts[:id].call(self)
+          KVSKey.join_key(klass_name, id_, name, options[:blank_field])
+        end
+      end
+    end
+
+    def self.join_key(klass_name, id, name, is_blank_field)
+      k = "#{klass_name}"
+      k << ":#{id}" if id
+      k << ":#{name}" unless is_blank_field
+      k
+    end
+  end
+end

data/lib/redisable/version.rb

@@ -0,0 +1,3 @@
+module Redisable
+  VERSION = "0.0.1"
+end

data/redisable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redisable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redisable"
+  spec.version       = Redisable::VERSION
+  spec.authors       = ["yoppi"]
+  spec.email         = ["y.hirokazu@gmail.com"]
+  spec.description   = %q{Thin wrapper library for Redis, enable any Ruby class to access Redis.}
+  spec.summary       = %q{Thin wrapper library for Redis.}
+  spec.homepage      = "http://github.com/yoppi/redisable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "redis"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/config_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Redisable::Config do
+  let(:conf) {
+    {
+      host: "localhost",
+      port: "6379",
+      db: 1,
+    }
+  }
+  describe ".load/.conf" do
+    it "store and get Redis configuration" do
+      Redisable::Config.load(conf)
+      Redisable::Config.conf.should == conf
+    end
+  end
+end

data/spec/connection_spec.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Redisable::Connection do
+  let(:server) {:application}
+  let(:conf) {
+    {
+      host: "localhost",
+      port: "6379",
+      db: "1",
+    }
+  }
+  describe ".conn" do
+    context "in access ':application' first time" do
+      it "create connection" do
+        Redisable::Config.stub(:conf) { conf }
+        Redis.any_instance.stub(:ping) { "PONG" }
+        Redisable::Connection.conn(server)
+        Redisable::Connection.instance_variable_get("@pool").size.should == 1
+      end
+      after do
+        Redisable::Connection.instance_variable_set("@pool", {})
+      end
+    end
+    context "in request timeout" do
+      it "raise RuntimeError" do
+        Redisable::Config.stub(:conf) { conf }
+        Redis.any_instance.stub(:ping) { "" }
+        expect {
+          Redisable::Connection.conn(server)
+        }.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/kvs_key_spec.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+class User
+  include Redisable::KVSKey
+end
+
+describe Redisable::KVSKey do
+  describe ".join_key" do
+    context "Field name is not blank" do
+      it "join with ':' specified key, id and name" do
+        Redisable::KVSKey.join_key("user", "100", "status", false).should == "user:100:status"
+      end
+    end
+
+    context "Field name is blank" do
+      it "join with ':' specified key, id" do
+        Redisable::KVSKey.join_key("user", "100", "status", true).should == "user:100"
+      end
+    end
+  end
+
+  describe "to include" do
+    it "defined 'kvs_key' method" do
+      defined?(User.kvs_key).should == "method"
+    end
+  end
+end

data/spec/redisable_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class User
+  include Redisable
+end
+
+describe Redisable do
+  it "autoload modules" do
+    defined?(Redisable::Config).should == "constant"
+    defined?(Redisable::Connection).should == "constant"
+    defined?(Redisable::KVSKey).should == "constant"
+  end
+
+  describe "Include module" do
+    it "define kvs_key method" do
+      defined?(User.kvs_key).should == "method"
+    end
+    it "define redis method" do
+      defined?(User.redis).should == "method"
+    end
+    it "define redis instance method" do
+      defined?(User.new.send(:redis)).should == "method"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'redisable'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: redisable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yoppi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Thin wrapper library for Redis, enable any Ruby class to access Redis.
+email:
+- y.hirokazu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redisable.rb
+- lib/redisable/config.rb
+- lib/redisable/connection.rb
+- lib/redisable/kvs_key.rb
+- lib/redisable/version.rb
+- redisable.gemspec
+- spec/config_spec.rb
+- spec/connection_spec.rb
+- spec/kvs_key_spec.rb
+- spec/redisable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/yoppi/redisable
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Thin wrapper library for Redis.
+test_files:
+- spec/config_spec.rb
+- spec/connection_spec.rb
+- spec/kvs_key_spec.rb
+- spec/redisable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: