redis-cacheable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c1551b9cda86647b91fc64934f9bc5d3db043a4
-  data.tar.gz: 27fde316e23c41e16ea71dda78164a28ed552047
+  metadata.gz: d39f90df0af7cdab3b63487d59fdd1dae095cdd5
+  data.tar.gz: f34c8c7764c257b3a9a361b420b317a4b90a68e8
 SHA512:
-  metadata.gz: a7bb129cab54e4436221fcb8e70f24cb8df39b584d1304f8ae96f82404bcab961eb7a8ce62044242af646597bbf15d6bc08862164ce24f53f460fc3295cb4928
-  data.tar.gz: b51ef2783bde32b7bef3001abb99ca9c9129f0063b49dae98183d74536e76af6006075dfd65e4b6d22ccac20389f5559b06e770823ea146424ea4719d67cdb3c
+  metadata.gz: c537829ce3c8b5c26e0b27fbf3d55180b6e7bcfadebb9c4b4910bc0bd77b98ecbabe6d0736e9d7930867f701d258f77023dd3fe0f195e89cd13174d30f691d50
+  data.tar.gz: 1dda563700067ef3f3fa5b4b64bebed28b10c1d7936aa265e203c37e267b59366c5a39b425f9ff5e4d57e2fac02b6e3274ae24732caa053e89c86d6aa3823f2b

data/README.md

@@ -1,4 +1,5 @@
 # redis-cacheable
+[![Gem Version](https://badge.fury.io/rb/redis-cacheable.png)](http://badge.fury.io/rb/redis-cacheable)
 [![Build Status](https://travis-ci.org/joker1007/redis-cacheable.png?branch=master)](https://travis-ci.org/joker1007/redis-cacheable)
 [![Coverage Status](https://coveralls.io/repos/joker1007/redis-cacheable/badge.png?branch=master)](https://coveralls.io/r/joker1007/redis-cacheable?branch=master)
 [![Code Climate](https://codeclimate.com/github/joker1007/redis-cacheable.png)](https://codeclimate.com/github/joker1007/redis-cacheable)

data/lib/redis_cacheable/active_record.rb

@@ -1,19 +1,25 @@
 require 'redis_cacheable'
 
+# Specialized for ActiveRecord
 module RedisCacheable
   module ActiveRecord
     extend ActiveSupport::Concern
     include ::RedisCacheable
 
     module ClassMethods
+      # @param [Object] key
+      # @return [ActiveRecord::Base] ActiveRecord instantiated object
       def find_from_redis(key)
         if data = super(key)
           instantiate(data)
         end
       end
 
-      def cache_all
-        find_each do |record|
+      # cache all persisted records
+      # @param [Hash] options pass to find_each method
+      # @return [void]
+      def cache_all(options = {})
+        find_each(options) do |record|
           record.cache_to_redis
         end
 

data/lib/redis_cacheable/connectable.rb

@@ -21,6 +21,22 @@ module RedisCacheable
       def redis(&blk)
         raise ArgumentError.new("Need block") unless blk
 
+        connection = __ensure_redis_connection__
+
+        case connection
+        when ConnectionPool
+          connection.with do |conn|
+            blk.call(__wrap_namespace__(conn))
+          end
+        when Redis
+          blk.call(__wrap_namespace__(connection))
+        else
+          raise "Not redis connection"
+        end
+      end
+
+      private
+      def __ensure_redis_connection__
         unless Connectable.redis_connection
           config = RedisCacheable::Configuration.config
           Connectable.redis_connection = ConnectionPool.new(size: config.pool_size, timeout: config.timeout) {
@@ -28,10 +44,11 @@ module RedisCacheable
           }
         end
 
-        Connectable.redis_connection.with do |conn|
-          namespaced_redis = Redis::Namespace.new(redis_namespace, redis: conn)
-          blk.call(namespaced_redis)
-        end
+        Connectable.redis_connection
+      end
+
+      def __wrap_namespace__(connection)
+        Redis::Namespace.new(redis_namespace, redis: connection)
       end
     end
 

data/lib/redis_cacheable/version.rb

@@ -1,3 +1,3 @@
 module RedisCacheable
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/redis_cacheable.rb

@@ -6,15 +6,44 @@ require 'redis_cacheable/version'
 require 'redis_cacheable/configuration'
 require 'redis_cacheable/connectable'
 
+# Usage:
+#
+# class CacheableObject
+#   include RedisCacheable
+#
+#   attr_reader :id, :name
+#
+#   redis_key :id
+#   redis_attrs :id, :name
+#
+#   def initialize(attrs)
+#     @id = attrs[:id]
+#     @name = attrs[:name]
+#   end
+# end
+#
+# CacheableObject.new(id: 1, name: "object").cache_to_redis
+# CacheableObject.find_from_redis(1) # => {"id" => 1, "name" => "target"}
 module RedisCacheable
   extend ActiveSupport::Concern
   include Connectable
 
   module ClassMethods
+
+    # @param [Symbol || Proc] key used by redis.set method
+    # @example If Symbol, param is method name
+    #   redis_key :uuid
+    # @example If Proc
+    #   redis_key ->(user) {"#{user.id}_{user.email}"}
     def redis_key(key)
       @__redis_cache_key__ = key
     end
 
+    # @param [Array<Symbol> || Proc] attributes
+    # @example If Symbols, param is method name
+    #   redis_attrs :uuid, :name, :email
+    # @example If Proc, proc must return JSON serializable object
+    #   redis_attrs ->(user) { {id: user.id, name: user.name, email: user.email} }
     def redis_attrs(*attributes)
       if attributes.first.is_a?(Proc)
         @__redis_cache_attrs__ = attributes.first
@@ -23,6 +52,8 @@ module RedisCacheable
       end
     end
 
+    # @param [Object] key JSON
+    # @return [String || Number || Array || Hash]
     def find_from_redis(key)
       redis do |conn|
         json = conn.get(key)

data/redis-cacheable.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kakyoin.hierophant@gmail.com"]
   spec.summary       = %q{Concern style helper of caching object to Redis}
   spec.description   = %q{Concern style helper of caching object to Redis}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/joker1007/redis-cacheable"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/lib/redis_cacheable/connectable_spec.rb

@@ -1,5 +1,9 @@
 require 'spec_helper'
 
+class ConnectableObject
+  include RedisCacheable::Connectable
+end
+
 describe RedisCacheable::Connectable do
   describe "Class including RedisCacheable::Connectable" do
     describe ".redis" do

data/spec/spec_helper.rb

@@ -18,7 +18,3 @@ RSpec.configure do |config|
     Redis.stub(:new).with(any_args) { MockRedis.new }
   end
 end
-
-class ConnectableObject
-  include RedisCacheable::Connectable
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cacheable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,7 +204,7 @@ files:
 - spec/lib/redis_cacheable/connectable_spec.rb
 - spec/lib/redis_cacheable_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/joker1007/redis-cacheable
 licenses:
 - MIT
 metadata: {}
@@ -234,4 +234,3 @@ test_files:
 - spec/lib/redis_cacheable/connectable_spec.rb
 - spec/lib/redis_cacheable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: