module Rack::Cache::Options

Configuration options and utility methods for option access. Rack::Cache uses the Rack Environment to store option values. All options documented below are stored in the Rack Environment as “rack-cache.<option>”, where <option> is the option name.

Public Class Methods

option_accessor(key) click to toggle source
   # File lib/rack/cache/options.rb
13 def self.option_accessor(key)
14   name = option_name(key)
15   define_method(key) { || options[name] }
16   define_method("#{key}=") { |value| options[name] = value }
17   define_method("#{key}?") { || !! options[name] }
18 end
option_name(key) click to toggle source
   # File lib/rack/cache/options.rb
20 def option_name(key)
21   case key
22   when Symbol ; "rack-cache.#{key}"
23   when String ; key
24   else raise ArgumentError
25   end
26 end

Public Instance Methods

options() click to toggle source

The underlying options Hash. During initialization (or outside of a request), this is a default values Hash. During a request, this is the Rack environment Hash. The default values Hash is merged in underneath the Rack environment before each request is processed.

    # File lib/rack/cache/options.rb
114 def options
115   @env || @default_options
116 end
options=(hash={}) click to toggle source

Set multiple options.

    # File lib/rack/cache/options.rb
119 def options=(hash={})
120   hash.each { |key,value| write_option(key, value) }
121 end
set(option, value=self, &block) click to toggle source

Set an option. When option is a Symbol, it is set in the Rack Environment as “rack-cache.option”. When option is a String, it exactly as specified. The option argument may also be a Hash in which case each key/value pair is merged into the environment as if the set method were called on each.

    # File lib/rack/cache/options.rb
128 def set(option, value=self, &block)
129   if block_given?
130     write_option option, block
131   elsif value == self
132     self.options = option.to_hash
133   else
134     write_option option, value
135   end
136 end

Private Instance Methods

initialize_options(options={}) click to toggle source
    # File lib/rack/cache/options.rb
139 def initialize_options(options={})
140   @default_options = {
141     'rack-cache.cache_key'        => Key,
142     'rack-cache.verbose'          => true,
143     'rack-cache.storage'          => Rack::Cache::Storage.instance,
144     'rack-cache.metastore'        => 'heap:/',
145     'rack-cache.entitystore'      => 'heap:/',
146     'rack-cache.default_ttl'      => 0,
147     'rack-cache.ignore_headers'   => ['Set-Cookie'],
148     'rack-cache.private_headers'  => ['Authorization', 'Cookie'],
149     'rack-cache.allow_reload'     => false,
150     'rack-cache.allow_revalidate' => false,
151     'rack-cache.use_native_ttl'   => false,
152   }
153   self.options = options
154 end
option_name(key) click to toggle source
   # File lib/rack/cache/options.rb
20 def option_name(key)
21   case key
22   when Symbol ; "rack-cache.#{key}"
23   when String ; key
24   else raise ArgumentError
25   end
26 end
read_option(key) click to toggle source
    # File lib/rack/cache/options.rb
156 def read_option(key)
157   options[option_name(key)]
158 end
write_option(key, value) click to toggle source
    # File lib/rack/cache/options.rb
160 def write_option(key, value)
161   options[option_name(key)] = value
162 end