cache-machine 0.1.7 → 0.1.8

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem "rails"
+gem "activemodel"
 
 group :development do
   gem "bundler", "~> 1.0.0"

data/Gemfile.lock

@@ -93,6 +93,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activemodel
   bundler (~> 1.0.0)
   jeweler (~> 1.6.2)
   rails

data/README.rdoc

@@ -17,13 +17,13 @@ Cache Machine depends only on the Rails.cache API and is thereby library agnosti
 = Usage
 
   # Fetch cache of venues collection on model_instance.
-  @neighborhood.fetch_cache_of(:venues) { @neighborhood.venues.to_html }
+  @neighborhood.fetch_cache_of(:venues) { @neighborhood.venues }
 
   # 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 }
+  @neighborhood.fetch_cache_of(:venues, :page => 2) { @neighborhood.venues.paginate(:page => 2) }
 
 In you target model define <b>cache map</b>:
 
@@ -81,6 +81,18 @@ Suppose you need custom timestamp value.
     TwitterApi.fetch_tweets_for @lady_gaga
   end
 
+Note what timestamp declarations work in object scope. Lets take an example:
+
+  class LadyGagaPerformer < ActiveRecord::Base
+    define_timestamp (:tweets_timestamp) { tweets.last.updated_at.to_i }
+
+    has_many :tweets
+  end
+
+  class Tweet < ActiveRecord::Base
+    belongs_to :lady_gaga_performer
+  end
+
 === Using methods as timestamps
 Suppose you have your own really custom cache key.
 
@@ -112,6 +124,40 @@ Want to see collection timestamp?
   # For timestamps.
   @lady_gaga.reset_timestamp_of :events
 
+== Cache formats
+Cache Machine invalidates cache using a couple of keys with the different formats.
+Default formats are:
+- EHTML
+- HTML
+- JSON
+- XML
+
+This means you call 5 times for cache invalidation (1 time without specifying format) with different keys. Sometimes it is too much. Cache machine allows you to set your own formats. Just place in your environment config or in initializer the following:
+  CacheMachine::Cache.formats = [:doc, :pdf]
+
+Or if you do not want to use formats at all:
+  CacheMachine::Cache.formats = nil
+
+Then use:
+
+  @lady_gaga.fetch_cache_of(:new_songs, :format => :doc) { "LaLaLa".to_doc }
+  @lady_gaga.fetch_cache_of(:new_songs, :format => :pdf) { "GaGaGa".to_pdf }
+
+Cache Machine will invalidate cache for each format you specified in config.
+
+== Working with paginated content
+Suppose you installed WillPaginate gem and want to cache each page with fetched results separately.
+  class TweetsController < ApplicationController
+
+    def index
+      @tweets = @lady_gaga.fetch_cache_of(:tweets, :page => params[:page]) do
+        Tweet.all.paginate(:page => params[:page])
+      end
+    end
+  end
+
+Cache Machine will use <tt>:page</tt> as a part of cache key and will invalidate each page on any change in associated collection.
+
 == ActionView helper
 From examples above:
   <%= cache_for @lady_gaga, :updoming_events do %>

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/cache-machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cache-machine}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kevin Goslar", "Sergei Zinin"]
-  s.date = %q{2011-06-30}
+  s.authors = ["Sergei Zinin", "Kevin Goslar"]
+  s.date = %q{2011-09-11}
   s.description = %q{A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.}
   s.email = %q{kgoslar@partyearth.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
     else

data/lib/cache_machine/cache.rb

@@ -4,8 +4,16 @@ module CacheMachine
   module Cache
     extend ActiveSupport::Concern
 
-    # Supported cache formats. You can add your own.
-    FORMATS = [nil, :ehtml, :html, :json, :xml]
+    # Supported by default cache formats.
+    @formats = [nil, :ehtml, :html, :json, :xml]
+
+    def self.formats
+      @formats
+    end
+
+    def self.formats= formats
+      @formats = [nil] | [*formats]
+    end
 
     included do
       after_save    { self.class.reset_timestamps }
@@ -24,7 +32,7 @@ module CacheMachine
       #   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
+      #   acts_as_cache_machine_for :mouses => :cats, :cats => [:dogs, :bears], :dogs, :bears
       def acts_as_cache_machine_for *associations
         include CacheMachine::Cache::Map
         cache_associated(associations)
@@ -48,12 +56,12 @@ module CacheMachine
       # 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}"
+        CacheMachine::Logger.info "CACHE_MACHINE (reset_timestamp): deleting '#{cache_key}'."
         Rails.cache.delete(cache_key)
       end
 
       def reset_timestamps
-        FORMATS.each { |format| reset_timestamp format }
+        CacheMachine::Cache.formats.each { |format| reset_timestamp format }
       end
     end
   end

data/lib/cache_machine/cache/map.rb

@@ -27,7 +27,7 @@ module CacheMachine
 
           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}"
+              CacheMachine::Logger.info "CACHE_MACHINE (define_timestamp): deleting old timestamp '#{timestamp_name}'."
               delete_cache_of timestamp_name # Case when cache expired by time.
               Time.now.to_i.to_s
             end
@@ -127,6 +127,7 @@ module CacheMachine
             options[:expires_in]
           end
 
+          CacheMachine::Logger.info "CACHE_MACHINE (fetch_cache_of): reading '#{cache_key}'."
           Rails.cache.fetch(cache_key, :expires_in => expires_in, &block)
         end
 
@@ -140,10 +141,10 @@ module CacheMachine
 
         # Deletes cache of only +_member+ ignoring cache map.
         def delete_cache_of_only _member
-          CacheMachine::Cache::FORMATS.each do |cache_format|
+          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}"
+              CacheMachine::Logger.info "CACHE_MACHINE (delete_cache_of_only): deleting '#{cache_key}'"
             end while Rails.cache.delete(cache_key)
           end
           reset_timestamp_of _member
@@ -156,7 +157,9 @@ module CacheMachine
 
         # Returns timestamp of +anything+ from memcached.
         def timestamp_of anything
-          Rails.cache.fetch(timestamp_key_of anything) { Time.now.to_i.to_s }
+          key = timestamp_key_of anything
+          CacheMachine::Logger.info "CACHE_MACHINE (timestamp_of): reading timestamp '#{key}'."
+          Rails.cache.fetch(key) { Time.now.to_i.to_s }
         end
 
         # Returns cache key of +anything+ with timestamp attached.
@@ -167,7 +170,7 @@ module CacheMachine
         # 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}"
+          CacheMachine::Logger.info "CACHE_MACHINE (reset_timestamp_of): deleting '#{cache_key}'."
           Rails.cache.delete(cache_key)
         end
 

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ RSpec.configure { |config| config.mock_with :rspec }
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "db/sqlite3.test.db")
 CacheMachine::Logger.level = :info
+CacheMachine::Cache.formats = [:ehtml, :json]
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 
 Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store(:memory_store) # You can set memcached

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: cache-machine
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
-- Kevin Goslar
 - Sergei Zinin
+- Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 Z
+date: 2011-09-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -33,9 +33,23 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: activemodel
   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
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,11 +61,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,7 +77,7 @@ dependencies:
         - 2
         version: 1.6.2
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: A Ruby on Rails framework to support cache management based on explicitely modeled caching dependencies.
 email: kgoslar@partyearth.com
 executables: []