Class: PgSearch::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/pg_search/configuration.rb,
lib/pg_search/configuration/column.rb,
lib/pg_search/configuration/association.rb,
lib/pg_search/configuration/foreign_column.rb

Defined Under Namespace

Classes: Association, Column, ForeignColumn

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, model) ⇒ Configuration

Returns a new instance of Configuration.



11
12
13
14
15
16
 
# File 'lib/pg_search/configuration.rb', line 11

def initialize(options, model)
  @options = default_options.merge(options)
  @model = model

  assert_valid_options(@options)
end

Instance Attribute Details

#model ⇒ Object (readonly)

Returns the value of attribute model.



9
10
11
 
# File 'lib/pg_search/configuration.rb', line 9

def model
  @model
end

Class Method Details

.alias(*strings) ⇒ Object 



19
20
21
22
23
 
# File 'lib/pg_search/configuration.rb', line 19

def alias(*strings)
  name = Array(strings).compact.join("_")
  # By default, PostgreSQL limits names to 32 characters, so we hash and limit to 32 characters.
  "pg_search_#{Digest::SHA2.hexdigest(name)}".first(32)
end

Instance Method Details

#associated_columns ⇒ Object 



44
 
# File 'lib/pg_search/configuration.rb', line 44

def associated_columns = associations.map(&:columns).flatten

#associations ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/pg_search/configuration.rb', line 36

def associations
  return [] unless options[:associated_against]

  options[:associated_against].map do |association, column_names|
    Association.new(model, association, column_names)
  end.flatten
end

#columns ⇒ Object 



26
 
# File 'lib/pg_search/configuration.rb', line 26

def columns = regular_columns + associated_columns

#feature_options ⇒ Object 



54
55
56
 
# File 'lib/pg_search/configuration.rb', line 54

def feature_options
  @feature_options ||= features.to_h { |name, opts| [name, opts] }
end

#features ⇒ Object 



52
 
# File 'lib/pg_search/configuration.rb', line 52

def features = Array(options[:using])

#ignore ⇒ Object 



48
 
# File 'lib/pg_search/configuration.rb', line 48

def ignore = Array(options[:ignoring])

#order_within_rank ⇒ Object 



58
 
# File 'lib/pg_search/configuration.rb', line 58

def order_within_rank = options[:order_within_rank]

#query ⇒ Object 



46
 
# File 'lib/pg_search/configuration.rb', line 46

def query = options[:query].to_s

#ranking_sql ⇒ Object 



50
 
# File 'lib/pg_search/configuration.rb', line 50

def ranking_sql = options[:ranked_by]

#regular_columns ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/pg_search/configuration.rb', line 28

def regular_columns
  return [] unless options[:against]

  Array(options[:against]).map do |column_name, weight|
    Column.new(column_name, weight, model)
  end
end