Class: MusicExtras::Cache

Class

MusicExtras::Cache

In:

lib/musicextras/cache.rb

Parent:

Object

Handles caching of data

Methods

add_to_greylist clear_cachedir clear_greylist clear_webcache get_filename greylist_lock greylisted? load new remove_from_greylist save save_greylist setup_greylist

Included Modules

Debuggable

Attributes

dir	[R]	Stores the directory where the caches are stored
greylist_file	[R]

Public Class methods

dir: the directory to store cache data

Public Instance methods

add_to_greylist(key)

Adds key to greylist. Use get_filename() to generate key

clear_cachedir()

Removes entire cache dir

clear_greylist()

Removes the greylist file

clear_webcache()

Removes webcache dir

get_filename(key, include_path=true)

Returns the filename for a given key

key: The key to get the filename from
include_path: If true, will include full path to file. Defaults to true.

greylist_lock(&block)

Handles greylist locking for the given block

block: Code that needs exclusive access to the greylist

greylisted?(key)

Checks to see if a key is in the greylist

Loads data from the cache, returns the data or nil if it doesn’t exist

key: What to save the cache as. Should be a directory structure, but all non-word chars will be removed, except the /s. For example: Tom Petty/Free Fallin’ will be converted to TomPetty/FreeFallin

remove_from_greylist(key)

Remove key from greylist. Use get_filename() to generate key

save(key, data)

Saves data in the cache, returning the file it was saved as

key: What to save the cache as. Should be a directory structure, but all non-word chars will be removed, except the /s. For example: Tom Petty/Free Fallin’ will be converted to TomPetty/FreeFallin
data: The data to store

save_greylist()

Writes greylist to file

setup_greylist()

Reads the greylist from the greylist file or creates a new one