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, line 13
def self.option_accessor(key)
  name = option_name(key)
  define_method(key) { || options[name] }
  define_method("#{key}=") { |value| options[name] = value }
  define_method("#{key}?") { || !! options[name] }
end
option_name(key) click to toggle source
# File lib/rack/cache/options.rb, line 20
def option_name(key)
  case key
  when Symbol ; "rack-cache.#{key}"
  when String ; key
  else raise ArgumentError
  end
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, line 114
def options
  @env || @default_options
end
options=(hash={}) click to toggle source

Set multiple options.

# File lib/rack/cache/options.rb, line 119
def options=(hash={})
  hash.each { |key,value| write_option(key, value) }
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, line 128
def set(option, value=self, &block)
  if block_given?
    write_option option, block
  elsif value == self
    self.options = option.to_hash
  else
    write_option option, value
  end
end

Private Instance Methods

initialize_options(options={}) click to toggle source
# File lib/rack/cache/options.rb, line 139
def initialize_options(options={})
  @default_options = {
    'rack-cache.cache_key'        => Key,
    'rack-cache.verbose'          => true,
    'rack-cache.storage'          => Rack::Cache::Storage.instance,
    'rack-cache.metastore'        => 'heap:/',
    'rack-cache.entitystore'      => 'heap:/',
    'rack-cache.default_ttl'      => 0,
    'rack-cache.ignore_headers'   => ['Set-Cookie'],
    'rack-cache.private_headers'  => ['Authorization', 'Cookie'],
    'rack-cache.allow_reload'     => false,
    'rack-cache.allow_revalidate' => false,
    'rack-cache.use_native_ttl'   => false,
  }
  self.options = options
end
option_name(key) click to toggle source
# File lib/rack/cache/options.rb, line 20
def option_name(key)
  case key
  when Symbol ; "rack-cache.#{key}"
  when String ; key
  else raise ArgumentError
  end
end
read_option(key) click to toggle source
# File lib/rack/cache/options.rb, line 156
def read_option(key)
  options[option_name(key)]
end
write_option(key, value) click to toggle source
# File lib/rack/cache/options.rb, line 160
def write_option(key, value)
  options[option_name(key)] = value
end