cache_driver 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 402b06942adc9a03461be8eed481772cf10c1b09
-  data.tar.gz: d9d317fc326141587e83dd42483387c42475e27c
+  metadata.gz: 4d83400081bd047d18a81a8963c3ff153907b8e6
+  data.tar.gz: 2ad7f261510c4a34f30a11d28e70029fb9f1927b
 SHA512:
-  metadata.gz: cd99e95e14c5261382c8e3e3ee89d6e7db524205ba4c9ee6022e580ad8a6613c2e509ce2a6d7af603cb84178a694c26a10af64e75588e7da21e0c73e16d1ad53
-  data.tar.gz: 47059c2b1880671f93c627f4270acce731339b29ca9296b72e66e9119dbe6d75ecf70a47c7b4ba7386c169d0dabc8f48d65782117b15edc52ca5a1df8a298874
+  metadata.gz: 7031b3a78d2e6295d3007b0d6083cebd12b9224c57c21e7e7d11b7a874ce422bee03be770df6b53509e214317ebdd8feceb6ef89f9f4a16c1d5a318c92661ff0
+  data.tar.gz: 3921d0cf509f78461e581b0e6e18114a1d13dc9b1ab63f7b24afdb02175953859cdac74b3ef4731bbafce01a501febc2618dbc76773bffe18a1a7723c717dd50

data/README.md

@@ -20,18 +20,17 @@ Or install it yourself as:
 
 ## Usage
 
-Your can create a config file to set storage type  
-
-    $ touch config/initializers/cache_driver.rb
+Add following code to environments/development.rb or environments/production.rb  
 
 ```ruby
-# CacheDriver Config
-# to make model save data to file or redis not database
-
 CacheDriver.setup do |config|
 	# set cache store type, :file or :redis
-	# default is :file
 	config.store = :file
+	config.file_dir = Rails.root.join('tmp', 'cache')
+	#config.store = :redis
+	#config.redis_host = "127.0.0.1"
+	#config.redis_port = 6379
+	#config.redis_namespace = "namespace"
 end
 ```
 
@@ -43,6 +42,10 @@ Just define model like below
 
 ```ruby
 class CacheModel < CacheRecord
+	# attribute name which is made as key to cache data
+	def self.key_attr
+		"attr_name"
+	end
 end
 ```
 
@@ -51,7 +54,7 @@ So you can use this model just like other ActiveRecord instance in controllers l
 ```ruby
 cache_models = CacheModel.find_all  # get all instance in cache  
 
-cache_model = CacheModel.find_by_id params[:id]  # get instance with id
+cache_model = CacheModel.find_by_key key  # get instance with key
 
 cache_model.save!  # save this instance to cache
 
@@ -63,11 +66,11 @@ Just override the two methods below
 
 ```ruby
 def to_cache
-  # do something you want to cache this model
+  # return a hashmap which you want to cache for this model
 end
 
-def self.from_cache
-  # do something you want to get model from cache
+def self.from_cache(obj)
+  # return this model instance from a hashmap obj include data you cached
 end
 ```
 

data/lib/cache_driver/cache_record.rb

@@ -1,20 +1,19 @@
 class CacheRecord
-  @@cache_util = CacheDriver.store_file? ? FileCacheUtil : CacheDriver.store_redis? ? RedisCacheUtil : nil
 
   def self.find_all
-    @@cache_util.read_all CacheUtil.class_to_type(self)
+    CacheRecord.cache_util.read_all CacheUtil.class_to_type(self)
   end
 
   def self.find_by_key(key)
-    @@cache_util.read CacheUtil.class_to_type(self), id
+    CacheRecord.cache_util.read CacheUtil.class_to_type(self), key
   end
 
   def save!
-    @@cache_util.write CacheUtil.class_to_type(self.class), self
+    CacheRecord.cache_util.write CacheUtil.class_to_type(self.class), self.send(self.class.key_attr), self
   end
 
   def destroy
-    @@cache_util.delete CacheUtil.class_to_type(self.class), self.id
+    CacheRecord.cache_util.delete CacheUtil.class_to_type(self.class), self.send(self.class.key_attr)
   end
 
   def to_cache
@@ -28,4 +27,9 @@ class CacheRecord
     end
     ins
   end
+
+  private
+  def self.cache_util
+    CacheDriver.store_file? ? FileCacheUtil : CacheDriver.store_redis? ? RedisCacheUtil : nil
+  end
 end

data/lib/cache_driver/cache_util.rb

@@ -2,7 +2,7 @@ class CacheUtil
 
   class << self
     def write(type, key, data)
-      puts "[CACHE] save #{type} ##{key} to cache: #{data}"
+      puts "[CACHE] save #{type} ##{key} to cache"
     end
 
     def read(type, key)

data/lib/cache_driver/config.rb

@@ -3,6 +3,12 @@ module CacheDriver
     attr_accessor :store, :file_dir, :redis_host, :redis_port, :redis_namespace
   end
 
+  @@config = Config.new
+
+  def self.config
+    @@config
+  end
+
   def self.configed?
     @@config.store
   end
@@ -16,7 +22,6 @@ module CacheDriver
   end
 
   def self.setup
-    @@config = Config.new
     yield @@config
   end
 

data/lib/cache_driver/file_cache_util.rb

@@ -1,15 +1,14 @@
 class FileCacheUtil < CacheUtil
-  @@file_dir = CacheDriver.file_dir
 
   class << self
     def write(type, key, data)
-      super type, data
+      super type, key, data
 
-      dir = @@file_dir.join type_to_dir(type)
+      dir = file_dir.join type_to_dir(type)
       Dir.mkdir dir unless Dir.exist? dir
 
       file = File.new dir.join("#{key}.cache"), 'w'
-      file.puts "#{Time.now} --> #{data.to_cache}"
+      file.puts "#{Time.now} --> #{data.to_cache.to_json}"
       file.close
 
       key
@@ -18,7 +17,7 @@ class FileCacheUtil < CacheUtil
     def read(type, key)
       super type, key
 
-      dir = @@file_dir.join type_to_dir(type)
+      dir = file_dir.join type_to_dir(type)
       Dir.mkdir dir unless Dir.exist? dir
 
       file_path = dir.join("#{key}.cache")
@@ -38,7 +37,7 @@ class FileCacheUtil < CacheUtil
     def read_all(type)
       super type
 
-      dir = @@file_dir.join type_to_dir(type)
+      dir = file_dir.join type_to_dir(type)
       Dir.mkdir dir unless Dir.exist? dir
       dir_scaner = Dir.new dir
 
@@ -63,7 +62,7 @@ class FileCacheUtil < CacheUtil
     def delete(type, key)
       super type, key
 
-      dir = @@file_dir.join type_to_dir(type)
+      dir = file_dir.join type_to_dir(type)
       return true unless Dir.exist? dir
 
       file_path = dir.join("#{key}.cache")
@@ -71,5 +70,10 @@ class FileCacheUtil < CacheUtil
       File.delete file_path
       true
     end
+
+    private
+    def file_dir
+      CacheDriver.config.file_dir
+    end
   end
 end

data/lib/cache_driver/redis_cache_util.rb

@@ -1,25 +1,23 @@
 class RedisCacheUtil < CacheUtil
-  @@redis = Redis.new :host => CacheDriver.redis_host, :port => CacheDriver.redis_port
-  @@namespace = CacheDriver.redis_namespace
 
   class << self
     def write(type, key, data)
-      super type, data
+      super type, key, data
 
-      res = @@redis.set "#{@@namespace}:#{type_to_dir(type)}##{key}", "#{Time.now} --> #{data.to_cache}"
+      res = redis.set "#{namespace}:#{type_to_dir(type)}##{key}", "#{Time.now} --> #{data.to_cache.to_json}"
       res == "OK" ? key : nil
     end
 
     def read(type, key)
       super type, key
 
-      content = @@redis.get("#{@@namespace}:#{type_to_dir(type)}##{key}")
+      content = redis.get("#{namespace}:#{type_to_dir(type)}##{key}")
       unless content
         puts "cache #{type} ##{key} data miss"
         return nil
       end
 
-      data_str = file.read.split(" --> ")[1]
+      data_str = content.split(" --> ")[1]
       unless data_str
         puts "cache #{type} ##{key} data miss"
         return nil
@@ -32,15 +30,16 @@ class RedisCacheUtil < CacheUtil
     def read_all(type)
       super type
 
+      r = self.redis
       data = []
-      @@redis.keys("#{@@namespace}:#{type_to_dir(type)}#*").each do |key|
-        content = @@redis.get(key)
+      r.keys("#{namespace}:#{type_to_dir(type)}#*").each do |key|
+        content = r.get(key)
         unless content
           puts "cache #{key} data miss"
           next
         end
 
-        data_str = file.read.split(" --> ")[1]
+        data_str = content.split(" --> ")[1]
         unless data_str
           puts "cache #{key} data miss"
           next
@@ -56,8 +55,17 @@ class RedisCacheUtil < CacheUtil
     def delete(type, key)
       super type, key
 
-      res = @@redis.del("#{@@namespace}:#{type_to_dir(type)}##{key}")
+      res = redis.del("#{namespace}:#{type_to_dir(type)}##{key}")
       res == 1
     end
+
+    private
+    def redis
+      Redis.new :host => CacheDriver.config.redis_host, :port => CacheDriver.config.redis_port
+    end
+
+    def namespace
+      CacheDriver.config.redis_namespace
+    end
   end
 end

data/lib/cache_driver/version.rb

@@ -1,3 +1,3 @@
 module CacheDriver
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/cache_driver.rb

@@ -1,3 +1,5 @@
+require "redis"
+
 require "cache_driver/version"
 require "cache_driver/config"
 require "cache_driver/cache_record"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_driver
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - goshan