Module: ActiveFacet

Defined in:
lib/active_facet/config.rb,
lib/active_facet.rb,
lib/active_facet/filter.rb,
lib/active_facet/helper.rb,
lib/active_facet/version.rb,
lib/active_facet/document_cache.rb,
lib/active_facet/serializer/base.rb,
lib/active_facet/serializer/facade.rb,
lib/active_facet/errors/lookup_error.rb,
lib/active_facet/acts_as_active_facet.rb,
lib/active_facet/errors/attribute_error.rb,
lib/active_facet/errors/configuration_error.rb,
lib/rails/generators/active_facet/install/install_generator.rb

Overview

Adds interface methods to resource classes

Defined Under Namespace

Modules: ActsAsActiveFacet, Errors, Generators, Serializer Classes: Config, DocumentCache, Filter, Helper

Constant Summary collapse

VERSION = 
"1.2.8"

Class Method Summary collapse

Class Method Details

.configure {|_self| ... } ⇒ Object

TODO –jdc implement dependency injection for all classes

Yields:

  • (_self)

Yield Parameters:

  • _self (ActiveFacet) —

    the object that the method was called on



54
55
56
57
 
# 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) ⇒ Object 



90
91
92
 
# File 'lib/active_facet.rb', line 90

def self.deep_copy(o)
  Marshal.load(Marshal.dump(o))
end

.fields_from_options(options) ⇒ Object 



71
72
73
 
# File 'lib/active_facet.rb', line 71

def self.fields_from_options(options)
  (options[ActiveFacet.opts_key] || {})[ActiveFacet.fields_key]
end

.global_filter(name) ⇒ Object 



59
60
61
 
# 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) ⇒ Object 



75
76
77
78
 
# 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 ⇒ Object 



63
64
65
 
# File 'lib/active_facet.rb', line 63

def self.resource_mapper
  ActiveFacet::Helper.resource_mapper = Proc.new
end

.restore_opts_after(options, key, value) ⇒ Object

TODO –jdc move the below into helper



81
82
83
84
85
86
87
88
 
# 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 ⇒ Object 



67
68
69
 
# File 'lib/active_facet.rb', line 67

def self.serializer_mapper
  ActiveFacet::Helper.serializer_mapper = Proc.new
end