infopark_component_cache 3.1.0 → 4.1.0

data/lib/infopark_component_cache/consistency_guard.rb

@@ -15,7 +15,7 @@ module InfoparkComponentCache
   class ConsistencyGuard
     attr_reader :component, :options
 
-    def initialize(component, options={})
+    def initialize(component, options = {})
       @component = component
       @options   = options
     end

data/lib/infopark_component_cache/delayed_guard.rb

@@ -21,6 +21,7 @@ module InfoparkComponentCache
     end
 
     protected
+
     include VolatileCache
 
     def delayed_value(method_name)
@@ -30,17 +31,17 @@ module InfoparkComponentCache
     def still_delayed?(method_name)
       volatile_cache.exist?(delayed_value_key(method_name))
     end
-    
+
     def delay_value(method_name, value, expiration)
       volatile_cache.write(delayed_value_key(method_name), value, expires_in: expiration)
       value
     end
 
     def delayed_value_key(method_name)
-      KeyGenerator.generate_key(self.options.merge({
-        delayed_method_name: method_name,
-        delayed_class_name: self.class.name
-      }))
+      KeyGenerator.generate_key(options.merge({
+                                                delayed_method_name: method_name,
+                                                delayed_class_name: self.class.name
+                                              }))
     end
 
     module ClassMethods
@@ -55,11 +56,10 @@ module InfoparkComponentCache
           if still_delayed?(method_name)
             value
           else
-            delay_value(method_name, self.send(:"delayed_#{method_name}"), expiration)
+            delay_value(method_name, send(:"delayed_#{method_name}"), expiration)
           end
         end
       end
     end
-
   end
 end

data/lib/infopark_component_cache/guards/cms_state_guard.rb

@@ -17,15 +17,16 @@ module InfoparkComponentCache
     end
 
     protected
+
     # This method implements scoping on the root Obj class
     # and additional constraints for limiting object classes
     # used for lookup
     def scoped_relation
-      if self.options[:obj_classes].present?
-        conditions = {obj_class: self.options[:obj_classes]}
-      else
-        conditions = {}
-      end
+      conditions = if options[:obj_classes].present?
+                     { obj_class: options[:obj_classes] }
+                   else
+                     {}
+                   end
       CmsStateGuard.obj_root_class.where(conditions)
     end
   end

data/lib/infopark_component_cache/guards/last_changed.rb

@@ -27,12 +27,15 @@ module InfoparkComponentCache
 
       # @return [String] the cache key for storing {#current_last_changed}
       def cache_key
-        component.cache_key('last_changed')
+        component.cache_key("last_changed")
       end
 
       # @return [Time] the timestamp of the most recent change to any Obj
       def current_last_changed
-        RailsConnector::DateAttribute.parse(scoped_relation.maximum(:last_changed))
+        str_value = scoped_relation.maximum(:last_changed)
+        return str_value if str_value.kind_of? Time
+
+        RailsConnector::DateAttribute.parse(str_value)
       end
     end
   end

data/lib/infopark_component_cache/guards/obj_count.rb

@@ -18,7 +18,7 @@ module InfoparkComponentCache
 
       # @return true if obj count can be read from cache with {#cache_key}
       def count_known?
-        cache.exist?(cache_key) && cache.read(cache_key).kind_of?(Fixnum)
+        cache.exist?(cache_key) && cache.read(cache_key).kind_of?(Integer)
       end
 
       # @return true if no obj has been deleted or added since last {#guard!}
@@ -28,10 +28,10 @@ module InfoparkComponentCache
 
       # @return [String] the cache key for storing {#current_count}
       def cache_key
-        component.cache_key('obj_count')
+        component.cache_key("obj_count")
       end
 
-      # @return [Fixnum] the number of Objs in the database
+      # @return [Integer] the number of Objs in the database
       def current_count
         scoped_relation.count
       end

data/lib/infopark_component_cache/guards/valid_from.rb

@@ -1,5 +1,4 @@
 require "infopark_component_cache/guards/cms_state_guard"
-
 module InfoparkComponentCache
   module Guards
     # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
@@ -9,9 +8,9 @@ module InfoparkComponentCache
     class ValidFrom < CmsStateGuard
       def consistent?
         if min_valid_from_known?
-          return no_changes_since?
+          no_changes_since?
         else
-          return current_min_valid_from.nil?
+          current_min_valid_from.nil?
         end
       end
 
@@ -31,17 +30,15 @@ module InfoparkComponentCache
 
       # @return [String] the cache key for storing {#current_min_valid_from}
       def cache_key
-        component.cache_key('min_valid_from')
+        component.cache_key("min_valid_from")
       end
 
       # @return [Time] the timestamp of the most recent valid_from, or nil if none found
       def current_min_valid_from
-        str_value = scoped_relation.where('valid_from > ?', Time.now.to_iso).minimum(:valid_from)
-        if str_value.present?
-          RailsConnector::DateAttribute.parse(str_value)
-        else
-          nil
-        end
+        str_value = scoped_relation.where("valid_from > ?", Time.now.to_iso).minimum(:valid_from)
+        return str_value if str_value.kind_of? Time
+
+        RailsConnector::DateAttribute.parse(str_value) if str_value.present?
       end
     end
   end

data/lib/infopark_component_cache/guards/valid_until.rb

@@ -9,9 +9,9 @@ module InfoparkComponentCache
     class ValidUntil < CmsStateGuard
       def consistent?
         if min_valid_until_known?
-          return no_changes_since?
+          no_changes_since?
         else
-          return current_min_valid_until.nil?
+          current_min_valid_until.nil?
         end
       end
 
@@ -31,17 +31,15 @@ module InfoparkComponentCache
 
       # @return [String] the cache key for storing {#current_min_valid_until}
       def cache_key
-        component.cache_key('min_valid_until')
+        component.cache_key("min_valid_until")
       end
 
       # @return [Time] the timestamp of the the object that will be deactivated in nearest future
       def current_min_valid_until
-        str_value = scoped_relation.where('valid_until > ?', Time.now.to_iso).minimum(:valid_until)
-        if str_value.present?
-          RailsConnector::DateAttribute.parse(str_value)
-        else
-          nil
-        end
+        str_value = scoped_relation.where("valid_until > ?", Time.now.to_iso).minimum(:valid_until)
+        return str_value if str_value.kind_of? Time
+
+        RailsConnector::DateAttribute.parse(str_value) if str_value.present?
       end
     end
   end

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.1.0"
+  VERSION = "4.1.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"
@@ -12,6 +12,8 @@ module Dummy
     config.encoding = "utf-8"
     config.filter_parameters += [:password]
     config.active_support.escape_html_entities_in_json = true
+    if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 2
+      config.active_record.sqlite3.represent_boolean_as_integer = true
+    end
   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/environments/development.rb

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

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

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

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)