runestone 1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3756ae6e1dcf043dc6d4ca6e1312a0409ceac0fd15a90e6a7859c7d5cfec0ef9
-  data.tar.gz: a2e9bfd44ae564d10ddd6ee9f25179b267b12979dd7bfe2311825ce2bc348d97
+  metadata.gz: 3c069ec88ae02b52e3cb0a155efe7d17b0cb3d0f9b248e74deec97cb1ed752e0
+  data.tar.gz: 4e627b4879f88ae65b8b56090604e7e8fe0379f93f5a72b4142d76d5eabf08f7
 SHA512:
-  metadata.gz: 4c6b1cd82ea806fd419ab2b9986b27d2fabb0d0d898decf69068bb9b824c642d9ef333e8c2f6874ca5151d5250ef5f4d81796cce7813b2bfdb66dbb47ed5a01d
-  data.tar.gz: ec0d633c0eaab16dccea6a340f53f6160e6932a530d6d1398ce3462b9366abbc018548e5789cccf2974c8f45495e78949a865a3b270f09ab7d61b9738a5e7db6
+  metadata.gz: 7f3f103de6f864ce9d8047232023f1c6db98867be4a7015d899c088875b830d9ee34e84c31d23b18bbdb88fc9058efe7a455891958d5adbb6b3600aed0ff4552
+  data.tar.gz: 014ab3c81cb2c6df0473cd5ec0c65a35a6aa46a41c7f351962b26a97abc32eac74820738bcccddfa0d67b5a3b8c715d8ed5a6d1810d1099be1f134d85ac54679

data/README.md

@@ -4,7 +4,107 @@ Runestone provides full text search PostgreSQL's full text search capabilities.
 It was inspired by [Postgres full-text search is Good Enough!][1] and
 [Super Fuzzy Searching on PostgreSQL][2]
 
+## Installation
 
+Install Runestone from RubyGems:
+
+``` sh
+$ gem install runestone
+```
+
+Or include it in your project's `Gemfile` with Bundler:
+
+``` ruby
+gem 'runestone'
+```
+
+After installation, run the Runestone's migration to to enable the necessary database extensions and create the runestones and runestone corpus tables.
+
+```sh
+$ rails db:migrate
+```
+
+## Usage
+
+### Indexing
+
+To index your ActiveRecord Models:
+
+```ruby
+class Building < ApplicationRecord
+
+  runestone do
+    index 'name', 'addresses.global', 'addresses.national'
+    
+    attributes(:name)
+    attributes(:size, :floors)
+    attribute(:addresses) {
+      addresses&.map{|address| {
+        local: address.local,
+        regional: address.regional,
+        national: address.national,
+        global: address.global
+      } }
+    }
+  end
+
+end
+```
+
+When searching the attribute(s) will be available in `data` on the result(s), but only the attributes specified by `index` will indexed and used for searching.
+
+### Searching
+
+To search for the Building:
+
+```ruby
+Building.search("Empire")
+```
+
+You can also search through all indexed models with:
+
+```ruby
+Runestone::Model.search("needle")
+```
+
+Additionally you can highlight the results. When this is done each result will have a `highlights` attribute which is the same as data, but with matches wrapped in a `<b>` tag:
+
+```ruby
+Runestone::Model.highlight(@results, "needle")
+```
+
+## Configuration
+
+### Synonym
+
+```ruby
+Runestone.add_synonym('ten', '10')
+
+Runestone.add_synonym('one hundred', '100')
+Runestone.add_synonym('100', 'one hundred')
+```
+
+### Defaults
+
+#### dictionary
+
+The default dictionary that Runestone uses is the `runestone` dictionary. Which
+is the `simple` dictionary in PostgreSQL with `unaccent` to tranliterate some
+characters to the ASCII equivlent.
+
+```ruby
+Runestone.dictionary = :runesonte
+```
+
+#### normalization for ranking
+
+Ranking can be configured to use the `normalization` paramater as described
+in the [PostgreSQL documentation][3]. The default is `16`
+
+```ruby
+Runestone.dictionary = 16
+```
 
 [1]: http://rachbelaid.com/postgres-full-text-search-is-good-enough/
-[2]: http://www.www-old.bartlettpublishing.com/site/bartpub/blog/3/entry/350
+[2]: http://www.www-old.bartlettpublishing.com/site/bartpub/blog/3/entry/350
+[3]: https://www.postgresql.org/docs/13/textsearch-controls.html#TEXTSEARCH-RANKING

data/db/migrate/{20181101150207_create_ts_tables.rb → 20181101150207_create_runestone_tables.rb}

@@ -4,6 +4,7 @@ class CreateRunestoneTables < ActiveRecord::Migration[6.0]
     enable_extension 'pgcrypto'
     enable_extension 'pg_trgm'
     enable_extension 'fuzzystrmatch'
+    enable_extension 'unaccent'
 
     create_table :runestones, id: :uuid do |t|
       t.belongs_to  :record, type: :uuid, polymorphic: true, null: false
@@ -21,8 +22,8 @@ class CreateRunestoneTables < ActiveRecord::Migration[6.0]
 
       CREATE INDEX runestone_corpus_trgm_idx ON runestone_corpus USING GIN (word gin_trgm_ops);
 
-      CREATE TEXT SEARCH CONFIGURATION simple_unaccent (COPY = simple);
-      ALTER TEXT SEARCH CONFIGURATION simple_unaccent
+      CREATE TEXT SEARCH CONFIGURATION runestone (COPY = simple);
+      ALTER TEXT SEARCH CONFIGURATION runestone
         ALTER MAPPING FOR hword, hword_part, word
         WITH unaccent, simple;
     SQL

data/lib/runestone.rb

@@ -6,7 +6,8 @@ module Runestone
   autoload :WebSearch, "#{File.dirname(__FILE__)}/runestone/web_search"
   autoload :IndexingJob, "#{File.dirname(__FILE__)}/runestone/indexing_job"
   
-  mattr_accessor :dictionary, default: :simple_unaccent
+  mattr_accessor :dictionary, default: :runestone
+  mattr_accessor :normalization, default: 16
   mattr_accessor :runner, default: :inline
   mattr_accessor :job_queue, default: :runestone_indexing
   mattr_accessor :typo_tolerances, default: { 1 => 4..7, 2 => 8.. }
@@ -15,6 +16,37 @@ module Runestone
     { }
   end
   
+  DEFAULT_APPROXIMATIONS = {
+    "À"=>"A", "Á"=>"A", "Â"=>"A", "Ã"=>"A", "Ä"=>"A", "Å"=>"A", "Æ"=>"AE",
+    "Ç"=>"C", "È"=>"E", "É"=>"E", "Ê"=>"E", "Ë"=>"E", "Ì"=>"I", "Í"=>"I",
+    "Î"=>"I", "Ï"=>"I", "Ð"=>"D", "Ñ"=>"N", "Ò"=>"O", "Ó"=>"O", "Ô"=>"O",
+    "Õ"=>"O", "Ö"=>"O", "×"=>"x", "Ø"=>"O", "Ù"=>"U", "Ú"=>"U", "Û"=>"U",
+    "Ü"=>"U", "Ý"=>"Y", "Þ"=>"Th", "ß"=>"ss", "à"=>"a", "á"=>"a", "â"=>"a",
+    "ã"=>"a", "ä"=>"a", "å"=>"a", "æ"=>"ae", "ç"=>"c", "è"=>"e", "é"=>"e",
+    "ê"=>"e", "ë"=>"e", "ì"=>"i", "í"=>"i", "î"=>"i", "ï"=>"i", "ð"=>"d",
+    "ñ"=>"n", "ò"=>"o", "ó"=>"o", "ô"=>"o", "õ"=>"o", "ö"=>"o", "ø"=>"o",
+    "ù"=>"u", "ú"=>"u", "û"=>"u", "ü"=>"u", "ý"=>"y", "þ"=>"th", "ÿ"=>"y",
+    "Ā"=>"A", "ā"=>"a", "Ă"=>"A", "ă"=>"a", "Ą"=>"A", "ą"=>"a", "Ć"=>"C",
+    "ć"=>"c", "Ĉ"=>"C", "ĉ"=>"c", "Ċ"=>"C", "ċ"=>"c", "Č"=>"C", "č"=>"c",
+    "Ď"=>"D", "ď"=>"d", "Đ"=>"D", "đ"=>"d", "Ē"=>"E", "ē"=>"e", "Ĕ"=>"E",
+    "ĕ"=>"e", "Ė"=>"E", "ė"=>"e", "Ę"=>"E", "ę"=>"e", "Ě"=>"E", "ě"=>"e",
+    "Ĝ"=>"G", "ĝ"=>"g", "Ğ"=>"G", "ğ"=>"g", "Ġ"=>"G", "ġ"=>"g", "Ģ"=>"G",
+    "ģ"=>"g", "Ĥ"=>"H", "ĥ"=>"h", "Ħ"=>"H", "ħ"=>"h", "Ĩ"=>"I", "ĩ"=>"i",
+    "Ī"=>"I", "ī"=>"i", "Ĭ"=>"I", "ĭ"=>"i", "Į"=>"I", "į"=>"i", "İ"=>"I",
+    "ı"=>"i", "IJ"=>"IJ", "ij"=>"ij", "Ĵ"=>"J", "ĵ"=>"j", "Ķ"=>"K", "ķ"=>"k",
+    "ĸ"=>"k", "Ĺ"=>"L", "ĺ"=>"l", "Ļ"=>"L", "ļ"=>"l", "Ľ"=>"L", "ľ"=>"l",
+    "Ŀ"=>"L", "ŀ"=>"l", "Ł"=>"L", "ł"=>"l", "Ń"=>"N", "ń"=>"n", "Ņ"=>"N",
+    "ņ"=>"n", "Ň"=>"N", "ň"=>"n", "ʼn"=>"'n", "Ŋ"=>"NG", "ŋ"=>"ng",
+    "Ō"=>"O", "ō"=>"o", "Ŏ"=>"O", "ŏ"=>"o", "Ő"=>"O", "ő"=>"o", "Œ"=>"OE",
+    "œ"=>"oe", "Ŕ"=>"R", "ŕ"=>"r", "Ŗ"=>"R", "ŗ"=>"r", "Ř"=>"R", "ř"=>"r",
+    "Ś"=>"S", "ś"=>"s", "Ŝ"=>"S", "ŝ"=>"s", "Ş"=>"S", "ş"=>"s", "Š"=>"S",
+    "š"=>"s", "Ţ"=>"T", "ţ"=>"t", "Ť"=>"T", "ť"=>"t", "Ŧ"=>"T", "ŧ"=>"t",
+    "Ũ"=>"U", "ũ"=>"u", "Ū"=>"U", "ū"=>"u", "Ŭ"=>"U", "ŭ"=>"u", "Ů"=>"U",
+    "ů"=>"u", "Ű"=>"U", "ű"=>"u", "Ų"=>"U", "ų"=>"u", "Ŵ"=>"W", "ŵ"=>"w",
+    "Ŷ"=>"Y", "ŷ"=>"y", "Ÿ"=>"Y", "Ź"=>"Z", "ź"=>"z", "Ż"=>"Z", "ż"=>"z",
+    "Ž"=>"Z", "ž"=>"z"
+  }.freeze
+
   def self.normalize(string)
     string = string.downcase
     string = string.unicode_normalize!
@@ -22,7 +54,17 @@ module Runestone
   rescue Encoding::CompatibilityError
     string
   end
-  
+
+  def self.normalize!(string)
+    string.downcase!
+    string.unicode_normalize!
+  rescue Encoding::CompatibilityError
+  end
+
+  def transliterate(string)
+    string.gsub(/[^\x00-\x7f]/u) { |char| approximations[char] || char }
+  end
+
   def self.add_synonyms(dictionary)
     dictionary.each do |k, v|
       add_synonym(k, *v)
@@ -53,7 +95,7 @@ module Runestone
     syn[last].uniq!
   end
   
-  def search(query, dictionary: nil, prefix: :last)
+  def search(query, dictionary: nil, prefix: :last, normalization: nil)
     exact_search = Runestone::WebSearch.parse(query, prefix: prefix)
     typo_search = exact_search.typos
     syn_search = typo_search.synonymize
@@ -65,11 +107,11 @@ module Runestone
     q = if select_values.empty?
       select(
         klass.arel_table[Arel.star],
-        *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
+        *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary, normalization: normalization), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
       )
     else
       select(
-        *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
+        *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary, normalization: normalization), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
       )
     end
 

data/lib/runestone/active_record/relation_methods.rb

@@ -39,14 +39,17 @@ module Runestone::ActiveRecord
       )
     end
 
-    def ts_rank_cd(vector, query, dictionary: nil)
+    def ts_rank_cd(vector, query, dictionary: nil, normalization: nil)
+      normalization ||= Runestone.normalization
+      
       Arel::Nodes::TSRankCD.new(
         ts_vector(vector, dictionary: dictionary),
-        ts_query(query, dictionary: dictionary)
+        ts_query(query, dictionary: dictionary),
+        normalization
       )
     end
 
-    def search(query, dictionary: nil, prefix: nil)
+    def search(query, dictionary: nil, prefix: nil, normalization: nil)
       exact_search = Runestone::WebSearch.parse(query, prefix: prefix)
       typo_search = exact_search.typos
       syn_search = typo_search.synonymize
@@ -58,11 +61,11 @@ module Runestone::ActiveRecord
       q = if select_values.empty?
         select(
           klass.arel_table[Arel.star],
-          *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
+          *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary, normalization: normalization), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
         )
       else
         select(
-          *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
+          *tsqueries.each_with_index.map { |q, i| Arel::Nodes::As.new(ts_rank_cd(:vector, q, dictionary: dictionary, normalization: normalization), Arel::Nodes::SqlLiteral.new("rank#{i}")) }
         )
       end
 

data/lib/runestone/corpus.rb

@@ -6,21 +6,22 @@ module Runestone::Corpus
     conn = Runestone::Model.connection
     conn.execute(<<-SQL)
       INSERT INTO runestone_corpus ( word )
-      VALUES (#{words.map { |w| conn.quote(w.downcase) }.join('),(')})
+      VALUES (#{words.map { |w| conn.quote(Runestone.normalize(w)) }.join('),(')})
       ON CONFLICT DO NOTHING
     SQL
   end
 
   def self.similar_words(*words)
     lut = {}
+    conn = Runestone::Model.connection
     words = words.inject([]) do |ws, w|
       tt = typo_tolerance(w)
-      ws << "#{Runestone::Model.connection.quote(w)}, #{Runestone::Model.connection.quote(w.downcase)}, #{tt}" if tt > 0
+      ws << "#{conn.quote(w)}, #{conn.quote(w.downcase)}, #{tt}" if tt > 0
       ws
     end
     return lut if words.size == 0
     
-    result = Runestone::Model.connection.execute(<<-SQL)
+    result = conn.execute(<<-SQL)
       WITH  tokens (token, token_downcased, typo_tolerance) AS (VALUES (#{words.join('), (')}))
       SELECT token, word, levenshtein(runestone_corpus.word, tokens.token_downcased)
       FROM tokens

data/lib/runestone/version.rb

@@ -1,3 +1,3 @@
 module Runestone
-  VERSION = '1.0'
+  VERSION = '2.0.0'
 end

data/lib/runestone/web_search.rb

@@ -26,11 +26,7 @@ class Runestone::WebSearch
   # prefix options: :all, :last, :none (default: :last)
   def self.parse(query, prefix: :last)
     prefix ||= :last
-    begin
-      query.unicode_normalize!
-    rescue Encoding::CompatibilityError
-    end
-    query.downcase!
+    Runestone.normalize!(query)
 
     q = []
     stack = []

data/runestone.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'activejob', '>= 6.0'
 
   # Runtime
-  s.add_runtime_dependency 'arel-extensions', '>= 6.0'
+  s.add_runtime_dependency 'arel-extensions', '>= 6.0.0.9'
   s.add_runtime_dependency 'activerecord', '>= 6.0'
 end

data/test/corpus_test.rb

@@ -38,5 +38,24 @@ class CorpusTest < ActiveSupport::TestCase
       Runestone::Corpus.similar_words('Allee')
     )
   end
-  
+
+  test 'adding words to corpus normalizes them' do
+    Runestone::Corpus.add("all\u00e9e")
+    assert_equal(
+      {
+        "Allee" => ["all\u00e9e"]
+      },
+      Runestone::Corpus.similar_words('Allee')
+    )
+
+    Runestone::Model.connection.execute('DELETE FROM runestone_corpus')
+    Runestone::Corpus.add("all\u0065\u0301e")
+    assert_equal(
+      {
+        "Allee" => ["all\u00e9e"]
+      },
+      Runestone::Corpus.similar_words('Allee')
+    )
+  end
+
 end

data/test/database.rb

@@ -56,8 +56,8 @@ ActiveRecord::Migration.suppress_messages do
     CREATE INDEX runestone_corpus_trgm_idx ON runestone_corpus USING GIN (word gin_trgm_ops);
 
 
-      CREATE TEXT SEARCH CONFIGURATION simple_unaccent (COPY = simple);
-      ALTER TEXT SEARCH CONFIGURATION simple_unaccent
+      CREATE TEXT SEARCH CONFIGURATION runestone (COPY = simple);
+      ALTER TEXT SEARCH CONFIGURATION runestone
         ALTER MAPPING FOR hword, hword_part, word
         WITH unaccent, simple;
     SQL

data/test/delayed_index_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 class DelayedIndexingTest < ActiveSupport::TestCase
   
-  test 'simple_unaccent index' do
+  test 'runestone index' do
     region = assert_no_difference 'Runestone::Model.count' do
-      assert_no_sql(/setweight\(to_tsvector\('simple_unaccent', 'address name'\), 'A'\)/) do
+      assert_no_sql(/setweight\(to_tsvector\('runestone', 'address name'\), 'A'\)/) do
         Region.create(name: 'Region name')
       end
     end

data/test/highlight_test.rb

@@ -9,6 +9,7 @@ class HighlightTest < ActiveSupport::TestCase
     tsmodels = Runestone::Model.search('state')
     Runestone::Model.highlight(tsmodels, 'state')
     assert_equal([
+      { "name"=>"address of <b>state</b> duo" },
       {
         "name"=>"Big <b>state</b> building",
         "addresses"=> [{"name"=>"address of <b>state</b> duo"}]
@@ -17,10 +18,31 @@ class HighlightTest < ActiveSupport::TestCase
         "name"=>"Empire <b>state</b> building",
         "addresses"=> [{"name"=>"address uno"}]
       },
+
+    ], tsmodels.map(&:highlights))
+  end
+  
+  test '::highlights(query) with an accent in the result' do
+    Property.create(name: 'Émpire state building', addresses: [Address.create(name: 'address uno')])
+    Property.create(name: 'Big state building', addresses: [Address.create(name: 'addréss of state duo')])
+    
+    tsmodels = Runestone::Model.search('empire')
+    Runestone::Model.highlight(tsmodels, 'empire')
+    assert_equal([
       {
-        "name"=>"address of <b>state</b> duo"
+        "name"=>"<b>Émpire</b> state building",
+        "addresses"=>[ {"name"=>"address uno"} ]
       }
     ], tsmodels.map(&:highlights))
+
+    tsmodels = Runestone::Model.search('address')
+    Runestone::Model.highlight(tsmodels, 'address')
+    assert_equal([
+      {"name"=>"<b>address</b> uno"},
+      {"name"=>"<b>addréss</b> of state duo"},
+      {"addresses"=>[{"name"=>"<b>address</b> uno"}], "name"=>"Émpire state building"},
+      {"addresses"=>[{"name"=>"<b>addréss</b> of state duo"}], "name"=>"Big state building"}
+    ], tsmodels.map(&:highlights))
   end
   
 end

data/test/indexing_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 class IndexingTest < ActiveSupport::TestCase
   
-  test 'simple_unaccent index' do
+  test 'runestone index' do
     address = assert_difference 'Runestone::Model.count', 1 do
-      assert_sql(/setweight\(to_tsvector\('simple_unaccent', 'address name'\), 'A'\)/) do
+      assert_sql(/setweight\(to_tsvector\('runestone', 'address name'\), 'A'\)/) do
         Address.create(name: 'Address name')
       end
     end

data/test/multi_index_test.rb

@@ -33,16 +33,16 @@ class MultiIndexTest < ActiveSupport::TestCase
     
     query = Runestone::Model.search('empire')
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'empire:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'empire:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'empire:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'empire:*')
       ORDER BY rank0 DESC
     SQL
     
     query = Runestone::Model.search('empire', dictionary: 'english')
     assert_sql(<<~SQL, query.to_sql)
       SELECT
-        "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('english', 'empire:*')) AS rank0
+        "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('english', 'empire:*'), 16) AS rank0
       FROM "runestones"
       WHERE "runestones"."vector" @@ to_tsquery('english', 'empire:*')
       AND "runestones"."dictionary" = 'english'
@@ -51,7 +51,7 @@ class MultiIndexTest < ActiveSupport::TestCase
     
     query = Runestone::Model.search('Эмпайр', dictionary: 'russian')
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('russian', 'эмпайр:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('russian', 'эмпайр:*'), 16) AS rank0
       FROM "runestones"
       WHERE "runestones"."vector" @@ to_tsquery('russian', 'эмпайр:*')
       AND "runestones"."dictionary" = 'russian'

data/test/ordering_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class OrderTest < ActiveSupport::TestCase
+
+  test 'smaller documents come first' do
+    a2 = Address.create(name: 'a big square')
+    a1 = Address.create(name: 'Square')
+
+    query = Runestone::Model.search('square')
+    assert_sql(<<~SQL, query.to_sql)
+      SELECT
+        "runestones".*,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'square:*'), 16) AS rank0
+      FROM "runestones"
+      WHERE
+        "runestones"."vector" @@ to_tsquery('runestone', 'square:*')
+      ORDER BY rank0 DESC
+    SQL
+    
+    assert_equal(query.map(&:record).map(&:name), [
+      'Square',
+      'a big square'
+    ])
+  end
+
+  
+
+end

data/test/query_test.rb

@@ -6,9 +6,9 @@ class QueryTest < ActiveSupport::TestCase
     query = Runestone::Model.search('seaerch for this')
 
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & this:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & this:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch & for & this:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'seaerch & for & this:*')
       ORDER BY rank0 DESC
     SQL
   end
@@ -17,9 +17,9 @@ class QueryTest < ActiveSupport::TestCase
     query = Runestone::Model.search("the search for \u0065\u0301")
 
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'the & search & for & \u00e9:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'the & search & for & \u00e9:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'the & search & for & \u00e9:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'the & search & for & \u00e9:*')
       ORDER BY rank0 DESC
     SQL
   end
@@ -27,17 +27,17 @@ class QueryTest < ActiveSupport::TestCase
   test "::search(query with ')" do
     query = Runestone::Model.search("seaerch for ' this")
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & this:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & this:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch & for & this:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'seaerch & for & this:*')
       ORDER BY rank0 DESC
     SQL
     
     query = Runestone::Model.search("seaerch for james' map")
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & james'' & map:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & james'' & map:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch & for & james'' & map:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'seaerch & for & james'' & map:*')
       ORDER BY rank0 DESC
     SQL
   end
@@ -46,9 +46,9 @@ class QueryTest < ActiveSupport::TestCase
     query = Runestone::Model.search('seaerch for this', prefix: :all)
 
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch:* & for:* & this:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch:* & for:* & this:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch:* & for:* & this:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'seaerch:* & for:* & this:*')
       ORDER BY rank0 DESC
     SQL
   end
@@ -57,9 +57,9 @@ class QueryTest < ActiveSupport::TestCase
     query = Runestone::Model.search('seaerch for this').limit(10)
 
     assert_sql(<<~SQL, query.to_sql)
-      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & this:*')) AS rank0
+      SELECT "runestones".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & this:*'), 16) AS rank0
       FROM "runestones"
-      WHERE "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch & for & this:*')
+      WHERE "runestones"."vector" @@ to_tsquery('runestone', 'seaerch & for & this:*')
       ORDER BY rank0 DESC
       LIMIT 10
     SQL
@@ -70,13 +70,13 @@ class QueryTest < ActiveSupport::TestCase
 
     assert_sql(<<~SQL, query.to_sql)
       SELECT
-        "properties".*, ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & this:*')) AS rank0
+        "properties".*, ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & this:*'), 16) AS rank0
       FROM "properties"
       INNER JOIN "runestones"
-        ON "runestones"."record_id" = "properties"."id"
-        AND "runestones"."record_type" = 'Property'
+        ON "runestones"."record_type" = 'Property'
+        AND "runestones"."record_id" = "properties"."id"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', 'seaerch & for & this:*')
+        "runestones"."vector" @@ to_tsquery('runestone', 'seaerch & for & this:*')
       ORDER BY rank0 DESC
     SQL
   end
@@ -88,14 +88,14 @@ class QueryTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "properties".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'seaerch & for & this:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(seaerch | search) & for & this:*')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'seaerch & for & this:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(seaerch | search) & for & this:*'), 16) AS rank1
       FROM "properties"
-      INNER JOIN "runestones" ON
-        "runestones"."record_id" = "properties"."id"
-        AND "runestones"."record_type" = 'Property'
+      INNER JOIN "runestones"
+        ON "runestones"."record_type" = 'Property'
+        AND "runestones"."record_id" = "properties"."id"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(seaerch | search) & for & this:*')
+        "runestones"."vector" @@ to_tsquery('runestone', '(seaerch | search) & for & this:*')
       ORDER BY
         rank0 DESC,
         rank1 DESC
@@ -113,12 +113,12 @@ class QueryTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, Runestone::Model.search('avenue').to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'avenue:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(avenue:* | aveneue)')) AS rank1,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '((avenue:* | aveneue) | av | ave | avn | aven | avenu | avnue)')) AS rank2
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'avenue:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(avenue:* | aveneue)'), 16) AS rank1,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '((avenue:* | aveneue) | av | ave | avn | aven | avenu | avnue)'), 16) AS rank2
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '((avenue:* | aveneue) | av | ave | avn | aven | avenu | avnue)')
+        "runestones"."vector" @@ to_tsquery('runestone', '((avenue:* | aveneue) | av | ave | avn | aven | avenu | avnue)')
       ORDER BY
         rank0 DESC,
         rank1 DESC,

data/test/synonym_test.rb

@@ -13,11 +13,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '17 & spruce:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '17 & spruce:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
+        "runestones"."vector" @@ to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end
@@ -40,11 +40,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '17 & spruce:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '17 & spruce:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
+        "runestones"."vector" @@ to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end
@@ -59,11 +59,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '17 & !spruce')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & !spruce')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '17 & !spruce'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & !spruce'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & !spruce')
+        "runestones"."vector" @@ to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & !spruce')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end
@@ -78,11 +78,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '17 & spruce')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & spruce')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '17 & spruce'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & spruce'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & spruce')
+        "runestones"."vector" @@ to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & spruce')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end
@@ -98,11 +98,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '17 & spruce:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '17 & spruce:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
+        "runestones"."vector" @@ to_tsquery('runestone', '(17 | 17th | seventeen | seventeenth) & (spruce:* | pine)')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end
@@ -116,11 +116,11 @@ class SynonymTest < ActiveSupport::TestCase
     assert_sql(<<~SQL, query.to_sql)
       SELECT
         "runestones".*,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', 'one & hundred & spruce:*')) AS rank0,
-        ts_rank_cd("runestones"."vector", to_tsquery('simple_unaccent', '((one & hundred | 100) & spruce:* | (one & hundred | one hundy) & spruce:*)')) AS rank1
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', 'one & hundred & spruce:*'), 16) AS rank0,
+        ts_rank_cd("runestones"."vector", to_tsquery('runestone', '((one & hundred | 100) & spruce:* | (one & hundred | one hundy) & spruce:*)'), 16) AS rank1
       FROM "runestones"
       WHERE
-        "runestones"."vector" @@ to_tsquery('simple_unaccent', '((one & hundred | 100) & spruce:* | (one & hundred | one hundy) & spruce:*)')
+        "runestones"."vector" @@ to_tsquery('runestone', '((one & hundred | 100) & spruce:* | (one & hundred | one hundy) & spruce:*)')
       ORDER BY rank0 DESC, rank1 DESC
     SQL
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runestone
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 2.0.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.0.9
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +177,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- db/migrate/20181101150207_create_ts_tables.rb
+- db/migrate/20181101150207_create_runestone_tables.rb
 - lib/runestone.rb
 - lib/runestone/active_record/base_methods.rb
 - lib/runestone/active_record/relation_methods.rb
@@ -200,6 +200,7 @@ files:
 - test/highlight_test.rb
 - test/indexing_test.rb
 - test/multi_index_test.rb
+- test/ordering_test.rb
 - test/query_test.rb
 - test/synonym_test.rb
 - test/test_helper.rb
@@ -207,7 +208,7 @@ homepage: https://github.com/malomalo/runestone
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Full Text Search for Active Record / Rails
 test_files:
@@ -234,6 +235,7 @@ test_files:
 - test/highlight_test.rb
 - test/indexing_test.rb
 - test/multi_index_test.rb
+- test/ordering_test.rb
 - test/query_test.rb
 - test/synonym_test.rb
 - test/test_helper.rb