infopark_component_cache 3.1.0 → 4.1.0

data/Gemfile.rails51

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in infopark_component_cache.gemspec
+gemspec
+
+gem "rails", "~> 5.1.0"

data/Gemfile.rails51.lock

@@ -0,0 +1,206 @@
+PATH
+  remote: .
+  specs:
+    infopark_component_cache (4.0.1)
+      infopark_fiona_connector (~> 7.0.1.5.2.3.rc5)
+      rails (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.7)
+      actionpack (= 5.1.7)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.7)
+      actionview (= 5.1.7)
+      activesupport (= 5.1.7)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.7)
+      activesupport (= 5.1.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.7)
+      activesupport (= 5.1.7)
+      globalid (>= 0.3.6)
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
+      arel (~> 8.0)
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    helpful_configuration (0.1.0)
+    i18n (1.8.4)
+      concurrent-ruby (~> 1.0)
+    infopark_fiona_connector (7.0.1.5.2.3.rc6)
+      activerecord (~> 5.0)
+      helpful_configuration (~> 0.1.0)
+      jquery-rails (~> 4.3)
+      json (~> 2.3)
+      maruku (~> 0.7)
+      mime-types (~> 3.1)
+      mysql_blob_streaming (~> 2.3)
+      rails (~> 5.0)
+      rake (~> 12.3)
+      rsolr (~> 2.1.0s)
+    jquery-rails (4.4.0)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (2.3.1)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    maruku (0.7.3)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    multipart-post (2.1.1)
+    mysql2 (0.5.3)
+    mysql_blob_streaming (2.3.0)
+      mysql2 (>= 0.4.4, < 0.6.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.7)
+      actioncable (= 5.1.7)
+      actionmailer (= 5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      activemodel (= 5.1.7)
+      activerecord (= 5.1.7)
+      activesupport (= 5.1.7)
+      bundler (>= 1.3.0)
+      railties (= 5.1.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.1.7)
+      actionpack (= 5.1.7)
+      activesupport (= 5.1.7)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rsolr (2.1.0)
+      builder (>= 2.1.2)
+      faraday (>= 0.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.87.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.0)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  infopark_component_cache!
+  pry-byebug (~> 3.9)
+  rails (~> 5.1.0)
+  rspec-rails (~> 3.5)
+  rubocop (~> 0.87.1)
+  rubocop-performance (~> 1.7)
+  rubocop-rspec (~> 1.30)
+  sqlite3 (~> 1.3, >= 1.3.6)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,4 +1,4 @@
-# Infopark's ComponentCache
+# Infopark's ComponentCache [![Build Status](https://travis-ci.com/infopark/component_cache.svg?token=9yf7x57D3eQF9WPTdzqX&branch=master)](https://travis-ci.com/infopark/component_cache)
 
 Fragment caching with automatic dependency resolution and cache invalidation.
 

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', '~> 3.5'
-  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

@@ -7,15 +7,17 @@ module InfoparkComponentCache
   class Component
     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 name
-      self.component
+      component
     end
 
-    def cache_key(meta_prefix=nil)
+    def cache_key(meta_prefix = nil)
       if meta_prefix
         meta_prefix + "_" + KeyGenerator.generate_key(identity_hash)
       else
@@ -24,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

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,12 +54,13 @@ module InfoparkComponentCache
     #
     # @return true if cache is valid and in consistent state
     def expired?
-      return true if !cache.enabled?
-      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
@@ -70,7 +71,7 @@ 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
@@ -78,11 +79,11 @@ module InfoparkComponentCache
             cache.write(component.cache_key, value)
             ensure_consistency!
           end
-          return value
+          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)