fresh_redis 0.0.6 → 0.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fresh_redis (0.0.6)
+    fresh_redis (0.0.7)
       redis
 
 GEM
@@ -16,7 +16,7 @@ GEM
       guard (>= 1.1)
       rspec (~> 2.11)
     listen (0.5.3)
-    mock_redis (0.5.2)
+    mock_redis (0.5.4)
     rake (0.9.2.2)
     rb-fsevent (0.9.2)
     rb-inotify (0.8.8)
@@ -39,7 +39,7 @@ PLATFORMS
 DEPENDENCIES
   fresh_redis!
   guard-rspec (= 2.1.0)
-  mock_redis (= 0.5.2)
+  mock_redis (= 0.5.4)
   rake (= 0.9.2.2)
   rb-fsevent
   rb-inotify

data/README.md

@@ -26,6 +26,8 @@ Or install it yourself as:
 
 ### Simple counts
 
+Increment a counter, but gradually expire portions of that counter. Useful for *"find count of X for the last Y minutes"* type queries, where some event occurs occasionally over a period of time.
+
 ```ruby
 require "redis"
 require "fresh_redis"
@@ -47,11 +49,32 @@ fresh.fsum "failed_login" # will return 2, cause the first incr has expired by n
 
 ### Hash operations
 
+fresh_redis Hashes work similarly to existing Redis hashes, except that keys have individual expiry.
+
 ```ruby
-# TODO
-```
+require "redis"
+require "fresh_redis"
+fresh = FreshRedis.new(Redis.current)
 
-TODO note about handling of deletes/nil values and :force option on `fhdel` operation
+fresh.fhset "temp_banned_users", "madlep", "too much cowbell"
+# wait a bit
+fresh.fhset "temp_banned_users", "normthegnome", "inappropriate office conduct"
+fresh.fhset "temp_banned_users", "joeblogs", "suspected ninja"
+
+# then straight away...
+fresh.fhget "temp_banned_users", "madlep" # will return "threatening..."
+fresh.fhget "temp_banned_users", "normthegnone" # will return "inappropriate..."
+fresh.fhget "temp_banned_users", "joeblogs", # will return "suspected..."
+fresh.fhgetall "temp_banned_users" # will return hash of {"madlep" => ..., "normthegnone" => ..., "joeblogs" => ...}
+
+# wait for first fhset to expire
+
+fresh.fhget "temp_banned_users", "madlep" # will return nil
+fresh.fhget "temp_banned_users", "normthegnone" # will return "inappropriate..." - unchanged
+fresh.fhget "temp_banned_users", "joeblogs", # will return "suspected..." - unchanged
+fresh.fhgetall "temp_banned_users" # will return hash WITHOUT "madlep" as a key (just "normthegnone" and "joeblogs")
+
+```
 
 ### Tweaking _"freshness"_ and _"granularity"_. 
 
@@ -59,14 +82,13 @@ Think of it like stock rotation at your local supermarket. Freshness is how long
 
 ```ruby
 # lets track douch users spamming the forum so we can do something about it...
+fresh = FreshRedis.new(Redis.current, :freshness => 600, :granularity => 30)
 
 # store post count for a user for 10 minutes (600 seconds), in buckets of time duration 30 seconds
-fresh.fincr "recent_posts:#{user.id}", :freshness => 600, :granularity => 30
-
-# ...
+fresh.fincr "recent_posts:#{user.id}"
 
-# note, need to pass in the SAME freshness and granularity options as fincr, so it can correclty lookup the correct keys
-fresh.fsum "recent_posts:#{user.id}", :freshness => 600, :granularity => 30
+# do stuff
+fresh.fsum "recent_posts:#{user.id}"
 ```
 
 # Recipes

data/fresh_redis.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'redis'
 
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'mock_redis', '0.5.2'
+  gem.add_development_dependency 'mock_redis', '0.5.4'
   gem.add_development_dependency 'guard-rspec', '2.1.0'
   gem.add_development_dependency 'rake', '0.9.2.2'
   gem.add_development_dependency 'timecop', '0.5.2'

data/lib/fresh_redis/key.rb

@@ -2,7 +2,6 @@ require 'time'
 
 class FreshRedis
   class Key
-    # TODO remove concept of time from a key. Just be about redis key, freshness, granularity
 
     DEFAULT_OPTIONS = {
       :freshness => 60 * 60, # 1 hour

data/lib/fresh_redis/string.rb

@@ -1,13 +1,33 @@
 class FreshRedis
   module String
+    def fincrby(key, increment, options={})
+      key = build_key(key, options)
+      @redis.multi do
+        @redis.incrby(key.redis_key, increment)
+        @redis.expire(key.redis_key, key.freshness)
+      end
+    end
+
     def fincr(key, options={})
+      fincrby(key, 1, options)
+    end
+
+    def fincrbyfloat(key, increment, options={})
       key = build_key(key, options)
       @redis.multi do
-        @redis.incr(key.redis_key)
+        @redis.incrbyfloat(key.redis_key, increment)
         @redis.expire(key.redis_key, key.freshness)
       end
     end
 
+    def fdecr(key, options={})
+      fincrby(key, -1, options)
+    end
+
+    def fdecrby(key, decrement, options={})
+      fincrby(key, -1 * decrement, options)
+    end
+
     def fsum(key, options={})
       key = build_key(key, options)
       @redis.pipelined {
@@ -15,7 +35,7 @@ class FreshRedis
           @redis.get(bucket_key)
         end
       }.reduce(0){|acc, value|
-        value ? acc + value.to_i : acc
+        value ? acc + value.to_f : acc
       }
     end
   end

data/lib/fresh_redis/version.rb

@@ -1,3 +1,3 @@
 class FreshRedis
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/fresh_redis/string_spec.rb

@@ -7,6 +7,7 @@ describe FreshRedis do
   let(:mock_redis) { MockRedis.new }
   let(:now) { Time.new(2012, 9, 27, 15, 40, 56, "+10:00") }
   let(:normalized_now_minute) { Time.new(2012, 9, 27, 15, 40, 0, "+10:00") }
+  let(:normalized_one_minute_ago) { Time.new(2012, 9, 27, 15, 39, 0, "+10:00") }
 
   before(:each) { Timecop.travel(now) }
   after(:each) { Timecop.return }
@@ -16,8 +17,9 @@ describe FreshRedis do
       it "should increment the key for the normalized timestamp" do
         Timecop.freeze(now)       { subject.fincr "foo" }
         Timecop.freeze(now + 3)   { subject.fincr "foo" }
-        Timecop.freeze(now + 60)  { subject.fincr "foo" } # different normalized key
+        Timecop.freeze(now - 60)  { subject.fincr "foo" } # different normalized key
         mock_redis.data["foo:#{normalized_now_minute.to_i}"].to_i.should == 2
+        mock_redis.data["foo:#{normalized_one_minute_ago.to_i}"].to_i.should == 1
       end
 
       it "should set the freshness as the expiry" do
@@ -27,21 +29,75 @@ describe FreshRedis do
       end
     end
 
+    describe "#fincrby" do
+      it "should increment the key for the normalized timestamp by the specified amount" do
+        Timecop.freeze(now)       { subject.fincrby "foo", 2 } 
+        Timecop.freeze(now + 3)   { subject.fincrby "foo", 3 }
+        Timecop.freeze(now - 60)  { subject.fincrby "foo", 4 } # different normalized key
+        mock_redis.data["foo:#{normalized_now_minute.to_i}"].to_i.should == 5
+        mock_redis.data["foo:#{normalized_one_minute_ago.to_i}"].to_i.should == 4
+      end
+
+      it "should set the freshness as the expiry" do
+        # relying on mock_redis's time handling here - which converts to/from using Time.now Possible flakey temporal breakage potential
+        subject.fincrby "foo", 5, :freshness => 3600
+        mock_redis.ttl("foo:#{normalized_now_minute.to_i}").should == 3600
+      end
+    end
+
+    describe "#fincrbyfloat" do
+      it "should increment the key for the normalized timestamp by the specified amount" do
+        Timecop.freeze(now)       { subject.fincrbyfloat "foo", 2.1 } 
+        Timecop.freeze(now + 3)   { subject.fincrbyfloat "foo", 3.2 }
+        Timecop.freeze(now - 60)  { subject.fincrbyfloat "foo", 4.3 } # different normalized key
+        mock_redis.data["foo:#{normalized_now_minute.to_i}"].to_f.should be_within(0.00001).of(5.3)
+        mock_redis.data["foo:#{normalized_one_minute_ago.to_i}"].to_f.should be_within(0.00001).of(4.3)
+      end
+
+      it "should set the freshness as the expiry" do
+        # relying on mock_redis's time handling here - which converts to/from using Time.now Possible flakey temporal breakage potential
+        subject.fincrbyfloat "foo", 5, :freshness => 3600
+        mock_redis.ttl("foo:#{normalized_now_minute.to_i}").should == 3600
+      end
+    end
+
+    describe "#fdecr" do
+      it "should decrement the key for the normalized timestamp" do
+        Timecop.freeze(now)       { subject.fdecr "foo" }
+        Timecop.freeze(now + 3)   { subject.fdecr "foo" }
+        Timecop.freeze(now - 60)  { subject.fdecr "foo" } # different normalized key
+        mock_redis.data["foo:#{normalized_now_minute.to_i}"].to_i.should == -2
+        mock_redis.data["foo:#{normalized_one_minute_ago.to_i}"].to_i.should == -1
+      end
+
+      it "should set the freshness as the expiry" do
+        # relying on mock_redis's time handling here - which converts to/from using Time.now Possible flakey temporal breakage potential
+        subject.fdecr "foo", :freshness => 3600
+        mock_redis.ttl("foo:#{normalized_now_minute.to_i}").should == 3600
+      end
+    end
+
+    describe "#fdecrby" do
+      it "should decrement the key for the normalized timestamp by the specified amount" do
+        Timecop.freeze(now)       { subject.fdecrby "foo", 2 } 
+        Timecop.freeze(now + 3)   { subject.fdecrby "foo", 3 }
+        Timecop.freeze(now - 60)  { subject.fdecrby "foo", 4 } # different normalized key
+        mock_redis.data["foo:#{normalized_now_minute.to_i}"].to_i.should == -5
+        mock_redis.data["foo:#{normalized_one_minute_ago.to_i}"].to_i.should == -4
+      end
+
+      it "should set the freshness as the expiry" do
+        # relying on mock_redis's time handling here - which converts to/from using Time.now Possible flakey temporal breakage potential
+        subject.fdecrby "foo", 5, :freshness => 3600
+        mock_redis.ttl("foo:#{normalized_now_minute.to_i}").should == 3600
+      end
+    end
+
     describe "#fsum" do
-      subject{ FreshRedis.new(mock_redis, :granularity => 10, :freshness => 60) }
       it "should add the values of keys for specified freshness and granularity" do
-        Timecop.freeze(now - 60 - 10) { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 1)  { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 2)  { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 3)  { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 5)  { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 8)  { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 13) { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 21) { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 34) { subject.fincr "foo" }
-        Timecop.freeze(now - 60 + 55) { subject.fincr "foo" }
-
-        subject.fsum("foo").should ==  9
+        mock_redis.set("foo:#{normalized_now_minute.to_i}", "7")
+        mock_redis.set("foo:#{normalized_one_minute_ago.to_i}", "-2")
+        subject.fsum("foo").should ==  5
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fresh_redis
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3713423432962146166
+      hash: 3765390037678342565
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3713423432962146166
+      hash: 3765390037678342565
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23