Module: Opulent::Filters

Defined in:

lib/opulent/filters.rb

Defined Under Namespace

Classes: CData, CoffeeScript, Css, Escaped, Filter, JavaScript, Markdown, Maruku, RedCloth, Sass, Scss

Class Attribute Summary

• .filters ⇒ Object

  Returns the value of attribute filters.

Class Method Summary

• .filter?(name) ⇒ Boolean

  Check if the chosen filter name is registed within our knowledgebase.

• .register(klass, name, options) ⇒ Object

  Add a new Opulent filter to the filters knowledgebase.

Class Attribute Details

.filters ⇒ Object

Returns the value of attribute filters.

# File 'lib/opulent/filters.rb', line 7

def filters
  @filters
end

Class Method Details

.filter?(name) ⇒ Boolean

Check if the chosen filter name is registed within our knowledgebase

Returns:

• (Boolean)

# File 'lib/opulent/filters.rb', line 22

def filter?(name)
  @filters.key? name
end

.register(klass, name, options) ⇒ Object

Add a new Opulent filter to the filters knowledgebase

Parameters:

• class (Class) —

  Class to be used for filter instance

• name (Symbol) —

  Identifier in the filters hash

• options (Hash) —

  Filter engine instance options

# File 'lib/opulent/filters.rb', line 15

def register(klass, name, options)
  @filters ||= {}
  @filters[name] = klass.new name, options
end