module ActiveFacet

Adds interface methods to resource classes

Field Set Alias = Symbol representing a Field Set

A really dump cache interface that caches everything when enabled. Extend and conditionally cache documents.

Maps filters to resource classes without adding methods to the resource classes directly

Implements varius methods that bind serializers and resources together

TODO –jdc rebuild this class to either use an explicit singleton pattern or use a factory pattern

Mixin providing DSL for ActiveFacet Serializers and a handful of public methods which reflect on the DSL

Serializes Facets of a given resource using an ActiveFacet::Serializer::Base serializer

Constants

VERSION

Public Class Methods

configure() { |self| ... } click to toggle source

TODO –jdc implement dependency injection for all classes

# File lib/active_facet.rb, line 54
def self.configure
  yield(self)
  ActiveRecord::Base.acts_as_active_facet if ActiveFacet.acts_as_active_facet_enabled
end

deep_copy(o) click to toggle source

# File lib/active_facet.rb, line 90
def self.deep_copy(o)
  Marshal.load(Marshal.dump(o))
end

fields_from_options(options) click to toggle source

# File lib/active_facet.rb, line 71
def self.fields_from_options(options)
  (options[ActiveFacet.opts_key] || {})[ActiveFacet.fields_key]
end

global_filter(name) click to toggle source

# File lib/active_facet.rb, line 59
def self.global_filter(name)
  ActiveFacet::Filter.register_global(name, Proc.new)
end

options_with_fields(options, fields) click to toggle source

# File lib/active_facet.rb, line 75
def self.options_with_fields(options, fields)
  (options[ActiveFacet.opts_key] ||= {})[ActiveFacet.fields_key] = fields
  options
end

resource_mapper() click to toggle source

# File lib/active_facet.rb, line 63
def self.resource_mapper
  ActiveFacet::Helper.resource_mapper = Proc.new
end

restore_opts_after(options, key, value) { || ... } click to toggle source

TODO –jdc move the below into helper

# File lib/active_facet.rb, line 81
def self.restore_opts_after(options, key, value)
  opts = (options[ActiveFacet.opts_key] ||= {})
  old = opts[key]
  opts[key] = value
  yield
ensure
  opts[key] = old
end

serializer_mapper() click to toggle source

# File lib/active_facet.rb, line 67
def self.serializer_mapper
  ActiveFacet::Helper.serializer_mapper = Proc.new
end