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 



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

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

#associations ⇒ Object 



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

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
27
28
 
# File 'lib/pg_search/configuration.rb', line 26

def columns
  regular_columns + associated_columns
end

#feature_options ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/pg_search/configuration.rb', line 66

def feature_options
  @feature_options ||= {}.tap do |hash|
    features.map do |feature_name, feature_options|
      hash[feature_name] = feature_options
    end
  end
end

#features ⇒ Object 



62
63
64
 
# File 'lib/pg_search/configuration.rb', line 62

def features
  Array(options[:using])
end

#ignore ⇒ Object 



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

def ignore
  Array(options[:ignoring])
end

#order_within_rank ⇒ Object 



74
75
76
 
# File 'lib/pg_search/configuration.rb', line 74

def order_within_rank
  options[:order_within_rank]
end

#query ⇒ Object 



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

def query
  options[:query].to_s
end

#ranking_sql ⇒ Object 



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

def ranking_sql
  options[:ranked_by]
end

#regular_columns ⇒ Object 



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

def regular_columns
  return [] unless options[:against]

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