fat_cache 0.0.3 → 0.0.4

data/README.md

@@ -4,14 +4,13 @@ fat_cache
 Data migration got you down? RAM to spare? Let `fat_cache` do the work for you.
 `fat_cache` wastes resources for the sake of speed, intentionally!
 
-Use Case
-========
+Case Study / Motivation
+-----------------------
 
 Say you are importing bank accounts associated with your users from an old
 system, maybe 10,000 of them.
 
-Naive Implementation
---------------------
+### Naive Implementation
 
 You might write code that looks something like this:
 
@@ -27,8 +26,7 @@ You might write code that looks something like this:
 
 But this is slow, two queries for each of your 10,000 accounts.
 
-Refactor One: Fat Query
------------------------
+### Refactor One: Fat Query
 
 You can attack the speed problem by loading all your users into memory first.
 You pay for a fat query up front, but you get a speed boost afterwards.
@@ -45,8 +43,7 @@ You pay for a fat query up front, but you get a speed boost afterwards.
 But now instead of spending all your time in the network stack doing queries,
 you're spinning the CPU doing a linear search through the `all_users` array.
 
-Refactor Two: Indexed Hash
---------------------------
+### Refactor Two: Indexed Hash
 
 A similar "pay up front, gain later" strategy can be used on the in-memory data
 structure by indexing it on the key that we will be searching on. 
@@ -67,8 +64,7 @@ structure by indexing it on the key that we will be searching on.
 
 Now finding a user for an account is constant time lookup in the hash.
 
-FatCache makes this strategy simpler
-------------------------------------
+### FatCache makes this strategy simpler
 
 FatCache is a simple abstraction and encapsulation of the strategies used in
 each refactor.  Here is how the code looks:
@@ -84,3 +80,8 @@ each refactor.  Here is how the code looks:
 And in fact, the call to `index` is optional, since `lookup` will create the
 index the first time you call it if one doesn't exist, and you're still only
 paying O(N) once. 
+
+How to use
+----------
+
+TODO: basic howto, until then look at the specs!

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/fat_cache/shortcuts.rb

@@ -0,0 +1,17 @@
+class FatCache
+  module Shortcuts
+    def self.included(base)
+      base.extend ClassMethods 
+    end
+
+    module ClassMethods
+      def cache
+        FatCache
+      end
+    end
+
+    def cache
+      FatCache
+    end
+  end
+end

data/spec/fat_cache_shortcuts_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FatCache::Shortcuts do
+
+  describe 'when included in a class' do
+    before do
+      @manatee_class = Class.new
+      @manatee_class.send(:include, FatCache::Shortcuts)
+    end
+
+    it 'provides a `cache`  method at the class level' do
+      @manatee_class.should respond_to(:cache)
+    end
+
+    it 'provides a `cache`  method at the instance level' do
+      @manatee_class.new.should respond_to(:cache)
+    end
+
+    describe 'the class level `cache` method' do
+      it 'yields the FatCache class' do
+        @manatee_class.cache
+      end
+    end
+
+    describe 'the instance level `cache` method' do
+      it 'yields the FatCache class' do
+        @manatee_class.new.cache
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'fat_cache'
+require 'fat_cache/shortcuts'
 require 'spec'
 require 'spec/autorun'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fat_cache
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - phinze
@@ -49,6 +49,8 @@ files:
 - Rakefile
 - VERSION
 - lib/fat_cache.rb
+- lib/fat_cache/shortcuts.rb
+- spec/fat_cache_shortcuts_spec.rb
 - spec/fat_cache_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -82,4 +84,5 @@ specification_version: 3
 summary: A dead simple pure-ruby caching framework for large datasets.
 test_files: 
 - spec/fat_cache_spec.rb
+- spec/fat_cache_shortcuts_spec.rb
 - spec/spec_helper.rb