Contents

#          Copyright (c) 2006 Michael Fellinger [e-mail]
# All files in this distribution are subject to the terms of the Ruby license.

module Ramaze

  # This helper is providing easy access to a couple of Caches to use for
  # smaller amounts of data.

  module CacheHelper
    def self.included(klass)
      Cache.add(:value_cache) unless Cache::CACHES.has_key?(:value_cache)
    end

    private

    # use this to cache values in your controller and templates,
    # for example heavy calculations or time-consuming queries.

    def value_cache
      Cache.value_cache
    end

    # holds the values returned on the first call to a cached action.
    # To uncache, simply delete.
    #
    # Please note that the action is cached by a combination of
    # [action, parameter].inspect - so it is a bit awkward to use.
    #
    # Suggestions welcome.
    #
    # Example:
    #
    #   action_cache.delete '["index", []]'
    #
    # or by delete_if
    #
    #   action_cache.delete_if{|key, value| key =~ /"index",/}

    def action_cache
      Cache.actions
    end

    # This refers to the class-trait of cached actions, you can
    # add/remove actions to be cached.
    #
    # Example:
    #
    #   class FooController < Ramaze::Controller
    #     trait :actions_cached => [:index, :map_of_the_internet]
    #   end

    def actions_cached
      ancestral_trait[:actions_cached]
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ramaze-0.1.1	lib/ramaze/helper/cache.rb
ramaze-0.1.2	lib/ramaze/helper/cache.rb
ramaze-0.1.3	lib/ramaze/helper/cache.rb