Module: PgFulltext::ActiveRecord::ClassMethods

Defined in:
lib/pg_fulltext/active_record.rb

Instance Method Summary collapse

Instance Method Details

#add_search_scope(name = :search, **options) ⇒ Object

Class method to add a scope to the class, searching against ‘tsv` column by default



12
13
14
15
16
 
# File 'lib/pg_fulltext/active_record.rb', line 12

def add_search_scope(name = :search, **options)
  self.scope name, -> (query) {
    apply_search_to_relation(self, query, **options)
  }
end

#apply_search_to_relation(relation, query, tsvector_column: :tsv, search_type: :simple, order: true, prefix: true, reorder: false, ignore_accents: false) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/pg_fulltext/active_record.rb', line 18

def apply_search_to_relation(
  relation,
  query,
  tsvector_column: :tsv,
  search_type: :simple,
  order: true,
  prefix: true,
  reorder: false,
  ignore_accents: false
)
  serial = SecureRandom.hex(4)
  pk_quoted = "#{quoted_table_name}.#{connection.quote_column_name(primary_key)}"
  fulltext_join_name = "pg_fulltext_#{serial}"

  # Build the search relation to join on
  search_relation = get_search_relation(
    relation,
    query,
    tsvector_column: tsvector_column,
    search_type: search_type,
    prefix: prefix,
    ignore_accents: ignore_accents,
  )

  # Join the search relation
  relation = relation.joins("INNER JOIN (#{search_relation.to_sql}) AS #{fulltext_join_name} ON #{fulltext_join_name}.id = #{pk_quoted}")

  # Order/reorder against the search rank
  if order || reorder
    relation = relation.send(reorder ? :reorder : :order, "#{fulltext_join_name}.rank DESC")
  end

  # Return the model relation
  relation
end

#get_search_relation(relation, query, tsvector_column: :tsv, search_type: nil, prefix: true, ignore_accents: false) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/pg_fulltext/active_record.rb', line 54

def get_search_relation(
  relation,
  query,
  tsvector_column: :tsv,
  search_type: nil,
  prefix: true,
  ignore_accents: false
)
  tsquery_string_quoted = connection.quote(query)
  tsquery_string_quoted = "unaccent(#{tsquery_string_quoted})" if ignore_accents
  column_quoted = connection.quote_column_name(tsvector_column)
  fqc_quoted = "#{quoted_table_name}.#{column_quoted}"
  tsquery = "websearch_to_tsquery(#{"#{connection.quote search_type}, " if search_type.present?}#{tsquery_string_quoted})"
  tsquery = "regexp_replace(#{tsquery}::text, '''([a-z0-9\\-_@.]+)''', '''\\1'':*', 'g')::tsquery" if prefix
  relation
    .unscoped
    .select(:id, "ts_rank_cd(#{fqc_quoted}, #{tsquery}) AS rank")
    .where("#{fqc_quoted} @@ #{tsquery}")
end