fat_cache 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 phinze
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+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
+========
+
+Say you are importing bank accounts associated with your users from an old
+system, maybe 10,000 of them.
+
+Naive Implementation
+--------------------
+
+You might write code that looks something like this:
+
+    old_accounts = legacy_db.select_all("select * from old_accounts")
+
+    old_accounts.each do |account_data|
+      user = User.find_by_user_number(account_data['user_number'], :include => :accounts)
+      next if user.accounts.find { |account| account.number == account_data['account_number'] }
+      # Save imported account
+      acct = Account.new(account_data)
+      acct.save!
+    end
+
+But this is slow, two queries for each of your 10,000 accounts.
+
+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.
+
+    old_accounts = legacy_db.select_all("select * from old_accounts")
+
+    all_users = Users.all(:include => :accounts)
+
+    old_accounts.each do |account_data|
+      user = all_users.find { |user| user.user_number == account_data['user_number'] }
+      # ... (same as above) ...
+    end
+
+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
+--------------------------
+
+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. 
+
+
+    old_accounts = legacy_db.select_all("select * from old_accounts")
+    all_users = Users.all(:include => :accounts)
+
+    all_users_indexed_by_user_number = all_users.inject({}) do |hash, user|
+                                        hash[user.user_number] = user
+                                        hash
+                                      end
+
+    old_accounts.each do |account_data|
+      user = all_user_by_user_number[account_data['user_number']]
+      # ... (same as above) ...
+    end
+
+Now finding a user for an account is constant time lookup in the hash.
+
+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:
+
+    FatCache.store(:users) { Users.all(:include => :accounts) }
+    FatCache.index(:users, :user_number)
+
+    old_accounts.each do |account_data|
+      user = FatCache.lookup :users, :by => :user_number, :using => account_data['user_number']
+      # ... (same as above) ...
+    end
+
+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. 

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fat_cache"
+    gem.summary = %Q{A dead simple pure-ruby caching framework for large datasets.}
+    gem.description = %Q{A dead simple pure-ruby caching framework for large datasets.}
+    gem.email = "paul.t.hinze@gmail.com"
+    gem.homepage = "http://github.com/phinze/fat_cache"
+    gem.authors = ["phinze"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/fat_cache.rb

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'ruby-debug'
+class FatCache
+
+  class << self
+    @initted = false
+    attr_accessor :fetchers, :fatcache, :indexed_fatcache
+
+    def store(*key_and_maybe_data, &fetcher)
+      init unless initted? # for first time store
+
+      if key_and_maybe_data.length == 2 && fetcher.nil?
+        key, data = key_and_maybe_data
+        fatcache[key] = data
+      elsif key_and_maybe_data.length == 1 && fetcher
+        key = key_and_maybe_data.first
+        fetchers[key] = fetcher
+        fatcache[key] = fetcher.call
+      else
+        argstr   = "#{key_and_maybe_data.length} arguments"
+        blockstr = (block_given?) ? 'a block' : 'no block'
+        raise "Got #{argstr} and #{blockstr}, expected (key, data) or (key) { fetcher block }"
+      end
+    end
+
+    def get(key)
+      unless cached?(key)
+        if fetchable?(key)
+          fatcache[key] = fetchers[key].call
+        else
+          raise "no data for #{key}" 
+        end
+      end
+      fatcache[key]
+    end
+
+    def lookup(key, options={})
+      options = options.dup
+      by      = [*options.delete(:by)]
+      using   = [*options.delete(:using)]
+      
+      # create index if it doesn't exist
+      index(key, by) unless indexed?(key, by)
+     
+      return indexed_fatcache[key][by][using]
+    end
+
+    def index(key, on)
+      # must have cache data to work with
+      ensure_cached(key)
+
+      # ensure we're dealing with an array, we're such a friendly API!
+      on = [*on]
+
+      # init hash if we've never indexed for this key before
+      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) } }
+    end
+
+    def get_index(key, on)
+      on = [*on]
+
+      ensure_indexed(key, on)
+
+      indexed_fatcache[key][on]
+    end
+
+    def ensure_cached(key)
+      raise "no data for #{key}" unless cached?(key)
+    end
+
+    def ensure_indexed(key, on)
+      ensure_cached(key)
+      raise "no index for #{key} on #{on.inspect}" unless indexed?(key, on)
+    end
+
+    def cached?(key)
+      fatcache && fatcache.has_key?(key)
+    end
+
+    def indexed?(key, on)
+      indexed_fatcache                   && 
+      indexed_fatcache.has_key?(key)     &&
+      indexed_fatcache[key].has_key?(on)
+    end
+
+    def fetchable?(key)
+      fetchers && fetchers.has_key?(key)
+    end
+
+    def invalidate(key)
+      init unless initted? 
+      
+      fatcache.delete(key)
+    end
+
+    def reset!
+      self.fetchers         = nil
+      self.fatcache         = nil
+      self.indexed_fatcache = nil
+      @initted              = nil
+    end
+
+    protected
+
+    def init
+      self.fetchers         = {}
+      self.fatcache         = {}
+      self.indexed_fatcache = {}
+      @initted             = true
+    end
+
+    def initted?
+      @initted == true
+    end
+  
+  end
+end

data/spec/fat_cache_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FatCache do
+  # so we don't have leaky state
+  after  { FatCache.reset! }
+
+  describe 'get(key)' do
+    it 'raises an exception if no data is stored for this key' do
+      lambda { 
+        FatCache.get(:not_there) 
+      }.should raise_error(/not_there/)
+    end
+
+    describe 'when data has been invalidated for a key with a fetcher' do
+      it 'uses a fetcher to get new data' do
+        i = 0
+        FatCache.store(:increment) { i += 1 }
+        FatCache.invalidate(:increment)
+        FatCache.get(:increment).should == 2
+      end
+    end
+  end
+
+  describe 'store(key[, data])' do
+    describe 'when called with key and data arguments' do
+      it 'stores data for specified key' do
+        FatCache.store(:five_alive, 5)
+        FatCache.get(:five_alive).should == 5
+      end
+
+      it 'properly stores nil for key if explicitly specified' do
+        FatCache.store(:empty_inside, nil)
+        FatCache.get(:empty_inside).should be_nil
+      end
+    end
+
+    describe 'when called with key and fetcher block' do
+      it 'uses block as fetcher to retrieve data to store' do
+        FatCache.store(:fetched_from_block) { 'cheese sandwich' }
+        FatCache.get(:fetched_from_block).should == 'cheese sandwich'
+      end
+
+      it 'calls the block only once, caching the data returned' do
+        i = 0
+        FatCache.store(:increment) { i += 1 }
+
+        first_result = FatCache.get(:increment)
+        second_result = FatCache.get(:increment)
+
+        first_result.should == 1
+        second_result.should == 1
+      end
+    end
+  end
+
+  describe 'lookup(key, :by => [:method_names], :using => [:index_key])' do
+    it 'returns a records stored in the dataset specified by key, indexed by the specified methods, and with the following key to the index' do
+      FatCache.store(:a_set, [0,1,2,3,4,5])
+      result = FatCache.lookup(:a_set, :by => :odd?, :using => true)
+      result.should == [1,3,5]
+    end
+
+    it 'works with multi-element index keys' do
+      FatCache.store(:a_set, [0,1,2,3,4,5])
+      result = FatCache.lookup(:a_set, :by => [:even?, :zero?], :using => [true, true])
+      result.should == [0]
+    end
+  end
+
+  describe 'get_index(key, on)' do
+    it 'returns the given index for a key' do
+      FatCache.store(:numbers, [0,1,2,3,4])
+      FatCache.index(:numbers, :odd?)
+      FatCache.get_index(:numbers, :odd?).should be_a Hash
+    end
+
+    it 'raises an error if no index exists for on specified key' do
+      FatCache.store(:indexed_one_way, [123])
+      FatCache.index(:indexed_one_way, :zero?)
+      lambda {
+        FatCache.get_index(:indexed_one_way, :odd?)
+      }.should raise_error(/indexed_one_way.*odd?/)
+    end
+  end
+
+  describe 'index(key, on)' do
+    it 'raises an error if there is no raw data to index for specified key' do
+      lambda {
+        FatCache.index(:wishbone, :whats_the_story?)
+      }.should raise_error(/wishbone/)
+    end
+
+    it 'raises an error if the elements of the dataset do not respond to the index key methods' do
+      FatCache.store(:numbers, [1,2,3,4,5,6])
+      lambda {
+        FatCache.index(:numbers, :millionaire?)
+      }.should raise_error(/millionaire?/)
+    end
+    
+    describe 'given a dataset which responds to methods' do
+      before do
+        fruit = [
+          stub(:mango,  :grams_of_awesome => 3),
+          stub(:banana, :grams_of_awesome => 10),
+          stub(:apple,  :grams_of_awesome => 3)
+        ]
+        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
+    end
+  end
+
+  describe 'invalidate(key)' do
+    describe 'when no fetcher has been specified for key' do
+      it 'returns the last value the cache had for the key' do
+        FatCache.store(:once_upon_a_time, 33)  
+        retval = FatCache.invalidate(:once_upon_a_time)
+        retval.should == 33
+      end
+
+      it 'removes data stored for a given key' do
+        FatCache.store(:there_and_gone, 100)  
+        FatCache.invalidate(:there_and_gone)
+        lambda {
+          FatCache.get(:there_and_gone)
+        }.should raise_error(/there_and_gone/)
+      end
+    end
+
+    describe 'when a fetcher has been specified for a key' do
+      it 'does not clear out the fetcher, which can be used in the next lookup' do
+        FatCache.store(:fetch_me) { "I've been fetched" }
+        FatCache.invalidate(:fetch_me)
+        FatCache.get(:fetch_me).should == "I've been fetched" 
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fat_cache'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: fat_cache
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- phinze
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A dead simple pure-ruby caching framework for large datasets.
+email: paul.t.hinze@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/fat_cache.rb
+- spec/fat_cache_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/phinze/fat_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A dead simple pure-ruby caching framework for large datasets.
+test_files: 
+- spec/fat_cache_spec.rb
+- spec/spec_helper.rb