full_search 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed7b0998cc6d4014ab815a6152ba07562da34c98b3cca3aa3886e63fb45acc5b
-  data.tar.gz: f29430f7ac4d5a3175e1eb46c803aa3a9b9ce68e3e930f2f75ecfd8ad03242d7
+  metadata.gz: b3b466311e2305f90987a48ff58cee59f4c81af6e960b5fcd2fe09cf845b985b
+  data.tar.gz: 1d355e22aa06d280d984d7da1df90e57a8ca4a5f5676b7870424f2b048c051ba
 SHA512:
-  metadata.gz: cce0189e77ec25883ad52dae321dea4f99cb8f1f245f331b5cdeb94f6c3554c675e84b0214e4036ca1c01fc53f22e41594324729d39688c8e48d0bcd791356f3
-  data.tar.gz: a9d3f31295d082892dc5cf797f2d38a9cb8151629f9e6d2c0ac0ad1b8dcfeb5e732b740fb91d138d0b3a7f1db513c72c36aa61a1410d2b052bd57bda0790c5dd
+  metadata.gz: 9489ff8c9bf04c59b6380cd1810871a39a947421754379ac6fb1c1cb36cbf7850a753d0a7354e25f38b591aeae63cbb05cd7d8c0f187bb84ba6ef191aba19755
+  data.tar.gz: a23ce1270f3ac088b02774a43178fb277811e7df65a7d518f3fde4b8899cfb2db3f07164c72ea75ec26bb3b8ed9ef29b94d05aa53009ef1f82dd9d1bb4d14f79

data/README.md

@@ -45,6 +45,27 @@ end
 Customer.search("sam", filters: { account_id: 1 }).page(params[:page])
 ```
 
+### Field aliasing with `as:`
+
+Use `as:` to give a field a different column name in the FTS table. This is useful when
+the model's accessor name differs from the desired search index key — for example, storing
+a computed value (last 8 chars of VIN) in a shorter or semantically-named column:
+
+```ruby
+class Vehicle < ApplicationRecord
+  full_search do
+    field :vin_last8, weight: 2, source: -> { vin&.last(8)&.upcase }, as: :vin
+    field :make, weight: 4
+    field :model, weight: 4
+    filter :account_id, required: true
+    highlight
+  end
+end
+```
+
+The FTS table stores the value under `vin` (not `vin_last8`). Search results highlight
+keyed as `vin`, and the `full_search_text_for(:vin)` lookup works as expected.
+
 ## Features
 
 - Declarative `full_search` DSL with `search` / `full_search` query methods

data/lib/full_search/callbacks.rb

@@ -66,7 +66,7 @@ module FullSearch
       table = qt(FullSearch::Index.fts_table_name(record.class))
       conn = ActiveRecord::Base.connection
       conn.execute(
-        "UPDATE #{table} SET #{qc(field.name)} = #{q(value.to_s)} WHERE rowid = #{q(record.id)}"
+        "UPDATE #{table} SET #{qc(field.as || field.name)} = #{q(value.to_s)} WHERE rowid = #{q(record.id)}"
       )
     rescue => e
       raise unless e.message.include?("no such table")

data/lib/full_search/config.rb

@@ -3,8 +3,8 @@
 module FullSearch
   class Config
     attr_accessor :auto_rebuild_schema, :stale_query_behavior, :lock_rebuilds,
-                  :default_async_reindex, :default_async_source_reindex,
-                  :default_tokenizer, :auto_rebuild_on_stale_query
+      :default_async_reindex, :default_async_source_reindex,
+      :default_tokenizer, :auto_rebuild_on_stale_query
 
     def initialize
       @auto_rebuild_schema = false

data/lib/full_search/dsl.rb

@@ -20,9 +20,9 @@ module FullSearch
     end
 
     def field(name, weight: 1, source: nil, reindex_on: nil,
-              async: FullSearch.config.default_async_reindex,
-              async_source: FullSearch.config.default_async_source_reindex,
-              as: nil, version: nil)
+      async: FullSearch.config.default_async_reindex,
+      async_source: FullSearch.config.default_async_source_reindex,
+      as: nil, version: nil)
       unless valid_name?(name)
         raise InvalidFieldError, "#{model_class.name}: invalid field name #{name.inspect}"
       end

data/lib/full_search/index.rb

@@ -46,9 +46,9 @@ module FullSearch
           conn.execute(backfill_sql(model)) if fts_was_created
           conn.execute(backfill_trigram_sql(model)) if trigram_was_created
           reindex_source_fields!(model) if dsl.fields.any?(&:source)
+          store_config_hash!(model)
         end
 
-        store_config_hash!(model)
         ensure_triggers!(model) if model_table_exists?(model)
 
         verified_tables.add(model.table_name)
@@ -188,6 +188,10 @@ module FullSearch
         connection.quote_table_name(name)
       end
 
+      def column_name(col)
+        (col.respond_to?(:as) && col.as) ? col.as : col.name
+      end
+
       def qc(name)
         connection.quote_column_name(name)
       end
@@ -223,7 +227,7 @@ module FullSearch
       def create_virtual_table_sql(model)
         dsl = model.full_search_dsl
         columns = (dsl.fields + dsl.filters.map { |f| FilterColumnPlaceholder.new(name: f.name) } + extra_columns(model))
-        column_list = columns.map { |c| (c.respond_to?(:unindexed?) && c.unindexed?) ? "#{qc(c.name)} UNINDEXED" : qc(c.name) }.join(", ")
+        column_list = columns.map { |c| (c.respond_to?(:unindexed?) && c.unindexed?) ? "#{qc(column_name(c))} UNINDEXED" : qc(column_name(c)) }.join(", ")
 
         "CREATE VIRTUAL TABLE #{qt(fts_table_name(model))} USING fts5(#{column_list}, tokenize='#{dsl.tokenize}');"
       end
@@ -244,7 +248,7 @@ module FullSearch
         where_clause = dsl.conditional_index? ? " WHERE (#{dsl.index_if_sql})" : ""
 
         <<~SQL
-          INSERT INTO #{qt(fts_table_name(model))}(rowid, #{cols.map { |c| qc(c.name) }.join(", ")})
+          INSERT INTO #{qt(fts_table_name(model))}(rowid, #{cols.map { |c| qc(column_name(c)) }.join(", ")})
           SELECT #{qt(model.table_name)}.id, #{select} FROM #{qt(model.table_name)}#{where_clause};
         SQL
       end
@@ -369,7 +373,7 @@ module FullSearch
       def create_trigram_virtual_table_sql(model)
         dsl = model.full_search_dsl
         columns = (dsl.fields + dsl.filters.map { |f| FilterColumnPlaceholder.new(name: f.name) } + extra_columns(model))
-        column_list = columns.map { |c| (c.respond_to?(:unindexed?) && c.unindexed?) ? "#{qc(c.name)} UNINDEXED" : qc(c.name) }.join(", ")
+        column_list = columns.map { |c| (c.respond_to?(:unindexed?) && c.unindexed?) ? "#{qc(column_name(c))} UNINDEXED" : qc(column_name(c)) }.join(", ")
 
         "CREATE VIRTUAL TABLE #{qt(trigram_table_name(model))} USING fts5(#{column_list}, tokenize='trigram');"
       end
@@ -390,7 +394,7 @@ module FullSearch
         where_clause = dsl.conditional_index? ? " WHERE (#{dsl.index_if_sql})" : ""
 
         <<~SQL
-          INSERT INTO #{qt(trigram_table_name(model))}(rowid, #{cols.map { |c| qc(c.name) }.join(", ")})
+          INSERT INTO #{qt(trigram_table_name(model))}(rowid, #{cols.map { |c| qc(column_name(c)) }.join(", ")})
           SELECT #{qt(model.table_name)}.id, #{select} FROM #{qt(model.table_name)}#{where_clause};
         SQL
       end
@@ -469,7 +473,7 @@ module FullSearch
       end
 
       def col_names(cols)
-        cols.map { |c| qc(c.name) }.join(", ")
+        cols.map { |c| qc(column_name(c)) }.join(", ")
       end
 
       def column_ref(col, prefix:)

data/lib/full_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FullSearch
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: full_search
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ben D'Angelo