infopark_component_cache 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in infopark_component_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,42 @@
+# Infopark's ComponentCache
+
+Fragment caching with automatic dependency resolution and cache invalidation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'infopark_component_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install infopark_component_cache
+
+## Usage
+
+Set up Rails catching (see [http://guides.rubyonrails.org/caching_with_rails.html](http://guides.rubyonrails.org/caching_with_rails.html)) and
+in your view write:
+    
+    <%= cache_tagged_component(@rails_connector_obj, 'any-string-as-component-name', {:additional => :parameters}) do %>
+      This content will be cached
+    <% end %>
+
+and you are done.
+
+Alternatively you could use component cache directly:
+
+    <%= InfoparkComponentCache::ComponentCache.new(@rails_connector_obj, 'any-string-as-component-name', {:additional => :parameters}).fetch do %>
+      This content will be cached
+    <% end %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/helpers/infopark_component_cache_helper.rb

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

data/infopark_component_cache.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infopark_component_cache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "infopark_component_cache"
+  gem.version       = InfoparkComponentCache::VERSION
+  gem.authors       = ["Tomasz Przedmojski"]
+  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.files         = `git ls-files`.split($/)
+  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'
+
+  gem.add_dependency 'infopark_rails_connector'
+end

data/lib/engine.rb

@@ -0,0 +1,14 @@
+module InfoparkComponentCache
+
+  class Engine < Rails::Engine
+
+    initializer "component_cache.helpers" do
+      [
+        InfoparkComponentCacheHelper
+      ].each do |helper|
+        ActionView::Base.__send__(      :include, helper)
+      end
+    end
+  end
+
+end

data/lib/infopark_component_cache.rb

@@ -0,0 +1,21 @@
+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
+
+require File.expand_path('../engine', __FILE__) if defined?(Rails)

data/lib/infopark_component_cache/cache_storage.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+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
+    end
+  end
+end

data/lib/infopark_component_cache/component.rb

@@ -0,0 +1,28 @@
+require 'infopark_component_cache/key_generator'
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # Cache entity (component) consists of an obj, a name
+  # 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
+
+    def initialize(obj, component, params={})
+      @obj, @component, @params = obj, component, params
+    end
+
+    def cache_key(meta_prefix=nil)
+      if meta_prefix
+        meta_prefix + "_" + KeyGenerator.generate_key(identity_hash)
+      else
+        KeyGenerator.generate_key(identity_hash)
+      end
+    end
+
+    def identity_hash
+      @params.merge({:obj_name=>@obj.name, :obj_id=>@obj.id, :obj_component=>@component})
+    end
+  end
+end

data/lib/infopark_component_cache/component_cache.rb

@@ -0,0 +1,103 @@
+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.
+  #
+  # @example Do some expensive computation on a page
+  #   InfoparkComponentCache::ComponentCache.new(@obj, 'processed_body', :page => 14) do
+  #     expensive_process_body @obj.body
+  #   end
+  #
+  # By default ComponentCache comes with a set of Guards, i.e.
+  # classes that check the consistency of cache and invalidate it,
+  # should it be neccesary.
+  # @see ComponentCache#initialize
+  class ComponentCache
+    attr_reader :component, :guards
+
+    # First three parameters are used to construct
+    # the component
+    # @see Component
+    #
+    # @param [Array<Class>] guards list of guard
+    #   classes used when deciding whether cache is valid
+    #   when left empty the default set is used:
+    #   @see Guard::ValuePresent
+    #   @see Guard::LastChanged
+    #   @see Guard::ObjCount
+    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|
+          klass.new(@component)
+        end
+      end
+    end
+
+    # Checks if cache is valid (in consistent state).
+    # It delegates work to specified #guards
+    #
+    # For any unexpected case it returns true.
+    #
+    # @return true if cache is valid and in consistent state
+    def expired?
+      return !guards.all?(&:consistent?)
+
+    rescue => exception
+      raise exception if Rails.env.test?
+      return true
+    end
+
+    # Checks if the cache is in consistent state and cached value
+    # can be returned.
+    # In such case it returns cached value.
+    # Otherwise it evaluates passed block and updates the cache.
+    #
+    # @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)
+      if expired?
+        value = yield
+        begin
+          cache.write(component.cache_key, value)
+          ensure_consistency!
+          return value
+
+        rescue => exception
+          raise exception if Rails.env.test?
+          return value
+        end
+      else
+        cache.read(component.cache_key)
+      end
+    end
+
+    # @private
+    # @return [CacheStorage] instance of CacheStorage to use
+    def cache
+      CacheStorage.instance
+    end
+
+    # @private
+    def ensure_consistency!
+      guards.each(&:guard!)
+    end
+  end
+end

data/lib/infopark_component_cache/consistency_guard.rb

@@ -0,0 +1,44 @@
+require 'infopark_component_cache/cache_storage'
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # @abstract
+  # This is abstract base class for any Cache Guards.
+  # Any class inheriting ConsistencyGuard should implement #consistent?
+  # and #guard!
+  #
+  # Cache Guard is a class that promises some consistency, for example
+  # that no changes to the database accured between calls to #guard!
+  # and #consistent?
+  #
+  # This consistency is crucial for the function of cache, because
+  # inconsistent cache is (automatically) invalidated.
+  class ConsistencyGuard
+    attr_reader :component
+
+    def initialize(component)
+      @component = component
+    end
+
+    # @return [CacheStorage] instance of CacheStorage
+    def cache
+      CacheStorage.instance
+    end
+
+    # @abstract
+    # This method returns true if the consistenty guarded by this class
+    # is fulfilled and false otherwise.
+    def consistent?
+      raise TypeError, "Abstract method consistent? called"
+    end
+
+    # @abstract
+    # This method is called whenever cache is updated for the component.
+    # Any values checked by #consistent? can be persisted here. Use #{cache}
+    # for persistence but mind the possible inconsistencies.
+    def guard!
+      raise TypeError, "Abstract method guard! called"
+    end
+  end
+end

data/lib/infopark_component_cache/guards/always_consistent.rb

@@ -0,0 +1,20 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This is a dummy Guard, mostly for tests purposes.
+    # It ensures that the cache is always consistent (provided
+    # other guards are also consistent!)
+    class AlwaysConsistent < ConsistencyGuard
+      def consistent?
+        true
+      end
+
+      def guard!
+        # noop
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/last_changed.rb

@@ -0,0 +1,39 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This Guard class ensures that the objects in database do not change inbetween.
+    # (It caches the newest timestamp and compares it to the current value)
+    class LastChanged < ConsistencyGuard
+      def consistent?
+        last_changed_known? && no_changes_since?
+      end
+
+      def guard!
+        cache.write(cache_key, current_last_changed)
+      end
+
+      # @return true if a timestamp can be read from cache with {#cache_key}
+      def last_changed_known?
+        cache.exist?(cache_key) && cache.read(cache_key).kind_of?(Time)
+      end
+
+      # @return true if no obj has been changed since last {#guard!}
+      def no_changes_since?
+        current_last_changed <= cache.read(cache_key)
+      end
+
+      # @return [String] the cache key for storing {#current_last_changed}
+      def cache_key
+        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(RailsConnector::Obj.maximum(:last_changed))
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/never_consistent.rb

@@ -0,0 +1,19 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This is a dummy Guard, mostly for tests purposes.
+    # It ensures that the cache is never consistent
+    class NeverConsistent < ConsistencyGuard
+      def consistent?
+        false
+      end
+
+      def guard!
+        # noop
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/obj_count.rb

@@ -0,0 +1,40 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This Guard class ensures that the total count of Objs in the database
+    # does not change inbetween. (It caches the number of Objs and compares
+    # it to the current count)
+    class ObjCount < ConsistencyGuard
+      def consistent?
+        count_known? && no_changes_since?
+      end
+
+      def guard!
+        cache.write(cache_key, current_count)
+      end
+
+      # @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)
+      end
+
+      # @return true if no obj has been deleted or added since last {#guard!}
+      def no_changes_since?
+        current_count == cache.read(cache_key)
+      end
+
+      # @return [String] the cache key for storing {#current_count}
+      def cache_key
+        component.cache_key('obj_count')
+      end
+
+      # @return [Fixnum] the number of Objs in the database
+      def current_count
+        RailsConnector::Obj.count
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/valid_from.rb

@@ -0,0 +1,48 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This guard ensures that any object that becomes valid (through valid_from)
+    # will cause inconsistency
+    class ValidFrom < ConsistencyGuard
+      def consistent?
+        if min_valid_from_known?
+          return no_changes_since?
+        else
+          return current_min_valid_from.nil?
+        end
+      end
+
+      def guard!
+        cache.write(cache_key, current_min_valid_from)
+      end
+
+      # @return true if a timestamp can be read from cache with {#cache_key}
+      def min_valid_from_known?
+        cache.exist?(cache_key) && cache.read(cache_key).kind_of?(Time)
+      end
+
+      # @return true if no obj has been changed since last {#guard!}
+      def no_changes_since?
+        current_min_valid_from == cache.read(cache_key) && current_min_valid_from > Time.now
+      end
+
+      # @return [String] the cache key for storing {#current_min_valid_from}
+      def cache_key
+        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 = RailsConnector::Obj.where('valid_from > ?', Time.now.to_iso).minimum(:valid_from)
+        if str_value.present?
+          RailsConnector::DateAttribute.parse(str_value)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/valid_until.rb

@@ -0,0 +1,48 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This guard ensures that any object, whose valid until date has been passed
+    # will cause inconsistency.
+    class ValidUntil < ConsistencyGuard
+      def consistent?
+        if min_valid_until_known?
+          return no_changes_since?
+        else
+          return current_min_valid_until.nil?
+        end
+      end
+
+      def guard!
+        cache.write(cache_key, current_min_valid_until)
+      end
+
+      # @return true if a timestamp can be read from cache with {#cache_key}
+      def min_valid_until_known?
+        cache.exist?(cache_key) && cache.read(cache_key).kind_of?(Time)
+      end
+
+      # @return true if no obj has been changed since last {#guard!}
+      def no_changes_since?
+        current_min_valid_until == cache.read(cache_key) && current_min_valid_until > Time.now
+      end
+
+      # @return [String] the cache key for storing {#current_min_valid_until}
+      def cache_key
+        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 = RailsConnector::Obj.where('valid_until > ?', Time.now.to_iso).minimum(:valid_until)
+        if str_value.present?
+          RailsConnector::DateAttribute.parse(str_value)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/guards/value_present.rb

@@ -0,0 +1,20 @@
+require 'infopark_component_cache/consistency_guard'
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This Guard class ensures that the cache object
+    # for the component exists, i.e. when reading
+    # the cache with component's key one does get a value
+    class ValuePresent < ConsistencyGuard
+      def consistent?
+        cache.exist?(component.cache_key)
+      end
+
+      def guard!
+        # noop
+      end
+    end
+  end
+end

data/lib/infopark_component_cache/key_generator.rb

@@ -0,0 +1,31 @@
+require 'digest/sha2'
+
+module InfoparkComponentCache
+  module KeyGenerator
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # Generates a key identifing an Object
+    #
+    # @param [#cache_key, #to_param] anything an Object that responds to #cache_key.
+    #   It is assumed that calls to #cache_key produce consistent and deterministic
+    #   results. Futhermore for no two distinct objects should their #cache_key be equal
+    # @return [String] string that does not contain file-system insecure characters (\, / etc.)
+    def self.generate_key(anything)
+      encode_key(Rails.cache.send(:expanded_key, anything))
+    end
+
+    # Encodes a provided key yielding a string that only consists of
+    # alphanumeric characters of limited length. Underlying implementation
+    # 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,
+    #   and not to exceed 100 characters
+    def self.encode_key(string) #:nodoc:
+      Digest::SHA2.hexdigest(string)
+    end
+  end
+end

data/lib/infopark_component_cache/version.rb

@@ -0,0 +1,3 @@
+module InfoparkComponentCache
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: infopark_component_cache
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tomasz Przedmojski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: infopark_rails_connector
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Easy and intelligent fragment caching for RailsConnector projects
+email: 
+- tomasz.przedmojski@infopark.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/infopark_component_cache_helper.rb
+- infopark_component_cache.gemspec
+- lib/engine.rb
+- lib/infopark_component_cache.rb
+- lib/infopark_component_cache/cache_storage.rb
+- lib/infopark_component_cache/component.rb
+- lib/infopark_component_cache/component_cache.rb
+- lib/infopark_component_cache/consistency_guard.rb
+- lib/infopark_component_cache/guards/always_consistent.rb
+- lib/infopark_component_cache/guards/last_changed.rb
+- lib/infopark_component_cache/guards/never_consistent.rb
+- lib/infopark_component_cache/guards/obj_count.rb
+- lib/infopark_component_cache/guards/valid_from.rb
+- lib/infopark_component_cache/guards/valid_until.rb
+- lib/infopark_component_cache/guards/value_present.rb
+- lib/infopark_component_cache/key_generator.rb
+- lib/infopark_component_cache/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Fragment caching with automatic dependency resolution and cache invalidation.
+test_files: []
+