module Tennpipes::Cache
This component enables caching of an application's response contents on both page- and fragment-levels. Output cached in this manner is persisted, until it expires or is actively expired, in a configurable store of your choosing. Several common caching stores are supported out of the box.
Public Class Methods
included(base)
click to toggle source
# File lib/tennpipes-memory.rb, line 108 def included(base) base.extend Tennpipes::Cache::Helpers::Page::ClassMethods end
new(name, options = {})
click to toggle source
# File lib/tennpipes-memory.rb, line 117 def self.new(name, options = {}) # Activate expiration by default options[:expires] = true unless options.include?(:expires) Moneta.new(name, options) end
registered(app)
click to toggle source
Register these helpers:
Tennpipes::Cache::Helpers::ObjectCache Tennpipes::Cache::Helpers::CacheStore Tennpipes::Cache::Helpers::Fragment Tennpipes::Cache::Helpers::Page
for Tennpipes::Application.
By default we use FileStore as showed below:
set :cache, Tennpipes::Cache.new(:File, :dir => Tennpipes.root('tmp', app_name.to_s, 'cache'))
However, you can also change the file store easily in your app.rb:
set :cache, Tennpipes::Cache.new(:LRUHash) # Keeps cached values in memory set :cache, Tennpipes::Cache.new(:Memcached) # Uses default server at localhost set :cache, Tennpipes::Cache.new(:Memcached, '127.0.0.1:11211', :exception_retry_limit => 1) set :cache, Tennpipes::Cache.new(:Memcached, :backend => memcached_or_dalli_instance) set :cache, Tennpipes::Cache.new(:Redis) # Uses default server at localhost set :cache, Tennpipes::Cache.new(:Redis, :host => '127.0.0.1', :port => 6379, :db => 0) set :cache, Tennpipes::Cache.new(:Redis, :backend => redis_instance) set :cache, Tennpipes::Cache.new(:Mongo) # Uses default server at localhost set :cache, Tennpipes::Cache.new(:Mongo, :backend => mongo_client_instance) set :cache, Tennpipes::Cache.new(:File, :dir => Tennpipes.root('tmp', app_name.to_s, 'cache')) # default choice
You can manage your cache from anywhere in your app:
MyApp.cache['val'] = 'test' MyApp.cache['val'] # => 'test' MyApp.cache.delete('val') MyApp.cache.clear
# File lib/tennpipes-memory.rb, line 95 def registered(app) app.helpers Tennpipes::Cache::Helpers::ObjectCache app.helpers Tennpipes::Cache::Helpers::CacheStore app.helpers Tennpipes::Cache::Helpers::Fragment app.helpers Tennpipes::Cache::Helpers::Page unless app.respond_to?(:cache) cache_dir = Tennpipes.root('tmp', defined?(app.app_name) ? app.app_name.to_s : '', 'cache') app.set :cache, Tennpipes::Cache.new(:File, :dir => cache_dir) end app.disable :caching unless app.respond_to?(:caching) included(app) end
tennpipes_route_added(route, verb, path, args, options, block)
click to toggle source
# File lib/tennpipes-memory.rb, line 112 def tennpipes_route_added(route, verb, path, args, options, block) Tennpipes::Cache::Helpers::Page.tennpipes_route_added(route, verb, path, args, options, block) end