cache-machine 0.1.6c

data/.gitignore

@@ -0,0 +1,18 @@
+# test database
+db
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "rails"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+end
+
+group :test do
+  gem "rcov", ">= 0"
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem "sqlite3-ruby"
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.6.1)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.28)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rails
+  rcov
+  rspec
+  rspec-rails
+  sqlite3-ruby

data/LICENSE.txt

@@ -0,0 +1,175 @@
+Copyright (c) 2011 PartyEarth LLC
+
+                   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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,137 @@
+= cache-machine
+
+An ActiveRecord mixin that helps managing cached content in a Ruby on Rails application with complex data update dependencies.
+
+Cache Machine provides
+* high-level methods for accessing cached content using page names, numbers, time stamps etc,
+* a DSL to describe update dependencies between the data models underlying the cached content,
+* automatic cache invalidation based on those explicitly modeled data update dependencies.
+
+You will find Cache Machine useful if you:
+* use Memcache to cache fragments of a web site that contain data from a variety of underlying data models
+* anytime one of the underlying data models changes, all the cached page fragments in which this data model occurs - and only those - need to be invalidated/updated
+* you have many data models, cached fragments, and many data models used inside each cached fragment
+
+Cache Machine depends only on the Rails.cache API and is thereby library agnostic.
+
+= Usage
+
+  # Fetch cache of venues collection on model_instance.
+  @neighborhood.fetch_cache_of(:venues) { @neighborhood.venues.to_html }
+
+  # Specify format.
+  @neighborhood.fetch_cache_of(:venues, :format => :json) { @neighborhood.venues.to_json }
+
+  # Paginated content.
+  @neighborhood.fetch_cache_of(:venues, :format => :json, :page => 2) { @neighborhood.venues.to_json }
+
+In you target model define <b>cache map</b>:
+
+  acts_as_cache_machine_for :venues  => [:hotspots, :today_events],
+                            :cities  => [:venues],
+                            :streets => :hotspots,
+                            :users
+
+This example shows you how changes of one collection affect on invalidation process.
+For each record of your target model:
+- Cache for <b>users</b> collection associated with object of your target model is invalidated when changing (_add_, _remove_, _update_) the _users_ collection
+- Cache for <b>venues</b> collection associated with object of your target model is invalidated when changing the _venues_ collection associated with that object
+- Cache for <b>venues</b> collection associated with object of your target model is invalidated when changing the _cities_ collection. In this case machine automatically invalidates _hotspots_ and _today_events_
+- Cache for <b>cities</b> collection associated with object of your target model is invalidated when changing the _cities_ collection
+- Cache for <b>hotspots</b> collection is invalidated when changing the _venues_ collection
+- Cache for <b>hotspots</b> collection is invalidated when changing the _streets_ collection
+- Cache for <b>hotspots</b> collection is invalidated when changing the _cities_ collection
+- Cache for <b>today_events</b> collection is invalidated when changing the _venues_ collection
+- Cache for <b>today_events</b> collection is invalidated when changing the _cities_ collection
+<b>Cache map may contain any name, whatever you want. But invalidation process starts only when ActiveRecord collection is changed.</b>
+
+== Custom cache invalidation
+
+=== Using timestamps
+Suppose you need to reset cache of _schedule_of_events_ every day.
+
+  @lady_gaga.fetch_cache_of :schedule_of_events, :timestamp => lambda { Date.today } do
+    @lady_gaga.events.where(:date.gt => Date.today)
+  end
+
+=== Using Cache Machine timestamps
+Suppose you need to reset cache of _tweets_ every 10 minutes.
+
+  class LadyGagaPerformer < ActiveRecord::Base
+    define_timestamp :tweets_timestamp, :expires_in => 10.minutes
+  end
+
+  #...
+
+  # Somewhere
+  @lady_gaga.fetch_cache_of :tweets, :timestamp => :tweets_timestamp do
+    TwitterApi.fetch_tweets_for @lady_gaga
+  end
+
+Suppose you need custom timestamp value.
+
+  class LadyGagaPerformer < ActiveRecord::Base
+    define_timestamp(:tweets_timestamp) { Time.now.to_i + self.id }
+  end
+
+  #...
+
+  # Somewhere
+  @lady_gaga.fetch_cache_of :tweets, :timestamp => :tweets_timestamp do
+    TwitterApi.fetch_tweets_for @lady_gaga
+  end
+
+=== Using methods as timestamps
+Suppose you have your own really custom cache key.
+
+  class LadyGagaPerformer < ActiveRecord::Base
+    def my_custom_cache_key
+      rand(100) + rand(1000) + rand(10000)
+    end
+  end
+
+  #...
+
+  # Somewere
+  @lady_gaga.fetch_cache_of(:something, :timestamp => :my_custom_cache_key) { '...' }
+
+=== Using class timestamps
+Suppose you need to fetch cached content of one of your collections.
+  Rails.cache.fetch(MyModel.timestamped_key) { '...' }
+
+Want to see collection timestamp?
+  MyModel.timestamp
+
+=== Manual cache invalidation
+  # For classes.
+  MyModel.reset_timestamp
+
+  # For collections.
+  @lady_gaga.delete_cache_of :events
+
+  # For timestamps.
+  @lady_gaga.reset_timestamp_of :events
+
+== ActionView helper
+From examples above:
+  <%= cache_for @lady_gaga, :updoming_events do %>
+    <p>Don't hide yourself in regret
+       Just love yourself and you're set</p>
+  <% end %>
+<tt>cache_for</tt> method automatically sets EHTML format on cache key.
+
+== Test
+
+== Contributing to cache-machine
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 PartyEarth LLC. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+ENV['BUNDLE_GEMFILE'] = 'Gemfile'
+
+gem_root = File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'bundler'
+require 'rake'
+require 'jeweler'
+require 'rake'
+require 'rake/testtask'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cache-machine"
+  gem.homepage = "http://github.com/partyearth/cache-machine"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.}
+  gem.description = %Q{Longer description of our gem}
+  gem.email = "kgoslar@partyearth.ru"
+  gem.authors = ["Kevin Goslar"]
+  gem.files = Dir.glob('lib/**/*.rb')
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec
+
+desc "Run the test suite"
+task :spec => ['spec:setup', 'spec:lib', 'spec:cleanup']
+
+namespace :spec do
+  desc "Setup the test environment"
+  task :setup do
+    system "cd #{gem_root} && bundle install && mkdir db"
+  end
+
+  desc "Cleanup the test environment"
+  task :cleanup do
+    FileUtils.rm_rf "#{gem_root}/db"
+  end
+
+  desc "Test the Cache Machine lib"
+  RSpec::Core::RakeTask.new(:lib) do |task|
+    task.pattern = gem_root + '/spec/lib/**/*_spec.rb'
+  end
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache-machine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.6b

data/cache-machine.gemspec

@@ -0,0 +1,44 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cache-machine}
+  s.version = "0.1.6c"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Goslar"]
+  s.date = %q{2011-06-30}
+  s.description = %q{A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.}
+  s.email = %q{kgoslar@partyearth.ru}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = %q{http://github.com/partyearth/cache-machine}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+  end
+end
+

data/lib/cache-machine.rb

@@ -0,0 +1,10 @@
+#--
+# Copyright (c) 2011 {PartyEarth LLC}[http://partyearth.com]
+# mailto:kgoslar@partyearth.com
+#++
+require "cache_machine/cache"
+require "cache_machine/helpers/cache_helper"
+require "cache_machine/logger"
+require "cache_machine/railtie"
+
+ActiveRecord::Base.send :include, CacheMachine::Cache

data/lib/cache_machine/cache.rb

@@ -0,0 +1,61 @@
+require "cache_machine/cache/map"
+
+module CacheMachine
+  module Cache
+    extend ActiveSupport::Concern
+
+    # Supported cache formats. You can add your own.
+    FORMATS = [nil, :ehtml, :html, :json, :xml]
+
+    included do
+      after_save    { self.class.reset_timestamps }
+      after_destroy { self.class.reset_timestamps }
+    end
+
+    module ClassMethods
+      # Initializes tracking associations to write and reset cache.
+      # +associations+ parameter is to represent cache map with hash.
+      #
+      # ==== Examples
+      #   # Cache associated collections
+      #   acts_as_cache_machine_for :cats, :dogs
+      #
+      #   # Cache result of method to be expired when collection changes.
+      #   acts_as_cache_machine_for :cats => :cat_ids
+      #
+      #   # Cache and expire dependent collections (_mouse_ change invalidates all other collection caches by chain)
+      #   acts_as_cache_machine_for :mouses => :cats, :cats => [:gods, :bears], :gods, :bears
+      def acts_as_cache_machine_for *associations
+        include CacheMachine::Cache::Map
+        cache_associated(associations)
+      end
+
+      # Returns timestamp of class collection.
+      def timestamp format = nil
+        Rails.cache.fetch(timestamp_key format) { Time.now.to_i.to_s }
+      end
+
+      # Returns cache key to fetch timestamp from memcached.
+      def timestamp_key format = nil
+        [self.name, format, 'timestamp'].join '_'
+      end
+
+      # Returns cache key of +anything+ with timestamp attached.
+      def timestamped_key format = nil
+        [timestamp_key(format), timestamp(format)].join '_'
+      end
+
+      # Resets timestamp of class collection.
+      def reset_timestamp format = nil
+        cache_key = timestamp_key format
+        CacheMachine::Logger.info "CACHE_MACHINE: reset_timestamp: deleting #{timestamp_key} with format #{format}"
+        Rails.cache.delete(cache_key)
+      end
+
+      def reset_timestamps
+        FORMATS.each { |format| reset_timestamp format }
+      end
+    end
+  end
+end
+

data/lib/cache_machine/cache/map.rb

@@ -0,0 +1,188 @@
+module CacheMachine
+  module Cache
+
+    # Module to write and expire association cache by given map.
+    module Map
+      extend ActiveSupport::Concern
+
+      included do
+        CacheMachine::Logger.info "CACHE_MACHINE: bind cache-map on class #{self.name}"
+
+        # Stores associations map to be cached.
+        cattr_accessor :cache_map
+        self.cache_map = {}
+      end
+
+      module ClassMethods
+        # Fills cache map.
+        def cache_associated associations
+          [*associations].each do |association|
+            self.cache_map.merge! association.is_a?(Hash) ? association : {association => []}
+          end
+        end
+
+        # Defines timestamp for object.
+        def define_timestamp timestamp_name, options = {}, &block
+          options[:timestamp] = block if block
+
+          define_method timestamp_name do
+            fetch_cache_of(timestamp_key_of(timestamp_name), options) do
+              CacheMachine::Logger.info "CACHE_MACHINE: define_timestamp: deleting #{timestamp_name}"
+              delete_cache_of timestamp_name # Case when cache expired by time.
+              Time.now.to_i.to_s
+            end
+          end
+        end
+
+        # Deletes cache of collection with name +association_id+ for each object associated with +record+
+        # Called only when <tt>has_many :through</tt> collection changed.
+        def delete_association_cache_on record, reflection
+          pk = record.class.primary_key
+          self.joins(reflection.name).where(reflection.table_name => { pk => record.send(pk) }).each do |cache_source_record|
+            cache_source_record.delete_cache_of reflection.name
+          end
+        end
+
+        # Overwrites +has_many+ of +ActiveRecord+ class to hook Cache Machine.
+        def has_many(association_id, options = {})
+          # Ensure what collection should be tracked.
+          if (should_be_on_hook = self.cache_map.keys.include?(association_id)) && options[:through]
+            # If relation is _many_to_many_ track collection changes.
+            options[:after_add] = \
+            options[:before_remove] = :delete_association_cache_on
+          end
+          super
+          hook_cache_machine_on association_id if should_be_on_hook
+        end
+
+        # Overwrites +has_and_belongs_to_many+ of +ActiveRecord+ class to hook Cache Machine.
+        def has_and_belongs_to_many(association_id, options = {})
+          # Ensure what collection should be tracked.
+          if(should_be_on_hook = self.cache_map.keys.include?(association_id))
+            # If relation is _many_to_many_ track collection changes.
+            options[:after_add] = \
+            options[:before_remove] = :delete_association_cache_on
+          end
+          super
+          hook_cache_machine_on association_id if should_be_on_hook
+        end
+
+        protected
+
+          # Hooks Cache Machine on association with name +association_id+.
+          def hook_cache_machine_on association_id
+            reset_cache_proc = Proc.new do |reflection, target_class, &block|
+              block ||= lambda { target_class.delete_association_cache_on self, reflection }
+
+              reflection.klass.after_save     &block
+              reflection.klass.before_destroy &block
+            end
+
+            case (reflection = (target_class = self).reflect_on_association association_id)
+            when ActiveRecord::Reflection::ThroughReflection
+              # If association is _many_to_many_ it should reset its cache for all associated objects with class +target_class+.
+              reset_cache_proc.call(reflection, target_class)
+            when ActiveRecord::Reflection::AssociationReflection
+              if reflection.macro == :has_and_belongs_to_many
+                reset_cache_proc.call(reflection, target_class)
+              else
+                # If association is _has_many_ or _has_one_ it should reset its cache for associated object with class +target_class+.
+                reset_cache_proc.call(reflection) do
+                  target_class.where((reflection.options[:primary_key] || :id) =>
+                                 send(reflection.options[:foreign_key] || reflection.primary_key_name)).first.try(:delete_cache_of, association_id)
+                end
+              end
+            end
+          end
+      end
+
+      module InstanceMethods
+        # Returns cache key of +_member+.
+        # TODO: describe options.
+        def cache_key_of _member, options = {}
+          [self.class.name, self.to_param, _member, options[:format], options[:page] || 1].compact.join '_'
+        end
+
+        # Fetches cache of +_member+ from cache map.
+        # TODO: Describe options.
+        # TODO: Describe timestamp features (we can pass methods or fields as timestamps too).
+        #       Or we can use define_timestamp +:expires_in => 20.hours+.
+        def fetch_cache_of _member, options = {}, &block
+          cache_key = if timestamp = options[:timestamp]
+            # Make key dependent on collection timestamp and optional timestamp.
+            [timestamped_key_of(_member, options), instance_eval(&timestamp)].join '_'
+          else
+            cache_key_of(_member, options)
+          end
+
+          expires_in = if expires_at = options[:expires_at]
+            expires_at = expires_at.call if expires_at.kind_of? Proc
+
+            if expires_at.kind_of? Time
+              expires_at - Time.now
+            else
+              raise ArgumentError, "expires_at is not a Time"
+            end
+          else
+            options[:expires_in]
+          end
+
+          Rails.cache.fetch(cache_key, :expires_in => expires_in, &block)
+        end
+
+        # Recursively deletes cache by map for +_member+.
+        def delete_cache_of _member
+          delete_cache_of_only _member
+          if chain = self.class.cache_map[_member]
+            [*chain].each &method(:delete_cache_of)
+          end
+        end
+
+        # Deletes cache of only +_member+ ignoring cache map.
+        def delete_cache_of_only _member
+          CacheMachine::Cache::FORMATS.each do |cache_format|
+            page_nr = 0; begin
+              cache_key = cache_key_of(_member, {:format => cache_format, :page => page_nr += 1})
+              CacheMachine::Logger.info "CACHE_MACHINE: delete_cache_of_only: deleting #{cache_key}"
+            end while Rails.cache.delete(cache_key)
+          end
+          reset_timestamp_of _member
+        end
+
+        # Returns timestamp cache key for +anything+.
+        def timestamp_key_of anything
+          [self.class.name, self.to_param, anything, 'timestamp'].join '_'
+        end
+
+        # Returns timestamp of +anything+ from memcached.
+        def timestamp_of anything
+          Rails.cache.fetch(timestamp_key_of anything) { Time.now.to_i.to_s }
+        end
+
+        # Returns cache key of +anything+ with timestamp attached.
+        def timestamped_key_of anything, options = {}
+          [cache_key_of(anything, options), timestamp_of(anything)].join '_'
+        end
+
+        # Deletes cache of +anything+ from memory.
+        def reset_timestamp_of anything
+          cache_key = timestamp_key_of anything
+          CacheMachine::Logger.info "CACHE_MACHINE: reset_timestamp_of: deleting #{cache_key}"
+          Rails.cache.delete(cache_key)
+        end
+
+        protected
+
+          # Deletes cache of associated collection what contains +record+.
+          # Called only when <tt>has_many :through</tt> collection changed.
+          def delete_association_cache_on record
+            # Find all associations with +record+ by its class.
+            associations = self.class.reflect_on_all_associations.find_all { |association| association.klass == record.class }
+
+            # Delete cache of each associated collection what may contain +record+.
+            associations.map(&:name).each &method(:delete_cache_of)
+          end
+      end
+    end
+  end
+end

data/lib/cache_machine/helpers.rb

@@ -0,0 +1,5 @@
+module CacheMachine
+  module Helpers
+    autoload :CacheHelper, 'cache_machine/helpers/cache_helper'
+  end
+end

data/lib/cache_machine/helpers/cache_helper.rb

@@ -0,0 +1,9 @@
+module CacheMachine
+  module Helpers
+    module CacheHelper
+      def cache_for record, cacheable, options = {}, &block
+        record.fetch_cache_of(cacheable, options.merge(:format => :ehtml)) { capture &block }
+      end
+    end
+  end
+end

data/lib/cache_machine/logger.rb

@@ -0,0 +1,31 @@
+module CacheMachine
+  class Logger
+
+    # The different log levels.
+    LOGGING_LEVELS = { :debug  => 0,   # Tons of log messages for tracking internal functioning of cache-machine.
+                       :info   => 1,   # Log messages that visualize how cache-machine works.
+                       :errors => 2,   # Only error messages.
+                       :none   => 10 } # No output at all.
+
+    # The default log level.
+    @@level = LOGGING_LEVELS[:none]
+
+    class << self
+      LOGGING_LEVELS.keys.each do |level|
+        define_method(level) { |message| write level, message }
+      end
+
+      # Sets the log level for CacheMachine.
+      # Call like this in your your code, best in development.rb: ActiveRecord::CacheMachine::Logger.level = :info
+      def level= value
+        @@level = LOGGING_LEVELS[value] or raise "CACHE_MACHINE: Unknown log level: '#{value}'."
+        puts "CACHE_MACHINE: Setting log level to '#{value}'."
+      end
+
+      # Logs the given entry with the given log level.
+      def write level, text
+        puts text if @@level <= (LOGGING_LEVELS[level] or raise "CACHE_MACHINE: Unknown log level: '#{level}'.")
+      end
+    end
+  end
+end

data/lib/cache_machine/railtie.rb

@@ -0,0 +1,9 @@
+module CacheMachine
+  class Railtie < Rails::Railtie
+    initializer 'cache-machine.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include CacheMachine::Helpers::CacheHelper
+      end
+    end
+  end
+end

data/spec/lib/cache_machine_spec.rb

@@ -0,0 +1,248 @@
+require 'spec_helper'
+
+describe CacheMachine do
+  TARGET_TABLE_NAME = "cachers"
+  HABTM_TABLE_NAME = "has_and_belongs_to_many_cacheables"
+  HABTM_JOINS_TABLE_NAME = [TARGET_TABLE_NAME, HABTM_TABLE_NAME].join('_')
+  HABTM_ASSOCIATION_NAME = HABTM_TABLE_NAME.singularize
+  HM_TABLE_NAME = "has_many_cacheables"
+  HMT_JOINS_TABLE_NAME = "joins"
+  HMT_TABLE_NAME = "has_many_through_cacheables"
+  HO_TABLE_NAME = "hs_one_cacheables"
+  POLY_TABLE_NAME = "polymorphics"
+  TARGET_ASSOCIATION_NAME = TARGET_TABLE_NAME.singularize
+  HMT_ASSOCIATION_NAME = HMT_TABLE_NAME.singularize
+
+  class TestMigration < ActiveRecord::Migration
+    def self.up
+      self.down
+      create_table(HABTM_TABLE_NAME)
+      create_table(HM_TABLE_NAME) { |t| t.references TARGET_ASSOCIATION_NAME }
+      create_table(HMT_TABLE_NAME)
+      create_table(HMT_JOINS_TABLE_NAME) { |t| [TARGET_ASSOCIATION_NAME, HMT_ASSOCIATION_NAME].each &t.method(:references) }
+      create_table(POLY_TABLE_NAME) { |t| t.references(:polymorhicable); t.string(:polymorhicable_type) }
+      create_table(TARGET_TABLE_NAME) { |t| t.string :name; t.integer(:parent_id) }
+      create_table(HABTM_JOINS_TABLE_NAME, :id => false) { |t| [TARGET_ASSOCIATION_NAME, HABTM_ASSOCIATION_NAME].each &t.method(:references) }
+    end
+
+    def self.down
+      drop_table POLY_TABLE_NAME if ActiveRecord::Base.connection.tables.include? POLY_TABLE_NAME
+      drop_table TARGET_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(TARGET_TABLE_NAME)
+      drop_table HABTM_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HABTM_TABLE_NAME)
+      drop_table HM_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HM_TABLE_NAME)
+      drop_table HMT_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HMT_TABLE_NAME)
+      drop_table HO_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HO_TABLE_NAME)
+      drop_table HMT_JOINS_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HMT_JOINS_TABLE_NAME)
+      drop_table HABTM_JOINS_TABLE_NAME if ActiveRecord::Base.connection.tables.include?(HABTM_JOINS_TABLE_NAME)
+    end
+  end
+  TestMigration.up
+
+  class HasManyCacheable < ActiveRecord::Base
+    set_table_name HM_TABLE_NAME
+    belongs_to :cacher, :class_name => 'Cacher'
+  end
+
+  class HasManyThroughCacheable < ActiveRecord::Base
+    set_table_name HMT_TABLE_NAME
+
+    has_many :joins, :class_name => 'Join'
+    has_many :cachers, :through => :joins, :class_name => 'Cacher'
+  end
+
+  class Join < ActiveRecord::Base
+    set_table_name HMT_JOINS_TABLE_NAME
+
+    belongs_to :cacher, :class_name => 'Cacher'
+    belongs_to :has_many_through_cacheable, :class_name => 'HasManyThroughCacheable'
+  end
+
+  class HasAndBelongsToManyCacheable < ActiveRecord::Base
+    set_table_name HABTM_TABLE_NAME
+    has_and_belongs_to_many :cachers, :class_name => 'Cacher'
+  end
+
+  class Polymorphic < ActiveRecord::Base
+    set_table_name POLY_TABLE_NAME
+    belongs_to :polymorhicable, :polymorphic => true
+  end
+
+  class Cacher < ActiveRecord::Base
+    set_table_name TARGET_TABLE_NAME
+
+    acts_as_cache_machine_for :polymorphics,
+                              :child_cachers,
+                              :has_many_cacheables => :dependent_cache,
+                              :has_many_through_cacheables => :dependent_cache,
+                              :has_and_belongs_to_many_cacheables => :dependent_cache
+
+    define_timestamp(:dynamic_timestamp) { execute_timestamp }
+    define_timestamp(:static_timestamp)
+
+    has_and_belongs_to_many :has_and_belongs_to_many_cacheables, :class_name => 'HasAndBelongsToManyCacheable'
+    has_many :has_many_cacheables, :class_name => 'HasManyCacheable'
+    has_many :joins, :class_name => 'Join'
+    has_many :has_many_through_cacheables, :through => :joins, :class_name => 'HasManyThroughCacheable'
+    has_many :polymorphics, :as => :polymorhicable
+    has_many :child_cachers, :class_name => 'Cacher', :foreign_key => 'parent_id', :primary_key => 'id'
+
+    def to_param; name end
+  end
+
+  subject { Cacher.create(:name => 'foo') }
+
+  it "generates association cache keys" do
+    subject.cache_key_of(:has_many_cacheables, :format => :ehtml).should eql("Cacher_foo_has_many_cacheables_ehtml_1")
+  end
+
+  it "stores association cache" do
+    subject.fetch_cache_of(:has_many_cacheables) { 'cache' }
+    cached_result = subject.fetch_cache_of(:has_many_cacheables) { 'fresh cache' }
+    cached_result.should eql('cache')
+  end
+
+  describe "defines timestamp" do
+
+    context "dynamic" do
+      it "works" do
+        subject.stub!(:execute_timestamp).and_return(1)
+        subject.fetch_cache_of(:something, :timestamp => :dynamic_timestamp) { "cache" }
+        sleep(2)
+        subject.fetch_cache_of(:something, :timestamp => :dynamic_timestamp) { "foo" }.should eql("cache")
+        subject.stub!(:execute_timestamp).and_return(2)
+        sleep(2)
+        subject.fetch_cache_of(:something, :timestamp => :dynamic_timestamp) { "fresh cache" }.should eql("fresh cache")
+      end
+    end
+
+    context "static" do
+      it "works" do
+        sleep(2)
+        subject.fetch_cache_of(:something, :timestamp => :static_timestamp) { "cache" }
+        sleep(2)
+        subject.fetch_cache_of(:something, :timestamp => :static_timestamp) { "foo" }.should eql("cache")
+      end
+    end
+  end
+
+  describe "deletes cache" do
+
+    context "of polymorphic associations" do
+      it "works" do
+        cached_result = subject.fetch_cache_of(:polymorphics) { 'cache' }
+        subject.polymorphics.create
+        cached_result = subject.fetch_cache_of(:polymorphics) { 'new cache' }
+
+        cached_result.should eql('new cache')
+      end
+    end
+
+    context "of paginated content" do
+      before :each do
+        subject.delete_cache_of :has_many_cacheables
+      end
+
+      it "works" do
+        subject.fetch_cache_of(:has_many_cacheables, :page => 1) { 'page 1' }.should eql('page 1')
+        subject.fetch_cache_of(:has_many_cacheables, :page => 2) { 'page 2' }.should eql('page 2')
+        subject.delete_cache_of(:has_many_cacheables)
+        subject.fetch_cache_of(:has_many_cacheables, :page => 1) { 'fresh page 1' }.should eql('fresh page 1')
+        subject.fetch_cache_of(:has_many_cacheables, :page => 2) { 'fresh page 2' }.should eql('fresh page 2')
+      end
+    end
+
+    context "of self-join association" do
+      it "works" do
+        subject.fetch_cache_of(:child_cachers) { 'cache' }
+        child = Cacher.create(:parent_id => subject.id)
+        cached_result = subject.fetch_cache_of(:child_cachers) { 'new cache' }
+
+        cached_result.should eql('new cache')
+      end
+    end
+
+    context "of any member on has_many" do
+      before :each do
+        @existing_entry = subject.has_many_cacheables.create
+        @new_entry = HasManyCacheable.create
+        subject.fetch_cache_of(:has_many_cacheables) { 'cache' }
+      end
+
+      after :each do
+        cached_result = subject.fetch_cache_of(:has_many_cacheables) { 'fresh cache' }
+        cached_result.should eql('fresh cache')
+        subject.delete_cache_of(:has_many_cacheables)
+      end
+
+      it("works") { subject.delete_cache_of(:has_many_cacheables) }
+      it("on update entry in collection") { @existing_entry.save }
+      it("on add new entry in collection") { subject.has_many_cacheables << @new_entry }
+      it("on destroy intem in collection") { subject.has_many_cacheables.destroy @existing_entry }
+      it("on destroy intem") { HasManyCacheable.destroy @existing_entry }
+
+      context "by chain" do
+        it "works" do
+          subject.fetch_cache_of(:dependent_cache) { 'cache' }
+          subject.has_many_cacheables.create
+          subject.fetch_cache_of(:dependent_cache) { 'fresh cache' }.should eql('fresh cache')
+        end
+      end
+    end
+
+    context "of any member on has_many :through" do
+      before :each do
+        @existing_entry = subject.has_many_through_cacheables.create
+        @new_entry = HasManyThroughCacheable.create
+        subject.fetch_cache_of(:has_many_through_cacheables) { 'cache' }
+      end
+
+      after :each do
+        cached_result = subject.fetch_cache_of(:has_many_through_cacheables) { 'fresh cache' }
+        cached_result.should eql('fresh cache')
+        subject.delete_cache_of(:has_many_through_cacheables)
+      end
+
+      it("works") { subject.delete_cache_of(:has_many_through_cacheables) }
+      it("on update entry in collection") { @existing_entry.save }
+      it("on add new entry in collection") { subject.has_many_through_cacheables << @new_entry }
+      it("on destroy intem in collection") { subject.has_many_through_cacheables.destroy @existing_entry }
+      it("on destroy intem") { HasManyThroughCacheable.destroy @existing_entry }
+
+      context "by chain" do
+        it "works" do
+          subject.fetch_cache_of(:dependent_cache) { 'cache' }
+          subject.has_many_through_cacheables.create
+          subject.fetch_cache_of(:dependent_cache) { 'fresh cache' }.should eql('fresh cache')
+        end
+      end
+    end
+
+    context "of any member on has_and_belongs_to_many" do
+      before :each do
+        @existing_entry = subject.has_and_belongs_to_many_cacheables.create
+        @new_entry = HasAndBelongsToManyCacheable.create
+        subject.fetch_cache_of(:has_and_belongs_to_many_cacheables) { 'cache' }
+      end
+
+      after :each do
+        cached_result = subject.fetch_cache_of(:has_and_belongs_to_many_cacheables) { 'fresh cache' }
+        cached_result.should eql('fresh cache')
+        subject.delete_cache_of(:has_and_belongs_to_many_cacheables)
+      end
+
+      it("works") { subject.delete_cache_of(:has_and_belongs_to_many_cacheables) }
+      it("on update entry in collection") { @existing_entry.save }
+      it("on add new entry in collection") { subject.has_and_belongs_to_many_cacheables << @new_entry }
+      it("on destroy intem in collection") { subject.has_and_belongs_to_many_cacheables.destroy @existing_entry }
+      it("on destroy intem") { HasAndBelongsToManyCacheable.destroy @existing_entry }
+
+      context "by chain" do
+        it "works" do
+          subject.fetch_cache_of(:dependent_cache) { 'cache' }
+          subject.has_and_belongs_to_many_cacheables.create
+          subject.fetch_cache_of(:dependent_cache) { 'fresh cache' }.should eql('fresh cache')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "active_record"
+require "rails"
+require "logger"
+require "rspec"
+require "rspec-rails"
+require "cache-machine"
+
+RSpec.configure { |config| config.mock_with :rspec }
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "db/sqlite3.test.db")
+CacheMachine::Logger.level = :info
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(:memory_store) # You can set memcached

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: cache-machine
+version: !ruby/object:Gem::Version 
+  hash: 56
+  prerelease: 5
+  segments: 
+  - 0
+  - 1
+  - 6
+  - c
+  version: 0.1.6c
+platform: ruby
+authors: 
+- Kevin Goslar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-30 00:00:00 Z
+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: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :development
+  version_requirements: *id003
+description: A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.
+email: kgoslar@partyearth.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- cache-machine.gemspec
+- lib/cache-machine.rb
+- lib/cache_machine/cache.rb
+- lib/cache_machine/cache/map.rb
+- lib/cache_machine/helpers.rb
+- lib/cache_machine/helpers/cache_helper.rb
+- lib/cache_machine/logger.rb
+- lib/cache_machine/railtie.rb
+- spec/lib/cache_machine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/partyearth/cache-machine
+licenses: 
+- MIT
+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.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.
+test_files: []
+