infopark_component_cache 1.1.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c9951c7ea10085ae1cd14375a86ca566f3fcad1
+  data.tar.gz: adad2fd6542596562b972efd2dd8796f040cec53
+SHA512:
+  metadata.gz: 4ddbcdc5cd1d85e677ddf264e2044b82ad59d899eb9ecc7d6b55310de7ec23922151dfbe1fce2f27afb79d093cc8a1f4f3d9063d69b7c9373244030c097d56c4
+  data.tar.gz: 95256ba30f389cdb5d4984a67a231f68cd1a79bbb97839bec1250103cb03418b5485cf49c6efcec960fd9e456a458223ae0f2eda694f6ca8de205ad6116c5b1f

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-version

@@ -0,0 +1 @@
+2.1.6

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in infopark_component_cache.gemspec
 gemspec
+
+gem 'rails', '3.2.21'
+gem 'infopark_fiona_connector', '6.9.4'
+gem 'infopark_rails_connector', '6.9.4'

data/README.md

@@ -33,6 +33,14 @@ Alternatively you could use component cache directly:
       This content will be cached
     <% end %>
 
+Most guard also provide an option to limit the lookup to specific object classes, for example:
+
+    <%= cache_tagged_component(@gallery, 'gallery', {}, [{guard: InfoparkComponentCache::ObjCount, obj_classes: ['Image']}]) do %>
+      This content will be cached
+    <% end %>
+
+will only get invalidated when the number of objects of the class 'Image' changes in the CMS.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,11 +1,19 @@
-require "bundler/gem_tasks"
-require 'rubygems'
-require 'bundler/setup'
-require 'rspec/core/rake_task'
+#!/usr/bin/env rake
 
-desc "Run all specs in spec directory"
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+#load 'rails/tasks/engine.rake'
 
-# Remove release task
-task :release do ; end
-task(:release).clear_prerequisites.clear_actions
+Bundler::GemHelper.install_tasks
+
+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

data/app/helpers/infopark_component_cache_helper.rb

@@ -4,10 +4,4 @@ module InfoparkComponentCacheHelper
       capture(&block)
     end
   end
-
-  def cache_guarded_component(obj, component, guards, params, &block)
-    InfoparkComponentCache::ComponentCache.new(obj, component, params, guards).fetch do
-      capture(&block)
-    end
-  end
-end
+end

data/infopark_component_cache.gemspec

@@ -17,8 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'rails'
+  gem.add_dependency 'rails', '> 3.0.0'
 
-  gem.add_dependency 'infopark_rails_connector'
-  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'infopark_fiona_connector'
+
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'byebug'
 end

data/lib/engine.rb

@@ -1,5 +1,34 @@
+require "infopark_fiona_connector"
+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/value_present"
+require "infopark_component_cache/guards/cms_state_guard"
+
+require "infopark_component_cache/guards/last_changed"
+require "infopark_component_cache/guards/obj_count"
+require "infopark_component_cache/guards/valid_from"
+require "infopark_component_cache/guards/valid_until"
+
+require "infopark_component_cache/guards/delayed_last_changed"
+require "infopark_component_cache/guards/delayed_obj_count"
+require "infopark_component_cache/guards/delayed_valid_from"
+require "infopark_component_cache/guards/delayed_valid_until"
+
+require "infopark_component_cache/key_generator"
+require "infopark_component_cache/consistency_guard"
+require "infopark_component_cache/cache_storage"
+require "infopark_component_cache/component"
+require "infopark_component_cache/component_cache"
+
 module InfoparkComponentCache
+  # @!scope class
+  # This parameter should be initialized to the root object
+  # class of the project. It defaults to "::Obj".
+  mattr_accessor :obj_root_class
 
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   class Engine < Rails::Engine
 
     initializer "component_cache.helpers" do
@@ -9,6 +38,11 @@ module InfoparkComponentCache
         ActionView::Base.__send__(      :include, helper)
       end
     end
-  end
 
+    initializer "set default obj_root_class" do
+      InfoparkComponentCache.obj_root_class ||= ::Obj
+      CmsStateGuard.obj_root_class = InfoparkComponentCache.obj_root_class 
+    end
+
+  end
 end

data/lib/infopark_component_cache.rb

@@ -1,19 +1,5 @@
 require "infopark_component_cache/version"
 
-#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/last_changed"
-require "infopark_component_cache/guards/obj_count"
-require "infopark_component_cache/guards/valid_from"
-require "infopark_component_cache/guards/valid_until"
-
-require "infopark_component_cache/key_generator"
-require "infopark_component_cache/consistency_guard"
-require "infopark_component_cache/cache_storage"
-require "infopark_component_cache/component"
-require "infopark_component_cache/component_cache"
-
 module InfoparkComponentCache
 
 end

data/lib/infopark_component_cache/abstract_cache_storage.rb

@@ -0,0 +1,40 @@
+require 'singleton'
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # This abstract base class represents a very thin wrapper
+  # around the underlying cache storage.
+  #
+  # @note Any valid implementation *must* respect
+  #   Rails.application.config.action_controller.perform_caching
+  #   setting.
+  class AbstractCacheStorage
+    include Singleton
+
+    def exist?(key)
+      enabled? && backing_storage.exist?(key)
+    end
+
+    def read(key)
+      # it is possible to read disabled cache!
+      backing_storage.read(key) 
+    end
+
+    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}")
+    end
+
+    # @private
+    def enabled?
+      Rails.application.config.action_controller.perform_caching
+    end
+
+    protected
+    def backing_storage
+      raise TypeError, "Cannot use abstract cache storage. Please provide a concrete cache storage in #{self.class.name}"
+    end
+  end
+end

data/lib/infopark_component_cache/cache_storage.rb

@@ -1,30 +1,16 @@
-require 'singleton'
+require "infopark_component_cache/abstract_cache_storage"
 
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   #
-  # Trivial wrapper around underlying cache storages.
-  # This class or any other class that inherits it *must*
-  # respect Rails.application.config.action_controller.perform_caching
-  # setting.
-  class CacheStorage
-    include Singleton
-
-    def exist?(key)
-      enabled? && Rails.cache.exist?(key)
-    end
-
-    def read(key)
-      Rails.cache.read(key) # you can still read the cache if you wish...
-    end
-
-    def write(key, value)
-      Rails.cache.write(key, value) if enabled?
-    end
-
-    # @private
-    def enabled?
-      Rails.application.config.action_controller.perform_caching
+  # This class implements a persistent cache storage, that
+  # it a cache which will probably persists between requests.
+  # In the current version it relies on the preconfigured
+  # Rails cache (Rails.application.config.cache_store).
+  class CacheStorage < AbstractCacheStorage
+    protected
+    def backing_storage
+      Rails.cache
     end
   end
-end
+end

data/lib/infopark_component_cache/component.rb

@@ -1,5 +1,3 @@
-require 'infopark_component_cache/key_generator'
-
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   #
@@ -25,4 +23,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

@@ -1,12 +1,3 @@
-require 'infopark_component_cache/component'
-require 'infopark_component_cache/cache_storage'
-
-require 'infopark_component_cache/guards/value_present'
-require 'infopark_component_cache/guards/last_changed'
-require 'infopark_component_cache/guards/obj_count'
-require 'infopark_component_cache/guards/valid_from'
-require 'infopark_component_cache/guards/valid_until'
-
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   # This class provides user-level access to component cache.
@@ -27,7 +18,7 @@ module InfoparkComponentCache
     # the component
     # @see Component
     #
-    # @param [Array<Class>] guards list of guard
+    # @param [Array<Class>, Array<Hash>] guards list of guard
     #   classes used when deciding whether cache is valid
     #   when left empty the default set is used:
     #   @see Guard::ValuePresent
@@ -44,8 +35,14 @@ module InfoparkComponentCache
             Guards::ValidUntil.new(@component)
           ]
       else
-        @guards = guards.map do |klass|
-          klass.new(@component)
+        @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
     end

data/lib/infopark_component_cache/consistency_guard.rb

@@ -1,5 +1,3 @@
-require 'infopark_component_cache/cache_storage'
-
 module InfoparkComponentCache
   # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
   #
@@ -15,10 +13,11 @@ module InfoparkComponentCache
   # This consistency is crucial for the function of cache, because
   # inconsistent cache is (automatically) invalidated.
   class ConsistencyGuard
-    attr_reader :component
+    attr_reader :component, :options
 
-    def initialize(component)
+    def initialize(component, options={})
       @component = component
+      @options   = options
     end
 
     # @return [CacheStorage] instance of CacheStorage

data/lib/infopark_component_cache/delayed_guard.rb

@@ -0,0 +1,65 @@
+require "infopark_component_cache/volatile_cache"
+require "infopark_component_cache/key_generator"
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # This module provides an easy way to create delayed guards
+  # by using meta programming.
+  #
+  # @example Delaying an ObjectCount which guards on :object_count
+  #   class DelayedObjectCount < ObjectCount
+  #     include DelayedGuard
+  #     delay :object_count, for: 10.minutes
+  #   end
+  #
+  # @note Including classes must implement options method which
+  #   completely described the object state and returns a hash.
+  module DelayedGuard
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    protected
+    include VolatileCache
+
+    def delayed_value(method_name)
+      volatile_cache.read(delayed_value_key(method_name))
+    end
+
+    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
+      }))
+    end
+
+    module ClassMethods
+      def delay(method_name, options)
+        expiration = options[:for]
+        return unless expiration
+
+        # allow to overwrite the delays
+        alias_method :"delayed_#{method_name}", method_name unless method_defined?(:"delayed_#{method_name}")
+        define_method method_name do
+          value = delayed_value(method_name)
+          if still_delayed?(method_name)
+            value
+          else
+            delay_value(method_name, self.send(:"delayed_#{method_name}"), expiration)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/infopark_component_cache/guards/always_consistent.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/consistency_guard"
 
 module InfoparkComponentCache
   module Guards

data/lib/infopark_component_cache/guards/cms_state_guard.rb

@@ -0,0 +1,32 @@
+require "infopark_component_cache/consistency_guard"
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # @abstract
+  # This abstract class enables the implementing classes
+  # to access the cms and read the current state.
+  #
+  # It also provides the option to limit the object classes
+  # used for lookup.
+  class CmsStateGuard < ConsistencyGuard
+    class << self
+      # This parameter should be initialized to the root Obj
+      # class of the project
+      attr_accessor :obj_root_class
+    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
+      CmsStateGuard.obj_root_class.scoped.where(conditions)
+    end
+  end
+end

data/lib/infopark_component_cache/guards/delayed_last_changed.rb

@@ -0,0 +1,18 @@
+require "infopark_component_cache/delayed_guard"
+require "infopark_component_cache/guards/last_changed"
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This class is a delayed version of LastChanged guard.
+    # The preconfigured delay is 10 seconds.
+    #
+    # @see DelayedGuard
+    # @see LastChanged
+    class DelayedLastChanged < LastChanged
+      include DelayedGuard
+      delay :current_last_changed, for: 10.seconds
+    end
+  end
+end