elephant-cache 1.0.0 → 1.0.1

data/README.rdoc

@@ -23,7 +23,7 @@ Example:
    attr_reader :x, :y
 
    def magnitude
-     return cache(__method__) do
+     return cache_value(__method__) do
        Math.sqrt(self.x**2 + self.y**2)
      end
    end
@@ -60,4 +60,7 @@ or directly via e-mail at:
 mailto:jeff@paploo.net
 
 = Version History
+[1.0.1 - 2011-Sep-01] Added timing.
+                      * (FEATURE) Added the ability to turn on cache calculation timing output.
+                      * (FIX) Some documentation referred to +cache_value+ as +cache+.
 [1.0.0 - 2011-Aug-28] Initial release.

data/lib/elephant.rb

@@ -1 +1,28 @@
 require File.join(File.dirname(__FILE__), 'elephant', 'cache')
+
+module Elephant
+
+  @@time = false
+  @@time_io = STDOUT
+
+  # Used by the caches to determine if they should report the time they took to process.
+  def self.time?
+    return @@time ? true : false
+  end
+
+  # If set to true, the caches will report the time to process when they process.
+  def self.time=(flag)
+    @@time = flag ? true : false
+  end
+
+  # Returns the IO object that timing will puts to.
+  def self.time_io
+    return @@time_io
+  end
+
+  # Sets the IO object that timing will puts to.
+  def self.time_io=(time_io)
+    @@time_io = time_io
+  end
+
+end

data/lib/elephant/cache.rb

@@ -33,7 +33,14 @@ module Elephant
     #  end
     def cache_value(key)
       unless(@elephant_cache.include?(key))
+        start_at = Time.now
         @elephant_cache[key] = yield if block_given?
+        stop_at = Time.now
+        delta_t = stop_at - start_at
+        if( Elephant.time? )
+          label = "#{self.class.name} - #{key}"
+          Elephant.time_io.puts " -- #{label.to_s.rjust(32)}: #{('%0.3f' % (delta_t*1000.0)).rjust(9)} ms (#{caller[0]})"
+        end
       end
       return @elephant_cache[key]
     end

metadata

@@ -2,7 +2,7 @@
 name: elephant-cache
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jeff Reinecke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 Z
+date: 2011-09-02 00:00:00 Z
 dependencies: []
 
 description: "    A simple object caching design pattern in a reusable module.\n"