infopark_component_cache 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2561cd7d70ca3cf1f7b21a07bdb092456118933
-  data.tar.gz: 1b4c46f017f400aad1b7526ccbfacce200345dc2
+  metadata.gz: 97f5a401ded8bb31c5e7539f39bdb7686fbbbb69
+  data.tar.gz: 99d9b252e0e9b37b03c17aac61753a354d4d3b27
 SHA512:
-  metadata.gz: d1f5995924da3bad924c94b7cbe788d3e6e7008e6feddad7a47752c38cb5e9cf683b53e663afbbb3b59df6aebcde8a3f981b8e71ca36c78e1b1ba0ad71450124
-  data.tar.gz: ccb9eff5d683ba9c5a914a6964c7ff852facc6851a28c7ab56230e1278b82dd29768e6c1e573d74202ccc42dce4e52f1cd24facbb45c2786ef2806f6b0cf6a98
+  metadata.gz: f4b0472ea662483d07b9d21b45c2be93e056a7cb76bf09f2b7b56423b0a4d00b93469c6a6babecfc79b1d2485aa38356765fbe46222c93518f2d9eefd249b38b
+  data.tar.gz: 5b7b9f4e4d36c41e35b87ef8382d72ed7ecec73d39de1f7cb01155444131848d19d5093c3dd6d12adf34512139e9d02053748529d3f7a3da0c1ca74bb5e2158e

data/README.md

@@ -16,6 +16,14 @@ Or install it yourself as:
 
     $ gem install infopark_component_cache
 
+## Tests
+
+To run the test suite just execute:
+
+    $ bundle exec rspec spec/
+
+No setup neccessary.
+
 ## Usage
 
 Set up Rails catching (see [http://guides.rubyonrails.org/caching_with_rails.html](http://guides.rubyonrails.org/caching_with_rails.html)) and

data/infopark_component_cache.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'infopark_fiona_connector'
 
-  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'rspec-rails', '~> 3.5'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'byebug'
 end

data/lib/infopark_component_cache/component.rb

@@ -5,12 +5,16 @@ module InfoparkComponentCache
   # and some parameters (hash). It should be used to point
   # to some data stored in a particular context
   class Component
-    attr_reader :obj, :name, :params
+    attr_reader :obj, :component, :params
 
     def initialize(obj, component, params={})
       @obj, @component, @params = obj, component, params
     end
 
+    def name
+      self.component
+    end
+
     def cache_key(meta_prefix=nil)
       if meta_prefix
         meta_prefix + "_" + KeyGenerator.generate_key(identity_hash)
@@ -23,4 +27,4 @@ module InfoparkComponentCache
       @params.merge({:obj_name=>@obj.name, :obj_id=>@obj.id, :obj_component=>@component})
     end
   end
-end
+end

data/lib/infopark_component_cache/component_cache.rb

@@ -54,6 +54,7 @@ module InfoparkComponentCache
     #
     # @return true if cache is valid and in consistent state
     def expired?
+      return true if !cache.enabled?
       return !guards.all?(&:consistent?)
 
     rescue => exception
@@ -73,8 +74,10 @@ module InfoparkComponentCache
       if expired?
         value = yield
         begin
-          cache.write(component.cache_key, value)
-          ensure_consistency!
+          if cache.enabled?
+            cache.write(component.cache_key, value)
+            ensure_consistency!
+          end
           return value
 
         rescue => exception

data/lib/infopark_component_cache/version.rb

@@ -1,3 +1,3 @@
 module InfoparkComponentCache
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/dummy/config/environments/test.rb

@@ -1,2 +1,3 @@
 Dummy::Application.configure do
+  config.cache_store = :memory_store
 end

data/spec/lib/compontent_cache_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe InfoparkComponentCache::ComponentCache do
+  let(:obj)    { double(name: 'spec_obj', id: 2001) }
+  let(:name)   { 'spec_cached_component' }
+  let(:params) { {some: 'additional', params: 'supplied'} }
+  let(:guard)  { Class.new(Struct.new(:component)) }
+
+  subject      { described_class.new(obj, name, params, [guard]) }
+
+  context 'with caching disabled' do
+    before  { allow(Rails.application.config.action_controller).to receive(:perform_caching).and_return(false) }
+
+    describe '#fetch' do
+      let(:value) { 'very_hard_computation_required_for_this_string' }
+      let(:specific_guard) { subject.guards.first }
+
+      it 'returns the passed the block value' do
+        expect(subject.fetch { value }).to eq(value)
+      end
+
+      it 'never calls any methods on the guard' do
+        expect(specific_guard).not_to receive(:consistent?)
+        expect(specific_guard).not_to receive(:guard!)
+
+        subject.fetch { value }
+      end
+    end
+  end
+
+  context 'with caching enabled' do
+    before  { allow(Rails.application.config.action_controller).to receive(:perform_caching).and_return(true) }
+
+    let(:guard) { Class.new(InfoparkComponentCache::ConsistencyGuard) {
+      def consistent?
+        cache.exist?(:guard_called)
+      end
+
+      def guard!
+        cache.write(:guard_called, 1)
+      end
+    } }
+
+    describe '#fetch' do
+      let(:value) { 'very_hard_computation_required_for_this_string' }
+      let(:specific_guard) { subject.guards.first }
+      let(:computer) { double }
+
+      it 'returns the passed the block value' do
+        expect(subject.fetch { value }).to eq(value)
+      end
+
+      it 'calls the required methods on the guard' do
+        expect(specific_guard).to receive(:consistent?).exactly(3).times
+        expect(specific_guard).to receive(:guard!).exactly(3).times
+
+        3.times { subject.fetch { value } }
+      end
+
+      it 'only evalues the block once' do
+        expect(computer).to receive(:compute).and_return(value).once
+
+        3.times { expect(subject.fetch { computer.compute }).to eq(value) }
+      end
+    end
+  end
+
+  describe '#compontent' do
+    subject { described_class.new(obj, name, params).component }
+
+    it 'stores the passed obj' do
+      expect(subject.obj).to eq(obj)
+    end
+
+    it 'stores the passed name' do
+      expect(subject.name).to eq(name)
+    end
+
+    it 'stores the passed params' do
+      expect(subject.params).to eq(params)
+    end
+  end
+
+  describe '#guards' do
+    let(:guard_class1) { Struct.new(:component) }
+    let(:guard_class2) { Struct.new(:compontent, :extra) }
+    let(:guard_params) { {guard: guard_class2, something: 'more'} }
+
+    subject            { described_class.new(obj, name, params, [guard_class1, guard_params]).guards }
+
+    it 'contains an array of passed guards' do
+      expect(subject).to match_array([
+        an_instance_of(guard_class1),
+        an_instance_of(guard_class2)
+      ])
+    end
+
+    it 'preserves the extra params' do
+      expect(subject.last.extra).to eq(guard_params)
+    end
+
+    context 'with no guards specified in the constructors' do
+      subject { described_class.new(obj, name, params).guards }
+
+      it 'contains standard guards' do
+        expect(subject).to match_array([
+          an_instance_of(InfoparkComponentCache::Guards::ValuePresent),
+          an_instance_of(InfoparkComponentCache::Guards::LastChanged),
+          an_instance_of(InfoparkComponentCache::Guards::ObjCount),
+          an_instance_of(InfoparkComponentCache::Guards::ValidFrom),
+          an_instance_of(InfoparkComponentCache::Guards::ValidUntil)
+        ])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -22,4 +22,7 @@ RSpec.configure do |config|
   config.mock_with :rspec do |c|
     c.syntax = [:should, :expect]
   end
+  config.before :each do
+    Rails.cache.clear
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark_component_cache
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Tomasz Przedmojski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,16 +42,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ files:
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
 - spec/dummy/log/.gitkeep
+- spec/lib/compontent_cache_spec.rb
 - spec/lib/delayed_guard_spec.rb
 - spec/lib/guards/always_consistent_spec.rb
 - spec/lib/guards/last_changed_spec.rb
@@ -187,6 +188,7 @@ test_files:
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
 - spec/dummy/log/.gitkeep
+- spec/lib/compontent_cache_spec.rb
 - spec/lib/delayed_guard_spec.rb
 - spec/lib/guards/always_consistent_spec.rb
 - spec/lib/guards/last_changed_spec.rb