Module: ActsAsIndexed

Defined in:
lib/acts_as_indexed.rb,
lib/will_paginate_search.rb,
lib/acts_as_indexed/storage.rb,
lib/acts_as_indexed/tokenizer.rb,
lib/acts_as_indexed/search_atom.rb,
lib/acts_as_indexed/search_index.rb,
lib/acts_as_indexed/class_methods.rb,
lib/acts_as_indexed/configuration.rb,
lib/acts_as_indexed/pre_tokenizer.rb,
lib/acts_as_indexed/instance_methods.rb,
lib/acts_as_indexed/token_normalizer.rb,
lib/acts_as_indexed/singleton_methods.rb

Overview

:nodoc:

Defined Under Namespace

Modules: ClassMethods, InstanceMethods, SingletonMethods, WillPaginate Classes: Configuration, PreTokenizer, SearchAtom, SearchIndex, Storage, TokenNormalizer, Tokenizer

Constant Summary collapse

INDEX_VERSION =

This is the last version of the plugin where the index structure was changed in some manner. Is only changed when necessary, not every release.

'0.6.8'

Class Method Summary collapse

Class Method Details

.configurationObject

Returns the current configuration for acts_as_indexed.



30
31
32
# File 'lib/acts_as_indexed.rb', line 30

def self.configuration
  @configuration
end

.configure {|configuration| ... } ⇒ Object

Call this method to modify defaults in your initializers.

Example showing some defaults:

ActsAsIndexed.configure do |config|
  config.index_file = [Rails.root,'index']
  config.index_file_depth = 3
  config.min_word_size = 3
end

Yields:



43
44
45
46
# File 'lib/acts_as_indexed.rb', line 43

def self.configure
  self.configuration ||= Configuration.new
  yield(configuration)
end

.included(mod) ⇒ Object



48
49
50
# File 'lib/acts_as_indexed.rb', line 48

def self.included(mod)
  mod.extend(ClassMethods)
end