cachely 0.0.3 → 0.0.4

data/README.md

@@ -64,8 +64,8 @@ will still work, it will cache both the instance method foo and the class method
 keyed locations, of course. To specify instance or class method, do
 
 		cachely :foo, :type => "instance"
-		cachely :foo, :type => "class"
-		
+		cachely :foo, :type => "class"	
+
 Cachely is able to figure out whether or not to use the cache by looking at the arguments you pass in.
 Generally, if your arguments are the same, and the object you're calling the method on is the same(Cachely uses 
 the to_json method on the object you call the method on to determine this), then it assumes the result
@@ -74,6 +74,11 @@ will be the same and uses the cached result.
 Cachely expects that any objects you return or pass in to methods as arguments have to_json methods. Without
 this, it won't work. 
 
+Because of this, you can expire method results by their "signatures", that is, the object the method is being called on,
+the method name, and it's arguments. To expire a cached result by this signature, call
+
+    Cachely::Mechanics.expire(object, method, *args)
+
 CAVEAT: Do NOT use Cachely for functions that depend on time of day or random numbers, as these are inherently uncachable. 
 If you check the tests out, you'll see random number functions are used exhaustively to test the caching ability of cachely,
 because we know the function wasn't called if the second call yields the same number.

data/lib/cachely/mechanics.rb

@@ -37,7 +37,7 @@ module Cachely
       end
       return @redis  
     end
-    
+   
     # Defines the method using my hacky eval script. So far, this is the only way I've found that
     # allows me to define variable argument length definitions. If you have a better idea, please
     # refactor it!
@@ -48,34 +48,56 @@ module Cachely
       context = (is_class_method ? klazz : klazz.new)
       args_str = context.method("#{name.to_s}_old".to_sym).parameters.map { |k| k.last}.join(',')
       args_to_use_in_def = args_str.empty? ? "" : "," + args_str
+      time_exp_str = time_to_expire_in_s.nil? ? ",nil" : ",time_to_expire_in_s"
       eval("klazz.define_#{is_class_method ? "singleton_" : ""}method(:#{name}) do #{args_str.empty? ? "" : "|#{args_str}|"}; " +
-        "result = Cachely::Mechanics.get(context,:#{name}#{args_to_use_in_def});" +
+        "result = Cachely::Mechanics.get(context,:#{name}#{time_exp_str}#{args_to_use_in_def});" +
         "return result.first if result.is_a?(Array);" + 
         "result = context.send(:#{"#{name.to_s}_old"}#{args_to_use_in_def});" + 
-        "Cachely::Mechanics.store(context,:#{"#{name.to_s}"}, result#{time_to_expire_in_s.nil? ? ",nil": ",#{time_to_expire_in_s}"}#{args_to_use_in_def});" +
+        "Cachely::Mechanics.store(context,:#{"#{name.to_s}"}, result#{time_exp_str}#{args_to_use_in_def});" +
         "return result;" + 
         "end"
       )
     end
-    
+ 
+    # Force-expires a result to a method with this signature given by obj, method, args.
+    #
+    # @obj [Object] the object you're calling method on
+    # @method [String,Symbol] the method name
+    # @args The arguments of the method
+    # @return The original response of the method back, whatever it may be.
+    def self.expire(obj, method, *args)
+      key = redis_key(obj, method, *args)
+      result = get(obj,method,1,*args)
+      redis.del(key)
+      return result
+    end   
+
     # Gets a cached response to a method.
     #
+    # @obj [Object] the object you're calling method on
+    # @time_to_exp_in_s [Fixnum] num of seconds to set expire on key. Needs to be reset.
     # @method [String,Symbol] the method name
     # @args The arguments of the method
     # @return The original response of the method back, whatever it may be.
-    def self.get(obj, method, *args)
-      result = redis.get(redis_key(obj, method, *args))
-      #return an array, bc if the result stored was nil, it looks the same as if
-      #we got no result back(which we would return nil) so we differentiate by putting
-      #our return value always in an array. Easy to check.
-      result.nil? ? nil : [map_s_to_param(result)]
+    def self.get(obj, method, time_to_exp_in_s, *args)
+      key = redis_key(obj, method, *args)
+      result = redis.get(key)
+      if result
+        redis.expire(key, time_to_exp_in_s) if time_to_exp_in_s #reset the expiry
+        #return an array, bc if the result stored was nil, it looks the same as if
+        #we got no result back(which we would return nil) so we differentiate by putting
+        #our return value always in an array. Easy to check.
+        return [map_s_to_param(result)]
+      end   
     end
     
     # Stores the result in it's proper cached location on redis by getting the redis key and parsing
     # The result into a storable string, mostly made up of recursive json.
     #
+    # @obj [Object] object you call method on
     # @method [Symbol] Method name
     # @result Anything, really.
+    # @time_to_exp_in_s time in seconds before it expires
     # @args Arguments of the method
     # @return [String] Should be "Ok" or something similar.
     def self.store(obj, method, result, time_to_exp_in_sec, *args) 

data/lib/cachely/version.rb

@@ -1,3 +1,3 @@
 module Cachely
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/models/dummy_class.rb

@@ -3,6 +3,7 @@ class DummyClass
   attr_accessor :random_no
   
   cachely :cache_expiry, time_to_expiry: 1.seconds
+  cachely :cache_expiry_3, time_to_expiry: 3.seconds
   
   cachely :class_diff, time_to_expiry: 3.minutes
   
@@ -127,6 +128,10 @@ class DummyClass
     rand(500)
   end
   
+  def cache_expiry_3
+    rand(500)
+  end
+
   def cache_expiry
     rand(500)
   end

data/test/unit/cachely_test.rb

@@ -142,5 +142,17 @@ class CachelyTest < BaseTest
     sleep(3)
     assert_not_equal(old, obj.cache_expiry)
   end
+ 
+  test "cache with 3 s expiry doesnt expire in 3 s if we keep hitting it" do
+    obj = DummyClass.new
+    old = obj.cache_expiry_3
+    5.times do #should still be present on fourth and fifth times
+      sleep(1)
+      assert_equal(old, obj.cache_expiry_3)
+    end
   
+    sleep(4)
+    assert_not_equal(old, obj.cache_expiry_3)
+  end
+
 end

data/test/unit/mechanics_test.rb

@@ -5,12 +5,12 @@ require_relative 'base_test.rb'
 class MechanicsTest < BaseTest
   test "get/store array" do
     Cachely::Mechanics.store(DummyClass,:foo, [1,2,3], nil, [3,4])
-    assert_equal(0, [1,2,3] <=> Cachely::Mechanics.get(DummyClass,:foo, [3,4]).first)
+    assert_equal(0, [1,2,3] <=> Cachely::Mechanics.get(DummyClass,:foo,nil, [3,4]).first)
   end
   
   test "get/store hash" do
     Cachely::Mechanics.store(DummyClass,:foo, {:bar => "baz"}, nil, [3,4])
-    respawned = Cachely::Mechanics.get(DummyClass,:foo, [3,4]).first
+    respawned = Cachely::Mechanics.get(DummyClass,:foo,nil, [3,4]).first
     assert_equal(1, respawned.keys.size)
     assert_equal("baz", respawned[:bar])
   end
@@ -18,7 +18,7 @@ class MechanicsTest < BaseTest
   test "get/store orm" do
     d = DummyModel.create!(:attr_1 => 1, :attr_2 => 3)
     Cachely::Mechanics.store(DummyClass,:foo, d,nil,[3,4])
-    respawned = Cachely::Mechanics.get(DummyClass,:foo, [3,4]).first
+    respawned = Cachely::Mechanics.get(DummyClass,:foo, nil, [3,4]).first
     assert_equal(d.id, respawned.id)
     assert_equal(d.attr_1, respawned.attr_1)
     assert_equal(d.attr_2, respawned.attr_2)
@@ -27,15 +27,29 @@ class MechanicsTest < BaseTest
   test "get/store to_json" do
     d = DummyClass.new
     Cachely::Mechanics.store(DummyClass,:foo, d,nil, [3,4])
-    respawned = Cachely::Mechanics.get(DummyClass,:foo, [3,4]).first
+    respawned = Cachely::Mechanics.get(DummyClass,:foo, nil, [3,4]).first
     assert_equal(d.random_no, respawned.random_no)
   end
   
   test "get/store primitive" do
     [3, "3", true, false, nil, 3.5, :stuff].each do |result|
       Cachely::Mechanics.store(DummyClass,:foo, result, nil, [3,4])
-      respawned = Cachely::Mechanics.get(DummyClass,:foo, [3,4]).first
+      respawned = Cachely::Mechanics.get(DummyClass,:foo, nil, [3,4]).first
       assert_equal(result, respawned)
     end
   end
-end
+
+  test "expire method works" do
+    old = DummyClass.class_fixnum
+    assert_equal(old, DummyClass.class_fixnum)
+    Cachely::Mechanics.expire(DummyClass, :class_fixnum)
+    assert_not_equal(old, DummyClass.class_fixnum)
+
+    obj = DummyClass.new
+    old = obj.instance_fixnum_one(5)
+    assert_equal(old, obj.instance_fixnum_one(5))
+    Cachely::Mechanics.expire(obj, :instance_fixnum_one,5)
+    assert_not_equal(old, obj.instance_fixnum_one(5))
+  end 
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cachely
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &16110720 !ruby/object:Gem::Requirement
+  requirement: &9945220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *16110720
+  version_requirements: *9945220
 - !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &16121280 !ruby/object:Gem::Requirement
+  requirement: &9958720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *16121280
+  version_requirements: *9958720
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &16118820 !ruby/object:Gem::Requirement
+  requirement: &9954440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16118820
+  version_requirements: *9954440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &16116540 !ruby/object:Gem::Requirement
+  requirement: &9960660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16116540
+  version_requirements: *9960660
 description: Transparently cache the results of methods using redis.
 email:
 - jordanmprince@gmail.com