sir_cachealot 0.4.0 → 0.4.1

data/README.md

@@ -10,7 +10,7 @@ Future plans for 1.0:
 
 Add this line to your application's Gemfile:
 
-    gem 'SirCachealot'
+    gem 'sir_cachealot'
 
 And then execute:
 
@@ -18,11 +18,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install SirCachealot
+    $ gem install sir_cachealot
 
 ## Usage
 
-SirCachealot creates a new globally-accessible class named `Sir`.
+SirCachealot exposes a new module named `Sir`. This module is designed to be available globally in both Rails apps and vanilla Ruby scripts (don't forget `require 'sir_cachealot'`!)
 
 **You can use SirCachealot immediately, using either:**
 
@@ -31,21 +31,28 @@ SirCachealot creates a new globally-accessible class named `Sir`.
 
 `put()` will return the object you gave it. This is useful if you wish to use `get()`'s `yield` functionality.
 
+If `config(:delete_on_nil) == true` and `value == nil`, `put()` will return `true` (because it deleted the key).
+
 **You can retreive the value later, if it hasn't expired, with:**
 
     my_var = Sir.get(keyname)
 
 or
 
-	# put() returns the object you give it
-	my_var = Sir.get(keyname) do 
-		Sir.put(keyname, User.find_by_id(id))
-	end
+    # A convenient way to rectify a cache miss!
+    # put() returns the object you give it
+    my_var = Sir.get(keyname) do 
+        Sir.put(keyname, User.find_by_id(id))
+    end
 
 If the key does not exist, or if it has expired:
 * `get()` returns `nil` if not given a block to execute.
 * `get()` yields to code block, if one is supplied.
 
+**To delete a cache entry, you can:**
+
+	Sir.delete(key)
+
 **If you want to clear the cache, you can:**
 
     Sir.clear
@@ -61,6 +68,7 @@ If the key does not exist, or if it has expired:
         config[:mode]           = :ram_cache # cache storage mode. Currently only :ram_cache is supported. Others may be added at a later date.
         config[:debug]          = true|false # show some debug messages
         config[:annoy]          = true|false # show even more debug messages
+		config[:delete_on_nil]  = true|false # auto-deletes stale cache entries on if value == nil
     end
     
 *Note: Config keynames are always `.downcase.to_sym`!*

data/lib/sir_cachealot.rb

@@ -11,6 +11,7 @@ module Sir
     debug:          false,
     annoy:          false, #super annoying debug messages
     default_expiry: 3600, #Integer(1.hour),
+    delete_on_nil:  true
 
   }
 
@@ -62,7 +63,7 @@ module Sir
 
       if x = @@ram_cache[key]
 
-        if x[:expiry] > Time.now
+        if x[:expiry].nil? || x[:expiry] > Time.now
           return x[:value]
         else
           # cache entry is stale
@@ -89,10 +90,25 @@ module Sir
     end
 
   end
+  
+  # deletes the specified key from the cache.
+  # returns true if successful, false if not found
+  def self.delete(key)
+    
+    case config(:mode)
+    when RAM
+      if @@ram_cache.has_key?(key)
+        @@ram_cache.delete(key)
+        return true
+      end
+    end
+    
+  end
 
   # Puts value in cache, key is param key
   # Param expiry is optional, it can be a relative or absolute Fixnum or Time object
-  # Returns expiry time in absolute form (e.g. 3:56pm instead of 3 hours from now)
+  # Returns the value you put into it, unless config(:delete_on_nil) == true and value == nil.
+  # Returns true (because it deleted the key) if config(:delete_on_nil) == true and value == nil.
   def self.put(key, value, expiry = config(:default_expiry))
 
     case expiry.class.name
@@ -100,28 +116,35 @@ module Sir
       true
     when "Time"
       expiry = Integer(expiry)
+    when "NilClass"
+      true
     else
       raise ArgumentError, "Expiry must be a Fixnum or Time object"
     end
 
 
-    unless (expiry > Integer(Time.now))
+    unless (!expiry.nil? && expiry > Integer(Time.now))
       expiry = Time.now + expiry
     end
 
     puts "          SirCachealot: Will expire <#{key}> at #{expiry}" if config(:annoy) == true
 
-    case config(:mode)
-    when RAM
+    if config(:delete_on_nil) == true && value == nil
+        self.delete(key)
+    else
+      case config(:mode)
+      when RAM
 
-      @@ram_cache[key]          ||= { }
-      @@ram_cache[key][:value]  = value
-      @@ram_cache[key][:expiry] = expiry
-      return value
+        @@ram_cache[key]          ||= { }
+        @@ram_cache[key][:value]  = value
+        @@ram_cache[key][:expiry] = expiry
+        return value
 
-    else
-      puke
+      else
+        puke
+      end      
     end
+    
 
 
   end
@@ -174,7 +197,7 @@ module Sir
 
     when RAM
       @@ram_cache.each_key do |k|
-        if @@ram_cache[k][:expiry] < Time.now
+        if !@@ram_cache[k][:expiry].nil? && @@ram_cache[k][:expiry] < Time.now
           puts("          SirCachealot: Cleaned #{k}") if config(:debug)
           @@ram_cache.delete(k)
         end

data/lib/sir_cachealot/version.rb

@@ -1,3 +1,3 @@
 module SirCachealot
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/sir_cachealot_spec.rb

@@ -56,15 +56,29 @@ describe SirCachealot do
     Sir.clean
 
     Sir.size?.should == 0
-
-
+    
   end
 
   it 'should dump() correctly' do
     Sir.put(:dump, TEST)
     Sir.dump
   end
-
-
+  
+  it 'should accept a nil-expiry key' do
+    Sir.put(:test_nil, TEST).should == TEST
+  end
+  
+  it 'should not expire a nil-expiry key' do
+    Sir.get(:test_nil).should == TEST
+  end
+  
+  it 'should auto-delete a key when fed a nil' do
+    Sir.put(:test_nil, nil).should == true
+  end
+  
+  it 'should delete a key if specified' do
+    Sir.put(:delete_me, TEST)
+    Sir.delete(:delete_me).should == true
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sir_cachealot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec