Search redux

A small Active Record integration for prefix full-text search on PostgreSQL, with a portable LIKE fallback for other database adapters.

Version 1.0.4 supports Ruby 3.2 through 4.0 and Rails 8.1. It deliberately pins the Rails components to patched 8.1 releases (>= 8.1.3.1, < 8.2) rather than claiming compatibility with untested, unsupported Rails generations.

The exact last-tested stack is Ruby 4.0.6, Rails/Active Record 8.1.3.1, and SQLite 3.51.2 (via the sqlite3 2.9.5 gem). PostgreSQL SQL generation is covered by unit tests, but no live PostgreSQL server is part of the test suite.

Include the gem in your Gemfile:

gem 'search_redux'

In your model call the act_as_searchable with the columns that you want to search and the column for rank-based ordering.

class MyModel < ApplicationRecord
  act_as_searchable columns: %w[title content], rank: "title"
end

You can easily search via the text_search method.

class MyController
  def index
    articles = MyModel.text_search("query phrase")
  end
end

PostgreSQL searches use the english text-search configuration and append :* to each alphanumeric query term for prefix matching. Other adapters use a case-sensitive or case-insensitive LIKE according to that database's normal semantics. Search terms are bound parameters and configured column names are quoted as identifiers.

This is a narrowly maintained integration, not a general-purpose search framework. PostgreSQL and the generic fallback are supported; adapter-specific ranking, language configuration, migrations, and indexes are outside its scope.

Copyright (c) 2022 Marian Posaceanu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.