counter-cache-credis 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a585b8d20156eb0c31c740f10e957f31774f0176
-  data.tar.gz: dfec7c1f05fab6df3d672ecbbbc2110aad33f96e
+  metadata.gz: 3d461aa5d18a56b3b38020e4fa087d7ec54bb8fd
+  data.tar.gz: 32bad92c4022621e8ee48ba4f5839ad9cc71be0d
 SHA512:
-  metadata.gz: 3cc2d71758aa92469216577aaac9c5dceec3dcbaa80fcec0947b536064c4f055bce903a760eece37c40f7c52ff66eccd118bb7643b51b5bbd10b311ce4c1e59a
-  data.tar.gz: d1ea1e9e42a5b77628a2106206e82abcc3fd8ab1b3f9bf968408d50ae802dbc67671b4b54c944b0eb4c3f60e78ef0e32108ef9a7519da22bb7e92f0b0fa09887
+  metadata.gz: d2d180f05fd184a127c03118a06b40ca9d49946a267af0a956ea0413442d3f7a5032b5c25ba16c6892fceb0c4e5d6f2edb45aff28fb6eda97329352608ba2469
+  data.tar.gz: 40cfb7f6a2c5e0f7254a512ea8c4b632ca6404257b22609f1acd4b10263ca24fd414cf30743734880c8315b8d3b475cbe64875bde0b4d8e9f19ddab4dda673f4

data/README.md

@@ -1,10 +1,6 @@
 # Counter::Cache::Redis
 
-未完成。
-
-实现效果：
-
-能根据不同表来设置不同字段，读取也在 redis，而不用再通过 DB
+Set a counter for model through redis in order to improve perfomance.
 
 ## Installation
 
@@ -12,6 +8,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'counter-cache-redis'
+gem 'redis'
 ```
 
 And then execute:
@@ -24,7 +21,58 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Init
+
+```ruby
+rails g redis_config
+```
+It will create `config/redis.yml`
+
+```ruby
+# redis.yml
+redis: &redis
+  redis_port: 6379
+  redis_namespace: 'redis'
+  redis_db: 0
+
+test:
+  <<: *redis
+  redis_host: 'localhost'
+
+development:
+  <<: *redis
+  redis_host: 'localhost'
+
+production:
+  <<: *redis
+  redis_host: 'localhost'
+
+```
+
+### Use
+
+```ruby
+student = Student.first
+# It will increase itself by one
+student.update_counter
+# get views_count through redis
+student.get_views_count_cache
+```
+
+### Configure
+```ruby
+class Student < ActiveRecord::Base
+  # select custom column
+  counter_cache_redis column: :hello_count
+end
+```
+```ruby
+class Student < ActiveRecord::Base
+  # When cache of redis is bigger than 50, it will write to db and refresh redis
+  # default is 20
+  counter_cache_redis delay: 50
+end
+```
 
 ## Contributing
 

data/lib/counter/cache/credis/counter.rb

@@ -18,7 +18,7 @@ module Counter
 
         def counter_cache_redis(options = {})
           mattr_accessor :counter_delay, :column
-          self.counter_delay = options[:delay] || 1
+          self.counter_delay = options[:delay] || 20
           self.column = options[:column] || 'views_count'
           defind_column_getter if options[:column]
           include Counter::Cache::Credis::InstanceMethods

data/lib/counter/cache/credis/version.rb

@@ -1,7 +1,7 @@
 module Counter
   module Cache
     module Credis
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: counter-cache-credis
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - linjunzhu