Class: ActsAsFerret::AbstractIndex

Inherits:
Object
  • Object
show all
Includes:
FerretFindMethods
Defined in:
lib/acts_as_ferret/index.rb

Overview

base class for local and remote indexes

Direct Known Subclasses

LocalIndex, RemoteIndex

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FerretFindMethods

#ar_find, #count_records, #find_id_model_arrays, #find_ids, #find_records, #lazy_find, #scope_query_to_models

Constructor Details

#initialize(index_definition) ⇒ AbstractIndex

Returns a new instance of AbstractIndex.



24
25
26
27
28
29
 
# File 'lib/acts_as_ferret/index.rb', line 24

def initialize(index_definition)
  @index_definition = index_definition
  @registered_models_config = {}
  @index_name = index_definition[:name]
  @logger = IndexLogger.new(ActsAsFerret::logger, @index_name)
end

Instance Attribute Details

#index_definition ⇒ Object (readonly)

Returns the value of attribute index_definition.



23
24
25
 
# File 'lib/acts_as_ferret/index.rb', line 23

def index_definition
  @index_definition
end

#index_name ⇒ Object (readonly)

Returns the value of attribute index_name.



23
24
25
 
# File 'lib/acts_as_ferret/index.rb', line 23

def index_name
  @index_name
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



23
24
25
 
# File 'lib/acts_as_ferret/index.rb', line 23

def logger
  @logger
end

#registered_models_config ⇒ Object (readonly)

Returns the value of attribute registered_models_config.



23
24
25
 
# File 'lib/acts_as_ferret/index.rb', line 23

def registered_models_config
  @registered_models_config
end

Instance Method Details

#change_index_dir(new_dir) ⇒ Object

Switches the index to a new index directory. Used by the DRb server when switching to a new index version.



88
89
90
91
92
93
 
# File 'lib/acts_as_ferret/index.rb', line 88

def change_index_dir(new_dir)
  logger.debug "[#{index_name}] changing index dir to #{new_dir}"
  index_definition[:index_dir] = index_definition[:ferret][:path] = new_dir
  reopen!
  logger.debug "[#{index_name}] index dir is now #{new_dir}"
end

#register_class(clazz, options = {}) ⇒ Object

TODO allow for per-class field configuration (i.e. different via, boosts for the same field among different models)



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/acts_as_ferret/index.rb', line 33

def register_class(clazz, options = {})
  logger.info "register class #{clazz} with index #{index_name}"

  if force = options.delete(:force_re_registration)
    index_definition[:registered_models].delete(clazz)
  end

  if index_definition[:registered_models].map(&:name).include?(clazz.name)
    logger.info("refusing re-registration of class #{clazz}")
  else
    index_definition[:registered_models] << clazz
    @registered_models_config[clazz] = options

    # merge fields from this acts_as_ferret call with predefined fields
    already_defined_fields = index_definition[:ferret_fields]
    field_config = ActsAsFerret::build_field_config options[:fields]
    field_config.update ActsAsFerret::build_field_config( options[:additional_fields] )
    field_config.each do |field, config|
      if already_defined_fields.has_key?(field)
        logger.info "ignoring redefinition of ferret field #{field}" if shared? 
      else
        already_defined_fields[field] = config
        logger.info "adding new field #{field} from class #{clazz.name} to index #{index_name}"
      end
    end

    # update default field list to be used by the query parser, unless it 
    # was explicitly given by user.
    #
    # It will include all content fields *not* marked as :untokenized.
    # This fixes the otherwise failing CommentTest#test_stopwords. Basically
    # this means that by default only tokenized fields (which all fields are
    # by default) will be searched. If you want to search inside the contents 
    # of an untokenized field, you'll have to explicitly specify it in your 
    # query.
    unless index_definition[:user_default_field]
      # grab all tokenized fields
      ferret_fields = index_definition[:ferret_fields]
      index_definition[:ferret][:default_field] = ferret_fields.keys.select do |field|
        ferret_fields[field][:index] != :untokenized
      end
      logger.info "default field list for index #{index_name}: #{index_definition[:ferret][:default_field].inspect}"
    end
  end

  return index_definition
end

#shared? ⇒ Boolean

true if this index is used by more than one model class

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/acts_as_ferret/index.rb', line 82

def shared?
  index_definition[:registered_models].size > 1
end