cache-object 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1353358a8c97cf8dae4728bb24db9b369507b7ce
-  data.tar.gz: 990bdcf05d78a4108349e951968f2000d036237c
+  metadata.gz: e8ed3e3acf8e4c9fe23e4a3d0f73b067e1570318
+  data.tar.gz: d7f3afcb8be6c0d3065c97e7a1e7f027c25621bf
 SHA512:
-  metadata.gz: 990c15962eb6c8584c1be9472e568de3907c55cfe62f378312b4aba26b3558aaa04abfcc3b4ad7a263c18466974389772478849324ad42307b986935d974f9a2
-  data.tar.gz: 4f987b2214a753daab449ff3572eaee7f61942ceeced694f7c7142d09c4cf868937c78ef3b055bd3c36ab5c990b251348dff26a1f905d0b8434e4005894724d7
+  metadata.gz: b77a6a97aa5e46e6d9d01e16f97fd1e9f724c7029fc21c230ffc622f7bb9b67545cb81407b7010063329f5a3f9b881d949aafc3f1aebdcb3b00ef867097fbdb1
+  data.tar.gz: a0418a92720e49b01648b7bc6730f6d56070d8919c5845e8e32292de0d51197405521053952382d5ccde59e7925382f1a75ef45decde9e96fc4736ba14a58fa0

data/cache-object.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "sqlite3"

data/lib/cache/object.rb

@@ -3,6 +3,7 @@ require 'cache/object/config'
 require 'cache/object/active_record'
 require 'cache/object/adapter'
 require 'cache/object/key_generator'
+require 'cache/object/multi_get'
 
 module Cache
   module Object

data/lib/cache/object/active_record.rb

@@ -22,10 +22,6 @@ module Cache
       end
 
       def load_from_cache(attributes)
-        attributes.each_pair do |key, value|
-          attributes[key] = value
-        end
-
         @attributes = self.class.initialize_attributes(attributes)
         @relation = nil
 
@@ -55,7 +51,6 @@ module Cache
       module ClassMethods
         def _load(args)
           attributes = Marshal.load(args)
-
           object = allocate
           object.load_from_cache(attributes)
           object
@@ -73,6 +68,10 @@ module Cache
           end
         end
 
+        def fetch_all(ids)
+          Cache::Object::MultiGet.new(self).fetch_all(ids)
+        end
+
         def object_cache_on(*attrs)
           self._object_cache_attr_mappings << attrs
           define_singleton_method("find_by_#{attrs.join('_and_')}") do |*args|

data/lib/cache/object/adapter.rb

@@ -4,7 +4,7 @@ module Cache
       attr_reader :store
 
       def initialize(store)
-        raise "Cache Store is nil" unless store
+        raise "Cache Store is nil, please initialize" unless store
         @store = store
       end
 
@@ -32,6 +32,10 @@ module Cache
                     &block)
       end
 
+      def read_multi(args)
+        store.read_multi(*args)
+      end
+
       private
 
       def ttl

data/lib/cache/object/config.rb

@@ -6,6 +6,8 @@ module Cache
       def initialize
         self.enabled = true
         self.ttl = 86400
+        self.adapter = nil
+        self.cache = nil
       end
 
       def adapter

data/lib/cache/object/instance_decorator.rb

@@ -9,9 +9,8 @@ module Cache
 
       def mapping_cache_keys
         mappings.map do |mapping|
-          attributes = mapping.inject({}) do |memo, attr|
-            memo[attr] = instance.send(attr)
-            memo
+          attributes = {}.tap do |obj|
+            mapping.each { |attr| obj[attr] = instance.send(attr) }
           end
           KeyGenerator.key_for_mapping(instance.class.name, attributes)
         end

data/lib/cache/object/multi_get.rb

@@ -0,0 +1,36 @@
+module Cache
+  module Object
+    class MultiGet
+      attr_reader :clazz
+
+      def initialize(clazz)
+        @clazz = clazz
+      end
+
+      def fetch_all(ids)
+        objs = cached_objects(ids)
+        remaining = missed_ids(ids, objs)
+        return objs if remaining.empty?
+        objs + load_from_db(remaining)
+      end
+
+      def load_from_db(ids)
+        primary_key = clazz.primary_key.to_sym
+        clazz.where(primary_key => ids).to_a.each(&:write_cache!)
+      end
+
+      def object_keys(ids)
+        ids.map { |id| Cache::Object::KeyGenerator.key_for_object(clazz.name, id) }
+      end
+
+      def cached_objects(ids)
+        keys = object_keys(ids)
+        Cache::Object.adapter.read_multi(keys).values
+      end
+
+      def missed_ids(ids, fetched_objects)
+        ids - fetched_objects.map(&:id)
+      end
+    end
+  end
+end

data/lib/cache/object/version.rb

@@ -1,5 +1,5 @@
 module Cache
   module Object
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/cache/object/active_record_spec.rb

@@ -58,7 +58,6 @@ RSpec.describe Cache::Object::ActiveRecord do
     end
   end
 
-
   describe "caching methods" do
     describe "#write_cache" do
       it "calls write cache" do
@@ -68,7 +67,6 @@ RSpec.describe Cache::Object::ActiveRecord do
       end
     end
 
-
     describe "#expire_cache" do
       it "calls write cache" do
         expect(adapter_instance).to receive(:delete).with(an_instance_of(Cache::Object::InstanceDecorator))
@@ -108,6 +106,15 @@ RSpec.describe Cache::Object::ActiveRecord do
       end
     end
 
+    describe ".fetch_all" do
+      it "should call through to multi_get" do
+        multi_getter = double(fetch_all: true)
+        expect(Cache::Object::MultiGet).to receive(:new).with(clazz) { multi_getter }
+        expect(multi_getter).to receive(:fetch_all).with([1,2,4])
+        clazz.fetch_all([1, 2, 4])
+      end
+    end
+
     describe "object_cache_on" do
 
       it "creates_finder_methods" do

data/spec/cache/object/multi_get_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe Cache::Object::MultiGet do
+
+  let(:fake_clazz) { double(name: "MyObj", primary_key: :foo) }
+  let(:obj_arr) { 1.upto(3).map { |i| double(class: fake_clazz, id: i) } }
+  let(:multi_get) { Cache::Object::MultiGet.new(fake_clazz) }
+  let(:cache_store) { double("CacheStore", write: true) }
+  let(:adapter) { Cache::Object::Adapter.new(cache_store) }
+
+  describe "#object_keys" do
+    it "maps keys correctly" do
+      expect(multi_get.object_keys(1..3)).to eq(["MyObj-1", "MyObj-2", "MyObj-3"])
+    end
+  end
+
+  describe "#cached_objects" do
+    it "fetches all the mapped keys" do
+      expect(Cache::Object).to receive(:adapter) { adapter }
+      expect(adapter).to receive(:read_multi).with(["MyObj-1", "MyObj-2", "MyObj-3"]) { double(values: true) }
+      multi_get.cached_objects(1..3)
+    end
+  end
+
+  describe "#missed_ids" do
+    let(:initial_ids) { [1, 2, 3, 4, 5, 6] }
+    it "computes missed ids" do
+      expect(multi_get.missed_ids(initial_ids, obj_arr)).to eq([4, 5, 6])
+    end
+  end
+
+  describe "#load_remaining" do
+    it "performs missed queries" do
+      expect(fake_clazz).to receive(:where).with(:foo => [1, 2, 3]).once { [double(write_cache!: true)] }
+      multi_get.load_from_db([1, 2, 3])
+    end
+  end
+
+  describe "#fetch_all" do
+    describe "with all expected ids" do
+      it "never calls through to db" do
+        expect(multi_get).to receive(:cached_objects).with([1, 2, 3]) {  obj_arr }
+        expect(multi_get).to receive(:load_from_db).never
+        multi_get.fetch_all([1, 2, 3])
+      end
+    end
+
+    describe "with a cache miss" do
+      it "calls through to db" do
+        expect(multi_get).to receive(:cached_objects).with([1, 2, 3]) { [ obj_arr[0] ]}
+        expect(multi_get).to receive(:load_from_db).with([2, 3]) { [obj_arr[1], obj_arr[2]] }
+        expect(multi_get.fetch_all([1, 2, 3])).to have(3).items
+      end
+    end
+  end
+
+end

data/spec/features/cache_object_spec.rb

@@ -7,13 +7,15 @@ RSpec.describe "Caching" do
 
   before do
     CreateModelsForTest.migrate(:up)
+    cache = ::ActiveSupport::Cache::MemoryStore.new
     Cache::Object.configure do |c|
-      c.cache = ::ActiveSupport::Cache::MemoryStore.new
+      c.cache = cache
     end
   end
 
   after do
     CreateModelsForTest.migrate(:down)
+    Cache::Object.instance_variable_set(:@configuration, nil)
   end
 
   let!(:user) { User.create(age: 13, name: "Bob") }
@@ -52,6 +54,30 @@ RSpec.describe "Caching" do
     end
   end
 
+  describe "#fetch_all" do
+    let!(:u1) { 1.upto(3).map { |i| User.create(age: 13, name: "name#{i}") } }
+    it "Should call db once for all in one read" do
+
+      expect {
+        User.fetch_all(u1.map(&:id))
+      }.to change { ActiveRecord::QueryCounter.query_count }.by(0)
+    end
+
+    it "Should call the db again after cache flush" do
+      Cache::Object.configuration.cache.clear
+
+      expect {
+        User.fetch_all(u1.map(&:id))
+      }.to change { ActiveRecord::QueryCounter.query_count }.by(1)
+
+      # Should hit cache
+      expect {
+        User.fetch_all(u1.map(&:id))
+      }.to change { ActiveRecord::QueryCounter.query_count }.by(0)
+    end
+  end
+
+
   describe "when user id destroyed" do
     it "tries to run a query" do
       user.destroy
@@ -74,4 +100,6 @@ RSpec.describe "Caching" do
       }.to change { ActiveRecord::QueryCounter.query_count }.by(1)
     end
   end
+
+
 end

data/spec/spec_helper.rb

@@ -1,15 +1,17 @@
 require 'cache/object'
+require 'rspec/collection_matchers'
 RSpec.configure do |config|
 
-  config.before do
+  config.before(:each) do
     Cache::Object.instance_variable_set(:@configuration, nil)
+    Cache::Object.instance_variable_set(:@adapter, nil)
   end
 
-  config.after do
+  config.after(:each) do
     Cache::Object.instance_variable_set(:@configuration, nil)
+    Cache::Object.instance_variable_set(:@adapter, nil)
   end
 
   config.raise_errors_for_deprecations!
   config.disable_monkey_patching!
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache-object
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matt Camuto
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -139,11 +153,13 @@ files:
 - lib/cache/object/config.rb
 - lib/cache/object/instance_decorator.rb
 - lib/cache/object/key_generator.rb
+- lib/cache/object/multi_get.rb
 - lib/cache/object/version.rb
 - spec/cache/object/active_record_spec.rb
 - spec/cache/object/adapter_spec.rb
 - spec/cache/object/config_spec.rb
 - spec/cache/object/instance_decorator_spec.rb
+- spec/cache/object/multi_get_spec.rb
 - spec/features/cache_object_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
@@ -176,6 +192,7 @@ test_files:
 - spec/cache/object/adapter_spec.rb
 - spec/cache/object/config_spec.rb
 - spec/cache/object/instance_decorator_spec.rb
+- spec/cache/object/multi_get_spec.rb
 - spec/features/cache_object_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb