infopark_component_cache 3.0.0 → 4.0.1

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/Rakefile

@@ -1,19 +1,19 @@
 #!/usr/bin/env rake
 
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 
-#load 'rails/tasks/engine.rake'
+# load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 desc "Run all specs in spec directory (excluding plugin specs)"
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/app/helpers/infopark_component_cache_helper.rb

@@ -1,7 +1,7 @@
 module InfoparkComponentCacheHelper
-  def cache_tagged_component(obj, component, params={}, &block)
+  def cache_tagged_component(obj, component, params = {}, &block)
     InfoparkComponentCache::ComponentCache.new(obj, component, params).fetch do
       capture(&block)
     end
   end
-end
+end

data/infopark_component_cache.gemspec

@@ -1,27 +1,30 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'infopark_component_cache/version'
+require "infopark_component_cache/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "infopark_component_cache"
   gem.version       = InfoparkComponentCache::VERSION
-  gem.authors       = ["Tomasz Przedmojski"]
+  gem.authors       = ["Tomasz Przedmojski, sveninfo"]
   gem.email         = ["tomasz.przedmojski@infopark.de"]
-  gem.description   = %q{Easy and intelligent fragment caching for RailsConnector projects}
-  gem.summary       = %q{Fragment caching with automatic dependency resolution and cache invalidation.}
-  gem.homepage      = ""
+  gem.description   = "Easy and intelligent fragment caching for RailsConnector projects"
+  gem.summary       = "Fragment caching with automatic dependency resolution and cache invalidation."
+  gem.homepage      = "http://infopark.com"
+  gem.license       = "LGPL-3.0"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'rails', '~> 4.2.6'
+  gem.add_dependency "rails", "~> 5.0"
 
-  gem.add_dependency 'infopark_fiona_connector'
+  gem.add_dependency "infopark_fiona_connector", "~> 7.0.1.5.2.3.rc5"
 
-  gem.add_development_dependency 'rspec-rails'
-  gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'byebug'
+  gem.add_development_dependency "pry-byebug", "~> 3.9"
+  gem.add_development_dependency "rspec-rails", "~> 3.5"
+  gem.add_development_dependency "rubocop", "~> 0.87.1"
+  gem.add_development_dependency "rubocop-performance", "~> 1.7"
+  gem.add_development_dependency "rubocop-rspec", "~> 1.30"
+  gem.add_development_dependency "sqlite3", "~> 1.3", ">= 1.3.6"
 end

data/lib/engine.rb

@@ -1,8 +1,9 @@
-require "infopark_fiona_connector"
+require "rails_connector/core_extensions.rb"
+require "rails_connector/date_attribute.rb"
 require "active_support/core_ext/numeric/time"
 
-#require "infopark_component_cache/guards/always_consistent"
-#require "infopark_component_cache/guards/never_consistent"
+# require "infopark_component_cache/guards/always_consistent"
+# require "infopark_component_cache/guards/never_consistent"
 require "infopark_component_cache/guards/value_present"
 require "infopark_component_cache/guards/cms_state_guard"
 
@@ -30,19 +31,17 @@ module InfoparkComponentCache
 
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   class Engine < Rails::Engine
-
     initializer "component_cache.helpers" do
       [
         InfoparkComponentCacheHelper
       ].each do |helper|
-        ActionView::Base.__send__(      :include, helper)
+        ActionView::Base.__send__(:include, helper)
       end
     end
 
     initializer "set default obj_root_class" do
       InfoparkComponentCache.obj_root_class ||= ::Obj
-      CmsStateGuard.obj_root_class = InfoparkComponentCache.obj_root_class 
+      CmsStateGuard.obj_root_class = InfoparkComponentCache.obj_root_class
     end
-
   end
 end

data/lib/infopark_component_cache.rb

@@ -1,7 +1,6 @@
 require "infopark_component_cache/version"
 
 module InfoparkComponentCache
-
 end
 
-require File.expand_path('../engine', __FILE__) if defined?(Rails)
+require File.expand_path("engine", __dir__) if defined?(Rails)

data/lib/infopark_component_cache/abstract_cache_storage.rb

@@ -1,4 +1,4 @@
-require 'singleton'
+require "singleton"
 
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
@@ -18,10 +18,10 @@ module InfoparkComponentCache
 
     def read(key)
       # it is possible to read disabled cache!
-      backing_storage.read(key) 
+      backing_storage.read(key)
     end
 
-    def write(key, value, options={})
+    def write(key, value, options = {})
       backing_storage.write(key, value, options) if enabled?
     rescue Errno::ENOSPC => e
       Rails.logger.error("Unable to write cache, cache full: #{e.message}")
@@ -33,6 +33,7 @@ module InfoparkComponentCache
     end
 
     protected
+
     def backing_storage
       raise TypeError, "Cannot use abstract cache storage. Please provide a concrete cache storage in #{self.class.name}"
     end

data/lib/infopark_component_cache/cache_storage.rb

@@ -9,6 +9,7 @@ module InfoparkComponentCache
   # Rails cache (Rails.application.config.cache_store).
   class CacheStorage < AbstractCacheStorage
     protected
+
     def backing_storage
       Rails.cache
     end

data/lib/infopark_component_cache/component.rb

@@ -5,13 +5,19 @@ 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
+    def initialize(obj, component, params = {})
+      @obj = obj
+      @component = component
+      @params = params
     end
 
-    def cache_key(meta_prefix=nil)
+    def name
+      component
+    end
+
+    def cache_key(meta_prefix = nil)
       if meta_prefix
         meta_prefix + "_" + KeyGenerator.generate_key(identity_hash)
       else
@@ -20,7 +26,9 @@ module InfoparkComponentCache
     end
 
     def identity_hash
-      @params.merge({:obj_name=>@obj.name, :obj_id=>@obj.id, :obj_component=>@component})
+      @params
+        .except(:obj) # avoid the (ruby) object_id as part of the cache key (to_s), because it will change for each request
+        .merge({ obj_name: @obj.name, obj_id: @obj.id, obj_component: @component })
     end
   end
-end
+end

data/lib/infopark_component_cache/component_cache.rb

@@ -24,27 +24,27 @@ module InfoparkComponentCache
     #   @see Guard::ValuePresent
     #   @see Guard::LastChanged
     #   @see Guard::ObjCount
-    def initialize(obj, name, params={}, guards=[])
+    def initialize(obj, name, params = {}, guards = [])
       @component = Component.new(obj, name, params)
-      if guards.empty?
-        @guards = [
-            Guards::ValuePresent.new(@component),
-            Guards::LastChanged.new(@component),
-            Guards::ObjCount.new(@component),
-            Guards::ValidFrom.new(@component),
-            Guards::ValidUntil.new(@component)
-          ]
-      else
-        @guards = guards.map do |klass_or_hash|
-          if klass_or_hash.kind_of?(Hash)
-            klass = klass_or_hash.delete(:guard)
-            klass.new(@component, klass_or_hash)
-          else
-            klass = klass_or_hash
-            klass.new(@component)
-          end
-        end
-      end
+      @guards = if guards.empty?
+                  [
+                    Guards::ValuePresent.new(@component),
+                    Guards::LastChanged.new(@component),
+                    Guards::ObjCount.new(@component),
+                    Guards::ValidFrom.new(@component),
+                    Guards::ValidUntil.new(@component)
+                  ]
+                else
+                  guards.map do |klass_or_hash|
+                    if klass_or_hash.kind_of?(Hash)
+                      klass = klass_or_hash.delete(:guard)
+                      klass.new(@component, klass_or_hash)
+                    else
+                      klass = klass_or_hash
+                      klass.new(@component)
+                    end
+                  end
+                end
     end
 
     # Checks if cache is valid (in consistent state).
@@ -54,11 +54,13 @@ module InfoparkComponentCache
     #
     # @return true if cache is valid and in consistent state
     def expired?
-      return !guards.all?(&:consistent?)
+      return true unless cache.enabled?
+
+      !guards.all?(&:consistent?)
+    rescue StandardError => e
+      raise e if Rails.env.test?
 
-    rescue => exception
-      raise exception if Rails.env.test?
-      return true
+      true
     end
 
     # Checks if the cache is in consistent state and cached value
@@ -69,17 +71,19 @@ module InfoparkComponentCache
     # @see {#expired?}
     # @yieldreturn value to be used in case of cache miss
     # @return cached value or the return value of the block
-    def fetch(&block)
+    def fetch(&_block)
       if expired?
         value = yield
         begin
-          cache.write(component.cache_key, value)
-          ensure_consistency!
-          return value
+          if cache.enabled?
+            cache.write(component.cache_key, value)
+            ensure_consistency!
+          end
+          value
+        rescue StandardError => e
+          raise e if Rails.env.test?
 
-        rescue => exception
-          raise exception if Rails.env.test?
-          return value
+          value
         end
       else
         cache.read(component.cache_key)

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