norton 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee3da14bf4d8ec51e4e8d54c25ea0966c9c58d07
-  data.tar.gz: 813138687ec12b2644a58057124bb2dec28ed932
+  metadata.gz: 52cebefc625bc8849d14c08a088a65213b46e8d5
+  data.tar.gz: 4b0b03f6c8ce33efd2ee204069f7f9591486c9ca
 SHA512:
-  metadata.gz: abc487e4bcf8af8f0daec1bea18ac0a3ff6ae386a6af0b60e0b03f5513051967be3e0d5733296c8cf1cc80259c74e3805fa86406184357d8855a65d099e9ad5a
-  data.tar.gz: fded12ea44ef90a3937e38ce58340f68c379ec713463cb9dd4c2daea8e96e3a267feba80f31a8724a2bd57393b34be389265dc4856de69ddc307226c089ad927
+  metadata.gz: 1186e9ab5f99dd6080ab6617c5f1ad1a860ab05ff200cec9da882c637246f32306b78bea44c0fce160ad644a692dcca2404c3abdd721fc32192670cb53c70c69
+  data.tar.gz: 1f779ccd40aab40c2c2b559cb5f3248668c2a9e64efcfb222feae13565da158a915a5894274636a3347cdefe35ffa7eace6d50daa0ee612c69d1cf649461ffc1

data/README.md

@@ -1,7 +1,5 @@
 # Norton
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,14 +14,81 @@ Or install it yourself as:
 
     $ gem install norton
 
+## Setup
+
+You need to setup Norton with a redis connection, 
+
+`Norton.setup url: <some redis connection url> `
+
+Norton use `ConnectionPool` to hold redis connections, so you could also specify a pool size and a timeout like below. By default `pool = 1` and `timeout = 2`.
+
+`Norton.setup url: <some redis connection url>, pool: 5, timeout: 5`
+
 ## Usage
 
-TODO: Write usage instructions here
+### Counter
+
+Simply include `Norton::Counter` in your model, and define a counter.
+
+```
+class User < ActiveRecord::Base
+  include Norton::Counter
+  
+  counter :total_likes_count
+end
+```
+
+- `users:<id>:total_likes_count` value will be created in redis to hold this counter.
+- `user.total_likes_count=` to set the count to any number
+- `user.incr_total_likes_count` to incr the counter by 1
+- `user.decr_total_likes_count` to decr the counter by 1
+
+You could also give a reset block:
+
+```
+class User < ActiveRecord::Base
+  include Norton::Counter
+  
+  counter :total_likes_count do
+    self.likes.count
+  end
+end
+```
+
+- `user.reset_total_likes_count` will evaluate the block and use the return value to set the counter
+
+
+### Timestamp
+
+Simply include `Norton::Timestamp` in your model, and define a timestamp.
+
+```
+class Note < ActiveRecord::Base
+  include Norton::Timestamp
+  
+  timestamp :content_updated_at
+end
+```
+
+- `notes:<id>:content_updated_at` is created in redis to hold this timestamp
+- `note.content_updated_at` is created to get the timestamp
+- `note.touch_content_update_at` is created to update the timestamp to `Time.now.to_i`
+
+You could specify callbacks along with condition Procs of when to touch the timestamp:
+
+```
+class Note < ActiveRecord::Base
+  include Norton::Timestamp
+  
+  timestamp :content_updated_at, before_save: Proc.new { title_changed? || content_changed? }
+end
+```
 
+In the case above, `note.touch_content_updated_at` will be called when `before_save` is fired and `title_changed? || content_changed?` is fulfilled.
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/norton/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 new Pull Request
+5. Create new Pull Request

data/lib/norton/timestamp.rb

@@ -40,4 +40,4 @@ module Norton
       end
     end
   end
-end
+end

data/lib/norton/version.rb

@@ -1,3 +1,3 @@
 module Norton
-  VERSION = "0.0.7"
-end
+  VERSION = "0.0.8"
+end

data/norton.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "redis", "~> 3.1.0"
   spec.add_dependency "connection_pool", "~> 2.1.0"
-  spec.add_dependency "activesupport", "~> 4.1.8"
+  spec.add_dependency "activesupport", "~> 4.1"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.5.1"
-  spec.add_development_dependency "activerecord", "~> 4.1.8"
+  spec.add_development_dependency "activerecord", "~> 4.1"
   spec.add_development_dependency "activerecord-nulldb-adapter"
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norton
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Larry Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activerecord-nulldb-adapter
   requirement: !ruby/object:Gem::Requirement