bulk_cache_fetcher 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2012f42799511be205c0a27036b7a447dbf56b3
-  data.tar.gz: 54172b0aea06cbec9d7549bbe9963bb5ebcb7bea
+  metadata.gz: 164f9631e7c60c573ea490d677851e3ae2c1994a
+  data.tar.gz: a27506b07291839747eff96c8b6098c12eac5d8c
 SHA512:
-  metadata.gz: ea8c5960bc5df03785da93819ba29fae48390ccdcc5c6fae2fb25bb67b8e0052229e38e67eb3be8444a508c05c2573648ac22531f9aa5bcf9034087418d26102
-  data.tar.gz: 5142b31a0a0c5e8fab81ef56acabf45c35e44beade392b077950763e4abdff93ae521efcd070d39c7a36fd5727d5d95341629f8411c26623b9d784d185d3fc72
+  metadata.gz: e24adcc2d3df76a46634720f77cbcf9d22fa5e66120a996bd42999ec7dfd3375649d7d17be8d28b1b4b17dbae300a44890cfb50e19a8d3b6fa144b56695b97b2
+  data.tar.gz: 84a0977c2db53ad7dec3d13fc446094f775faff28e6c8191d51cbdd3cc63d2d023d87118dd34dd2e7a5653f48abb9f6b57baddb1ca347926c8188444d85a034a

data/README.md

@@ -14,6 +14,23 @@ Bulk Cache Fetcher allows you to query the cache for a list of
 objects, and gives you the opportunity to fetch all of the cache
 misses at once, using whatever `:include`s you want.
 
+For example, if you have a list of objects by id to fetch, and a list
+of keys you want them to be cached under, you'd use Bulk Cache Fetcher
+like this:
+
+```ruby
+identifiers = {:cache_key_1 => 1, :cache_key_2 => 2, :cache_key_3 => 3}
+BulkCacheFetcher.new(Rails.cache).fetch(identifiers) do |uncached_keys_and_ids|
+  ids = uncached_keys_and_ids.values
+  BlogPost.where(:id => ids).includes([:author, :comments])
+end
+```
+
+This will include and cache each `BlogPost`, with comments and
+authors, as if you did the `.where.includes` without caching. If a
+`BlogPost` is cached already, it won't fetch it (or its includes) from
+the database.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/bulk_cache_fetcher.rb

@@ -5,7 +5,7 @@
 # Rails' nested caching while avoiding the n+1 queries problem in the
 # uncached case.
 class BulkCacheFetcher
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 
   # Creates a new bulk cache fetcher, backed by +cache+. Cache must
   # respond to the standard Rails cache API, described on
@@ -28,41 +28,38 @@ class BulkCacheFetcher
   # objects, so you can use it for things like setting cache
   # expiration.
   def fetch(object_identifiers, options = {}, &finder_block)
-    cached_objects, uncached_identifiers = partition(object_identifiers)
-    coalesce(cached_objects, find(uncached_identifiers, options, &finder_block))
+    object_identifiers = normalize(object_identifiers)
+    cached_keys_with_objects, uncached_identifiers = partition(object_identifiers)
+    found_objects = find(uncached_identifiers, options, &finder_block)
+    coalesce(cache_keys(object_identifiers), cached_keys_with_objects, found_objects)
   end
 
   private
 
-  # Partitions a list of identifiers into two lists. The first list
-  # contains all of the objects we were able to serve from the cache,
-  # while the second is a list of all of the identifiers for objects
-  # that weren't cached.
+  # Splits a list of identifiers into two objects. The first is a hash
+  # of <tt>{cache_key: object}</tt> for all the objects we were able to serve
+  # from the cache. The second is a list of all of the identifiers for
+  # objects that weren't cached.
   def partition(object_identifiers)
-    object_identifiers = normalize(object_identifiers)
-    cached_objects = []
     uncached_identifiers = object_identifiers.dup
 
     cache_keys = cache_keys(object_identifiers)
-    found_objects = @cache.read_multi(*cache_keys)
+    cached_keys_with_objects = @cache.read_multi(*cache_keys)
 
     cache_keys.each do |cache_key|
-      cached_object = found_objects[cache_key]
-      uncached_identifiers.delete(cache_key) if cached_object
-      cached_objects << cached_object
+      uncached_identifiers.delete(cache_key) if cached_keys_with_objects.has_key?(cache_key)
     end
 
-    [cached_objects, uncached_identifiers]
+    [cached_keys_with_objects, uncached_identifiers]
   end
 
   # Finds all of the objects identified by +identifiers+, using the
   # +finder_block+. Will pass +options+ on to the cache.
   def find(identifiers, options = {}, &finder_block)
-    unless identifiers.empty?
-      Array(finder_block.(identifiers)).tap do |objects|
-        verify_equal_key_and_value_counts!(identifiers, objects)
-        cache_all(identifiers, objects, options)
-      end
+    return [] if identifiers.empty?
+    Array(finder_block.call(identifiers)).tap do |objects|
+      verify_equal_key_and_value_counts!(identifiers, objects)
+      cache_all(identifiers, objects, options)
     end
   end
 
@@ -78,11 +75,12 @@ class BulkCacheFetcher
     keys.zip(values) { |k, v| @cache.write(cache_key(k), v, options) }
   end
 
-  # With an array looking like <tt>[nil, 1, nil, 2]</tt>, replaces the
-  # nils with values taken from +found_objects+, in order.
-  def coalesce(array_with_nils, found_objects)
+  # Given a list of +cache_keys+, either find associated objects from
+  # +cached_keys_with_objects, or grab them from +found_objects+, in
+  # order.
+  def coalesce(cache_keys, cached_keys_with_objects, found_objects)
     found_objects = Array(found_objects)
-    array_with_nils.map { |obj| obj ? obj : found_objects.shift }
+    cache_keys.map { |key| cached_keys_with_objects.fetch(key) { found_objects.shift } }
   end
 
   # Returns the part of the identifier that we can use as the cache

data/test/bulk_cache_fetcher_test.rb

@@ -13,14 +13,14 @@ class InMemoryCache
   def read_multi(*keys)
     results = {}
     keys.each do |key|
-      results[key] = read(key) if read(key)
+      results[key] = read(key) if cache.has_key?(key)
     end
     results
   end
 
 end
 
-class BulkCacheFetcherTest < Minitest::Unit::TestCase
+class BulkCacheFetcherTest < Minitest::Test
 
   def setup
     @cache = InMemoryCache.new
@@ -126,4 +126,13 @@ class BulkCacheFetcherTest < Minitest::Unit::TestCase
     end
     assert_equal(2, @cache.read(:one))
   end
+
+  def test_doesnt_break_if_nils_are_cached
+    @cache.write(:two, nil)
+    results = @cache_fetcher.fetch([:one, :two, :three]) do |keys|
+      [1, 3]
+    end
+    assert_equal(nil, results[1])
+    assert_equal(3, results[2])
+  end
 end

data/test/test_helper.rb

@@ -1,2 +1 @@
-require 'minitest/unit'
 require 'minitest/autorun'

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: bulk_cache_fetcher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Weiss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Fetches cache misses in bulk
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -79,17 +79,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Bulk Cache Fetcher allows you to query the cache for a list of objects, and