infopark_component_cache 3.2.0 → 4.0.0

data/lib/infopark_component_cache/key_generator.rb

@@ -1,4 +1,4 @@
-require 'digest/sha2'
+require "digest/sha2"
 
 module InfoparkComponentCache
   module KeyGenerator
@@ -19,7 +19,7 @@ module InfoparkComponentCache
     # uses some kind of hashing algorithm and therefore has the same
     # characteristics: equal inputs yield equal outputs, but different
     # inputs can yield same outputs (although it is very very unlikely)
-    # 
+    #
     # @param [String] string input string to be encoded
     # @return [String] string that is guaranteed to
     #   consist only of alphanumeric characters,
@@ -28,4 +28,4 @@ module InfoparkComponentCache
       Digest::SHA2.hexdigest(string)
     end
   end
-end
+end

data/lib/infopark_component_cache/version.rb

@@ -1,3 +1,3 @@
 module InfoparkComponentCache
-  VERSION = "3.2.0"
+  VERSION = "4.0.0".freeze
 end

data/lib/infopark_component_cache/volatile_cache.rb

@@ -3,7 +3,7 @@ require "infopark_component_cache/volatile_cache_storage"
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   #
-  # This module provides quick an convieniet access to 
+  # This module provides quick an convieniet access to
   # VolatileCacheStorage in any class that includes it.
   module VolatileCache
     def volatile_cache

data/lib/infopark_component_cache/volatile_cache_storage.rb

@@ -11,6 +11,7 @@ module InfoparkComponentCache
   # it is "nice to have" but also has to be extremely quick.
   class VolatileCacheStorage < AbstractCacheStorage
     protected
+
     def backing_storage
       @@backing_storage ||= ActiveSupport::Cache::MemoryStore.new({ size: 10.megabytes })
     end

data/spec/dummy/Rakefile

@@ -2,6 +2,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path("config/application", __dir__)
 
 Dummy::Application.load_tasks

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("config/environment", __dir__)
 run Dummy::Application

data/spec/dummy/config/application.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path("boot", __dir__)
 
 # Pick the frameworks you want:
 require "active_record/railtie"
@@ -14,4 +14,3 @@ module Dummy
     config.active_support.escape_html_entities_in_json = true
   end
 end
-

data/spec/dummy/config/boot.rb

@@ -1,10 +1,10 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+require "rubygems"
+gemfile = File.expand_path("../../../Gemfile", __dir__)
 
 if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
+  ENV["BUNDLE_GEMFILE"] = gemfile
+  require "bundler"
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path("../../../lib", __dir__)

data/spec/dummy/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the rails application
-require File.expand_path('../application', __FILE__)
+require File.expand_path("application", __dir__)
 
 # Initialize the rails application
 Dummy::Application.initialize!

data/spec/dummy/config/initializers/secret_token.rb

@@ -1 +1 @@
-Dummy::Application.config.secret_token = '4806ad3606eea6388c0428912c8c8b37266f29c4c45fa5ecd233316cd5b6a0016aea879cfa603059a7c00296daef192955e26ae3298830bd904c8ff6a791feb1'
+Dummy::Application.config.secret_token = "4806ad3606eea6388c0428912c8c8b37266f29c4c45fa5ecd233316cd5b6a0016aea879cfa603059a7c00296daef192955e26ae3298830bd904c8ff6a791feb1"

data/spec/dummy/config/initializers/session_store.rb

@@ -1 +1 @@
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, key: "_dummy_session"

data/spec/dummy/db/schema.rb

@@ -1,3 +1,2 @@
-ActiveRecord::Schema.define(:version => 0) do
-
+ActiveRecord::Schema.define(version: 0) do
 end

data/spec/lib/infopark_component_cache/component_cache_spec.rb

@@ -0,0 +1,118 @@
+require "spec_helper"
+
+describe InfoparkComponentCache::ComponentCache do
+  subject(:component_cache) { described_class.new(obj, name, params, [guard]) }
+
+  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)) }
+
+  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) { component_cache.guards.first }
+
+      it "returns the passed the block value" do
+        expect(component_cache.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!)
+
+        component_cache.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) do
+      Class.new(InfoparkComponentCache::ConsistencyGuard) do
+        def consistent?
+          cache.exist?(:guard_called)
+        end
+
+        def guard!
+          cache.write(:guard_called, 1)
+        end
+      end
+    end
+
+    describe "#fetch" do
+      let(:value) { "very_hard_computation_required_for_this_string" }
+      let(:specific_guard) { component_cache.guards.first }
+      let(:computer) { double }
+
+      it "returns the passed the block value" do
+        expect(component_cache.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 { component_cache.fetch { value } }
+      end
+
+      it "only evalues the block once" do
+        expect(computer).to receive(:compute).and_return(value).once
+
+        3.times { expect(component_cache.fetch { computer.compute }).to eq(value) }
+      end
+    end
+  end
+
+  describe "#compontent" do
+    subject(:component_cache) { described_class.new(obj, name, params).component }
+
+    it "stores the passed obj" do
+      expect(component_cache.obj).to eq(obj)
+    end
+
+    it "stores the passed name" do
+      expect(component_cache.name).to eq(name)
+    end
+
+    it "stores the passed params" do
+      expect(component_cache.params).to eq(params)
+    end
+  end
+
+  describe "#guards" do
+    subject(:component_cache) { described_class.new(obj, name, params, [guard_class1, guard_params]).guards }
+
+    let(:guard_class1) { Struct.new(:component) }
+    let(:guard_class2) { Struct.new(:compontent, :extra) }
+    let(:guard_params) { { guard: guard_class2, something: "more" } }
+
+    it "contains an array of passed guards" do
+      expect(component_cache).to match_array([
+                                               an_instance_of(guard_class1),
+                                               an_instance_of(guard_class2)
+                                             ])
+    end
+
+    it "preserves the extra params" do
+      expect(component_cache.last.extra).to eq(guard_params)
+    end
+
+    context "with no guards specified in the constructors" do
+      subject(:component_cache) { described_class.new(obj, name, params).guards }
+
+      it "contains standard guards" do
+        expect(component_cache).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/lib/{delayed_guard_spec.rb → infopark_component_cache/delayed_guard_spec.rb}

@@ -1,5 +1,5 @@
-require 'spec_helper'
-require 'infopark_component_cache/delayed_guard'
+require "spec_helper"
+require "infopark_component_cache/delayed_guard"
 
 describe InfoparkComponentCache::DelayedGuard do
   let(:base_class_with_options) do
@@ -56,7 +56,7 @@ describe InfoparkComponentCache::DelayedGuard do
       end
     end
 
-    context "after the delay has passed" do
+    context "when after the delay has passed" do
       specify "the calls returns new value" do
         first_value = delayed_subject.simple_counter
         expect(first_value).to eq(undelayed_subject.simple_counter)

data/spec/lib/{guards → infopark_component_cache/guards}/always_consistent_spec.rb

@@ -1,19 +1,20 @@
-require 'spec_helper'
-require 'infopark_component_cache/guards/always_consistent'
+require "spec_helper"
+require "infopark_component_cache/guards/always_consistent"
 
 describe InfoparkComponentCache::Guards::AlwaysConsistent do
-  {"with cache disabled" => :disable_cache, "with cache enabled" => :enable_cache}.each do |context_description, macro|
+  { "with cache disabled" => :disable_cache, "with cache enabled" => :enable_cache }.each do |context_description, macro|
     context context_description do
-      self.send(macro)
+      send(macro)
 
-      subject { described_class.new(double) }
+      subject(:guard) { described_class.new(double) }
 
       context "without a call to guard!" do
         it { is_expected.to be_consistent }
       end
 
       context "with a call to guard!" do
-        before { subject.guard! }
+        before { guard.guard! }
+
         it { is_expected.to be_consistent }
       end
     end

data/spec/lib/{guards → infopark_component_cache/guards}/last_changed_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe InfoparkComponentCache::Guards::LastChanged do
+  subject(:guard) { described_class.new(cache_component_stub) }
+
   let(:cache_component_stub) do
     double.tap do |cache_component_stub|
       cache_component_stub.stub(:cache_key) do |input|
@@ -9,7 +11,7 @@ describe InfoparkComponentCache::Guards::LastChanged do
     end
   end
 
-  let(:maximum_last_changed) { 10.minutes.ago.to_iso }
+  let(:maximum_last_changed) { 10.minutes.ago }
 
   let(:obj_stub) do
     double.tap do |obj_stub|
@@ -23,8 +25,6 @@ describe InfoparkComponentCache::Guards::LastChanged do
 
   before { InfoparkComponentCache::CmsStateGuard.obj_root_class = obj_stub }
 
-  subject { described_class.new(cache_component_stub) }
-
   context "with cache disabled" do
     disable_cache
 
@@ -33,7 +33,8 @@ describe InfoparkComponentCache::Guards::LastChanged do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.not_to be_consistent }
     end
   end
@@ -47,19 +48,26 @@ describe InfoparkComponentCache::Guards::LastChanged do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.to be_consistent }
     end
 
-    context "after maximum last change changes" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:maximum).and_return(Time.now.to_iso) }
+    context "when after maximum last change changes" do
+      before do
+        guard.guard!
+        obj_stub.stub(:maximum).and_return(Time.now.to_iso)
+      end
+
       it { is_expected.not_to be_consistent }
     end
 
-    context "after maximum last change changes to a past date" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:maximum).and_return(1.month.ago.to_iso) }
+    context "when after maximum last change changes to a past date" do
+      before do
+        guard.guard!
+        obj_stub.stub(:maximum).and_return(1.month.ago.to_iso)
+      end
+
       it { is_expected.to be_consistent }
     end
   end

data/spec/lib/{guards → infopark_component_cache/guards}/never_consistent_spec.rb

@@ -1,19 +1,20 @@
-require 'spec_helper'
-require 'infopark_component_cache/guards/never_consistent'
+require "spec_helper"
+require "infopark_component_cache/guards/never_consistent"
 
 describe InfoparkComponentCache::Guards::NeverConsistent do
-  {"cache disabled" => :disable_cache, "cache enabled" => :enable_cache}.each do |context_description, macro|
+  { "cache disabled" => :disable_cache, "cache enabled" => :enable_cache }.each do |context_description, macro|
     context context_description do
-      self.send(macro)
+      send(macro)
 
-      subject { described_class.new(double) }
+      subject(:guard) { described_class.new(double) }
 
       context "without a call to guard!" do
         it { is_expected.not_to be_consistent }
       end
 
       context "with a call to guard!" do
-        before { subject.guard! }
+        before { guard.guard! }
+
         it { is_expected.not_to be_consistent }
       end
     end

data/spec/lib/{guards → infopark_component_cache/guards}/obj_count_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe InfoparkComponentCache::Guards::ObjCount do
+  subject(:guard) { described_class.new(cache_component_stub) }
+
   let(:cache_component_stub) do
     double.tap do |cache_component_stub|
       cache_component_stub.stub(:cache_key) do |input|
@@ -9,7 +11,7 @@ describe InfoparkComponentCache::Guards::ObjCount do
     end
   end
 
-  let(:count) { 12314 }
+  let(:count) { 12_314 }
 
   let(:obj_stub) do
     double.tap do |obj_stub|
@@ -21,8 +23,6 @@ describe InfoparkComponentCache::Guards::ObjCount do
 
   before { InfoparkComponentCache::CmsStateGuard.obj_root_class = obj_stub }
 
-  subject { described_class.new(cache_component_stub) }
-
   context "with cache disabled" do
     disable_cache
 
@@ -31,7 +31,8 @@ describe InfoparkComponentCache::Guards::ObjCount do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.not_to be_consistent }
     end
   end
@@ -45,19 +46,26 @@ describe InfoparkComponentCache::Guards::ObjCount do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.to be_consistent }
     end
 
-    context "after obj count increases" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:count).and_return(55555) }
+    context "when after obj count increases" do
+      before do
+        guard.guard!
+        obj_stub.stub(:count).and_return(55_555)
+      end
+
       it { is_expected.not_to be_consistent }
     end
 
-    context "after obj count decreases" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:count).and_return(500) }
+    context "when after obj count decreases" do
+      before do
+        guard.guard!
+        obj_stub.stub(:count).and_return(500)
+      end
+
       it { is_expected.not_to be_consistent }
     end
   end

data/spec/lib/{guards → infopark_component_cache/guards}/valid_from_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe InfoparkComponentCache::Guards::ValidFrom do
+  subject(:guard) { described_class.new(cache_component_stub) }
+
   let(:cache_component_stub) do
     double.tap do |cache_component_stub|
       cache_component_stub.stub(:cache_key) do |input|
@@ -9,7 +11,7 @@ describe InfoparkComponentCache::Guards::ValidFrom do
     end
   end
 
-  let(:minimum_valid_from) { 10.minutes.since.to_iso }
+  let(:minimum_valid_from) { 10.minutes.since }
 
   let(:obj_stub) do
     double.tap do |obj_stub|
@@ -23,8 +25,6 @@ describe InfoparkComponentCache::Guards::ValidFrom do
 
   before { InfoparkComponentCache::CmsStateGuard.obj_root_class = obj_stub }
 
-  subject { described_class.new(cache_component_stub) }
-
   context "with cache disabled" do
     disable_cache
 
@@ -33,7 +33,8 @@ describe InfoparkComponentCache::Guards::ValidFrom do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.not_to be_consistent }
     end
   end
@@ -47,19 +48,26 @@ describe InfoparkComponentCache::Guards::ValidFrom do
     end
 
     context "with a call to guard!" do
-      before { subject.guard! }
+      before { guard.guard! }
+
       it { is_expected.to be_consistent }
     end
 
-    context "after minimum valid from changes to a present date" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:minimum).and_return(Time.now.to_iso) }
+    context "when after minimum valid from changes to a present date" do
+      before do
+        guard.guard!
+        obj_stub.stub(:minimum).and_return(Time.now.to_iso)
+      end
+
       it { is_expected.not_to be_consistent }
     end
 
-    context "after minimum valid from changes to a past date" do
-      before { subject.guard! } 
-      before { obj_stub.stub(:minimum).and_return(1.month.ago.to_iso) }
+    context "when after minimum valid from changes to a past date" do
+      before do
+        guard.guard!
+        obj_stub.stub(:minimum).and_return(1.month.ago.to_iso)
+      end
+
       it { is_expected.not_to be_consistent }
     end
   end