Class: Sunspot::DSL::Fields

Inherits:
Object
  • Object
show all
Defined in:
lib/sunspot/dsl/fields.rb

Overview

The Fields class provides a DSL for specifying field definitions in the Sunspot.setup block. As well as the #text method, which creates fulltext fields, uses #method_missing to allow definition of typed fields. The available methods are determined by the constants defined in Sunspot::Type - in theory (though this is untested), plugin developers should be able to add support for new types simply by creating new implementations in Sunspot::Type

Instance Method Summary collapse

Constructor Details

#initialize(setup) ⇒ Fields

:nodoc:



12
13
14
 
# File 'lib/sunspot/dsl/fields.rb', line 12

def initialize(setup) #:nodoc:
  @setup = setup
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

method_missing is used to provide access to typed fields, because developers should be able to add new Sunspot::Type implementations dynamically and have them recognized inside the Fields DSL. Like #text, these methods will create a VirtualField if a block is passed, or an AttributeField if not.

Example

Sunspot.setup(File) do
  time :mtime
end

The call to time will create a field of type Sunspot::Types::TimeType



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sunspot/dsl/fields.rb', line 44

def method_missing(method, *args, &block)
  begin
    type = Type.const_get("#{Util.camel_case(method.to_s.sub(/^dynamic_/, ''))}Type")
  rescue(NameError)
    super(method.to_sym, *args, &block) and return
  end
  name = args.shift
  if method.to_s =~ /^dynamic_/
    @setup.add_dynamic_fields(Field::DynamicField.build(name, type, *args, &block))
  else
    @setup.add_fields(Field::StaticField.build(name, type, *args, &block))
  end
end

Instance Method Details

#text(*names, &block) ⇒ Object

Add a text field. Text fields are tokenized before indexing and are the only fields searched in fulltext searches. If a block is passed, create a virtual field; otherwise create an attribute field.

Parameters

names…<Symbol>

One or more field names



24
25
26
27
28
 
# File 'lib/sunspot/dsl/fields.rb', line 24

def text(*names, &block)
  for name in names
    @setup.add_text_fields(Field::StaticField.build(name, Type::TextType, &block))
  end
end