fat_cache 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/fat_cache.rb

@@ -45,7 +45,7 @@ class FatCache
       return indexed_fatcache[key][by][using]
     end
 
-    def index(key, on)
+    def index(key, on, &block)
       # must have cache data to work with
       ensure_cached(key)
 
@@ -56,10 +56,21 @@ class FatCache
       indexed_fatcache[key] = {} unless indexed_fatcache.has_key?(key)
 
       raw_data = get(key)
-      
-      # calls each method specified in the `on` array once on each element in
-      # the raw dataset, and uses the results of those calls to key this index
-      indexed_fatcache[key][on] = raw_data.group_by { |x| on.map { |b| x.send(b) } }
+
+      if block
+        # make the cache available to the passed block, and ensure that
+        # the returned value is wrapped in an array (to keep these keys in line
+        # with the method sending strategy
+        wrapped_block = lambda { |item| [*block.call(self, item)] }
+
+        # pass each element of the raw data set into the block, which will
+        # compute the key for us
+        indexed_fatcache[key][on] = raw_data.group_by(&wrapped_block)
+      else
+        # call each method specified in the `on` array once on each element in
+        # the raw dataset, and use the results of those calls to key this index
+        indexed_fatcache[key][on] = raw_data.group_by { |x| on.map { |b| x.send(b) } }
+      end
     end
 
     def get_index(key, on)

data/spec/fat_cache_spec.rb

@@ -83,7 +83,7 @@ describe FatCache do
     end
   end
 
-  describe 'index(key, on)' do
+  describe 'index(key, on) { optional_block }' do
     it 'raises an error if there is no raw data to index for specified key' do
       lambda {
         FatCache.index(:wishbone, :whats_the_story?)
@@ -99,19 +99,45 @@ describe FatCache do
     
     describe 'given a dataset which responds to methods' do
       before do
-        fruit = [
+        @fruit = [
           stub(:mango,  :grams_of_awesome => 3),
           stub(:banana, :grams_of_awesome => 10),
           stub(:apple,  :grams_of_awesome => 3)
         ]
-        FatCache.store(:fruit, fruit)
+        FatCache.store(:fruit, @fruit)
       end
+
       it 'calls each method specified in `on` array and uses the results as the index key' do
         FatCache.index(:fruit, [:grams_of_awesome])
         index = FatCache.get_index(:fruit, :grams_of_awesome)
         index.keys.should =~ [[3],[10]]
       end
+
+      describe 'when the optional block is specified' do
+        it 'does not send the symbols specified for `on` to the dataset members' do
+          FatCache.get(:fruit).each { |f| f.should_not_receive(:grams_of_awesome) }
+          FatCache.index(:fruit, :grams_of_awesome) { :dont_care }
+        end
+        
+        it 'indexes the dataset based on the return value of the block' do
+          FatCache.index(:fruit, :grams_of_awesome) { :so_many }
+          results = FatCache.lookup(:fruit, :by => :grams_of_awesome, :using => :so_many)
+          results.should =~ @fruit
+        end
+
+        it 'passes itself into the block as the first argument' do
+          FatCache.index(:fruit, :grams_of_awesome) { |cache, _| 
+            cache.should == FatCache
+          }
+        end
+
+        it 'passes each item into the block as the second argument' do
+          FatCache.get(:fruit).each { |f| f.should_receive(:seen) }
+          FatCache.index(:fruit, :grams_of_awesome) { |_, item| item.seen }
+        end
+      end
     end
+
   end
 
   describe 'invalidate(key)' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fat_cache
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - phinze
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-02 00:00:00 -06:00
+date: 2010-03-03 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency