pg_textsearch 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.devcontainer/devcontainer.json +32 -0
- data/.devcontainer/setup.sh +25 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +514 -0
- data/Rakefile +23 -0
- data/lib/pg_textsearch/maintenance.rb +133 -0
- data/lib/pg_textsearch/model.rb +172 -0
- data/lib/pg_textsearch/schema.rb +53 -0
- data/lib/pg_textsearch/version.rb +5 -0
- data/lib/pg_textsearch.rb +30 -0
- data/samples/01_basic_search.rb +113 -0
- data/samples/02_advanced_query_options.rb +106 -0
- data/samples/03_highlighting.rb +100 -0
- data/samples/04_custom_ranking.rb +110 -0
- data/samples/05_fuzzy_synonyms.rb +112 -0
- data/samples/06_maintenance.rb +111 -0
- data/samples/07_extension_setup.rb +89 -0
- data/sig/pg_textsearch.rbs +4 -0
- data/test/integration_test.rb +125 -0
- data/test/pg_textsearch_test.rb +162 -0
- metadata +107 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "active_record"
|
|
4
|
+
require "pg_textsearch"
|
|
5
|
+
require "minitest/autorun"
|
|
6
|
+
|
|
7
|
+
# Set up a minimal SQLite connection for SQL generation tests
|
|
8
|
+
ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
|
|
9
|
+
|
|
10
|
+
class Document < ActiveRecord::Base
|
|
11
|
+
self.table_name = "documents"
|
|
12
|
+
has_bm25 :content, index: :docs_idx
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
class DocumentWithDefaults < ActiveRecord::Base
|
|
16
|
+
self.table_name = "documents"
|
|
17
|
+
has_bm25 :content, index: :docs_idx, unaccent: true, prefix: true
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
class DocumentNoDefault < ActiveRecord::Base
|
|
21
|
+
self.table_name = "documents"
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
ActiveRecord::Schema.define do
|
|
25
|
+
create_table :documents do |t|
|
|
26
|
+
t.text :content
|
|
27
|
+
t.integer :category_id
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
class PgTextsearchTest < Minitest::Test
|
|
32
|
+
def test_bm25_search_with_explicit_index
|
|
33
|
+
sql = Document.bm25_search(:content, "database system", index: :docs_idx).to_sql
|
|
34
|
+
assert_match(/ORDER BY "?content"? <@> to_bm25query/, sql)
|
|
35
|
+
assert_match(/'docs_idx'/, sql)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
def test_bm25_search_with_has_bm25_declaration
|
|
39
|
+
sql = Document.bm25_search(:content, "database system").to_sql
|
|
40
|
+
assert_match(/ORDER BY "?content"? <@> to_bm25query/, sql)
|
|
41
|
+
assert_match(/'docs_idx'/, sql)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def test_bm25_search_without_index_uses_implicit
|
|
45
|
+
sql = DocumentNoDefault.bm25_search(:content, "database system", index: nil).to_sql
|
|
46
|
+
assert_match(/ORDER BY "?content"? <@> to_bm25query\('database system'\)/, sql)
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def test_bm25_search_with_select_score
|
|
50
|
+
sql = Document.bm25_search(:content, "database system", index: :docs_idx, select_score: true).to_sql
|
|
51
|
+
assert_match(/AS "?bm25_score"?/, sql)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def test_bm25_search_with_custom_score_alias
|
|
55
|
+
sql = Document.bm25_search(:content, "database system", index: :docs_idx, select_score: :my_score).to_sql
|
|
56
|
+
assert_match(/AS "?my_score"?/, sql)
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
def test_bm25_search_composes_with_where
|
|
60
|
+
sql = Document.where(category_id: 1).bm25_search(:content, "database system", index: :docs_idx).to_sql
|
|
61
|
+
assert_match(/WHERE .*category_id.*=.*1/, sql)
|
|
62
|
+
assert_match(/ORDER BY "?content"? <@> to_bm25query/, sql)
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
def test_bm25_search_with_arel_expression
|
|
66
|
+
arel = Arel.sql("(data->>'description')")
|
|
67
|
+
sql = Document.bm25_search(arel, "network error", index: :events_expr_idx).to_sql
|
|
68
|
+
assert_match(/ORDER BY \(data->>'description'\) <@> to_bm25query/, sql)
|
|
69
|
+
assert_match(/'events_expr_idx'/, sql)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
def test_bm25_search_with_raw_sql_string
|
|
73
|
+
sql = Document.bm25_search("data->>'description'", "network error", index: :events_expr_idx).to_sql
|
|
74
|
+
assert_match(/ORDER BY data->>'description' <@> to_bm25query/, sql)
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# --- New Feature Tests ---
|
|
78
|
+
|
|
79
|
+
def test_bm25_search_prefix
|
|
80
|
+
sql = Document.bm25_search(:content, "database", index: :docs_idx, prefix: true).to_sql
|
|
81
|
+
assert_match(/database:\*/, sql)
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
def test_bm25_search_any_word
|
|
85
|
+
sql = Document.bm25_search(:content, "database system", index: :docs_idx, any_word: true).to_sql
|
|
86
|
+
assert_match(/\|/, sql)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def test_bm25_search_negation
|
|
90
|
+
sql = Document.bm25_search(:content, "database !system", index: :docs_idx, negation: true).to_sql
|
|
91
|
+
assert_match(/!system/, sql)
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def test_bm25_search_unaccent
|
|
95
|
+
sql = DocumentWithDefaults.bm25_search(:content, "database", index: :docs_idx).to_sql
|
|
96
|
+
assert_match(/unaccent/, sql)
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
def test_bm25_search_highlight
|
|
100
|
+
sql = Document.bm25_search(:content, "database", index: :docs_idx, highlight: true).to_sql
|
|
101
|
+
assert_match(/ts_headline/, sql)
|
|
102
|
+
assert_match(/pg_search_highlight/, sql)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def test_bm25_search_highlight_custom_options
|
|
106
|
+
sql = Document.bm25_search(
|
|
107
|
+
:content, "database",
|
|
108
|
+
index: :docs_idx,
|
|
109
|
+
highlight: { start_sel: "<mark>", stop_sel: "</mark>", max_words: 50 }
|
|
110
|
+
).to_sql
|
|
111
|
+
assert_match(/StartSel=<mark>/, sql)
|
|
112
|
+
assert_match(%r{StopSel=</mark>}, sql)
|
|
113
|
+
assert_match(/MaxWords=50/, sql)
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def test_bm25_search_ranked_by
|
|
117
|
+
sql = Document.bm25_search(
|
|
118
|
+
:content, "database",
|
|
119
|
+
index: :docs_idx,
|
|
120
|
+
ranked_by: ":bm25 + 0.1 * products.popularity"
|
|
121
|
+
).to_sql
|
|
122
|
+
assert_match(/products\.popularity/, sql)
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def test_bm25_search_order_within_rank
|
|
126
|
+
sql = Document.bm25_search(
|
|
127
|
+
:content, "database",
|
|
128
|
+
index: :docs_idx,
|
|
129
|
+
order_within_rank: "products.updated_at DESC"
|
|
130
|
+
).to_sql
|
|
131
|
+
assert_match(/products\.updated_at DESC/, sql)
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def test_bm25_search_model_defaults_merged
|
|
135
|
+
sql = DocumentWithDefaults.bm25_search(:content, "database").to_sql
|
|
136
|
+
assert_match(/unaccent/, sql)
|
|
137
|
+
assert_match(/database:\*/, sql)
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
class PgTextsearchMaintenanceTest < Minitest::Test
|
|
142
|
+
def test_maintenance_module_functions_exist
|
|
143
|
+
assert PgTextsearch::Maintenance.respond_to?(:needs_compaction?)
|
|
144
|
+
assert PgTextsearch::Maintenance.respond_to?(:compact)
|
|
145
|
+
assert PgTextsearch::Maintenance.respond_to?(:compact_step)
|
|
146
|
+
assert PgTextsearch::Maintenance.respond_to?(:spill_index)
|
|
147
|
+
assert PgTextsearch::Maintenance.respond_to?(:level_counts)
|
|
148
|
+
assert PgTextsearch::Maintenance.respond_to?(:unaccent_available?)
|
|
149
|
+
assert PgTextsearch::Maintenance.respond_to?(:enable_unaccent!)
|
|
150
|
+
assert PgTextsearch::Maintenance.respond_to?(:pg_trgm_available?)
|
|
151
|
+
assert PgTextsearch::Maintenance.respond_to?(:enable_pg_trgm!)
|
|
152
|
+
assert PgTextsearch::Maintenance.respond_to?(:thesaurus_available?)
|
|
153
|
+
assert PgTextsearch::Maintenance.respond_to?(:enable_thesaurus!)
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
class PgTextsearchSchemaTest < Minitest::Test
|
|
158
|
+
def test_schema_modules_defined
|
|
159
|
+
assert defined?(PgTextsearch::SchemaStatements)
|
|
160
|
+
assert defined?(PgTextsearch::SchemaDumper)
|
|
161
|
+
end
|
|
162
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: pg_textsearch
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Aboobacker MK
|
|
8
|
+
bindir: exe
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: activerecord
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '7.0'
|
|
19
|
+
- - "<"
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '9.0'
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
version: '7.0'
|
|
29
|
+
- - "<"
|
|
30
|
+
- !ruby/object:Gem::Version
|
|
31
|
+
version: '9.0'
|
|
32
|
+
- !ruby/object:Gem::Dependency
|
|
33
|
+
name: activesupport
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - ">="
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '7.0'
|
|
39
|
+
- - "<"
|
|
40
|
+
- !ruby/object:Gem::Version
|
|
41
|
+
version: '9.0'
|
|
42
|
+
type: :runtime
|
|
43
|
+
prerelease: false
|
|
44
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
45
|
+
requirements:
|
|
46
|
+
- - ">="
|
|
47
|
+
- !ruby/object:Gem::Version
|
|
48
|
+
version: '7.0'
|
|
49
|
+
- - "<"
|
|
50
|
+
- !ruby/object:Gem::Version
|
|
51
|
+
version: '9.0'
|
|
52
|
+
description: |
|
|
53
|
+
Wraps pg_textsearch's <@> operator, to_bm25query(), and index storage parameters
|
|
54
|
+
(WITH (...)) so you can use BM25 search with standard ActiveRecord relations.
|
|
55
|
+
email:
|
|
56
|
+
- aboobackervyd@gmail.com
|
|
57
|
+
executables: []
|
|
58
|
+
extensions: []
|
|
59
|
+
extra_rdoc_files: []
|
|
60
|
+
files:
|
|
61
|
+
- ".devcontainer/devcontainer.json"
|
|
62
|
+
- ".devcontainer/setup.sh"
|
|
63
|
+
- CHANGELOG.md
|
|
64
|
+
- LICENSE.txt
|
|
65
|
+
- README.md
|
|
66
|
+
- Rakefile
|
|
67
|
+
- lib/pg_textsearch.rb
|
|
68
|
+
- lib/pg_textsearch/maintenance.rb
|
|
69
|
+
- lib/pg_textsearch/model.rb
|
|
70
|
+
- lib/pg_textsearch/schema.rb
|
|
71
|
+
- lib/pg_textsearch/version.rb
|
|
72
|
+
- samples/01_basic_search.rb
|
|
73
|
+
- samples/02_advanced_query_options.rb
|
|
74
|
+
- samples/03_highlighting.rb
|
|
75
|
+
- samples/04_custom_ranking.rb
|
|
76
|
+
- samples/05_fuzzy_synonyms.rb
|
|
77
|
+
- samples/06_maintenance.rb
|
|
78
|
+
- samples/07_extension_setup.rb
|
|
79
|
+
- sig/pg_textsearch.rbs
|
|
80
|
+
- test/integration_test.rb
|
|
81
|
+
- test/pg_textsearch_test.rb
|
|
82
|
+
homepage: https://github.com/timescale/pg_textsearch
|
|
83
|
+
licenses:
|
|
84
|
+
- MIT
|
|
85
|
+
metadata:
|
|
86
|
+
allowed_push_host: https://rubygems.org
|
|
87
|
+
homepage_uri: https://github.com/timescale/pg_textsearch
|
|
88
|
+
source_code_uri: https://github.com/timescale/pg_textsearch
|
|
89
|
+
changelog_uri: https://github.com/timescale/pg_textsearch/blob/main/CHANGELOG.md
|
|
90
|
+
rdoc_options: []
|
|
91
|
+
require_paths:
|
|
92
|
+
- lib
|
|
93
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
94
|
+
requirements:
|
|
95
|
+
- - ">="
|
|
96
|
+
- !ruby/object:Gem::Version
|
|
97
|
+
version: 3.2.0
|
|
98
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - ">="
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: '0'
|
|
103
|
+
requirements: []
|
|
104
|
+
rubygems_version: 4.0.20
|
|
105
|
+
specification_version: 4
|
|
106
|
+
summary: Minimal ActiveRecord wrapper for pg_textsearch BM25 indexes
|
|
107
|
+
test_files: []
|