Searchable By

ActiveRecord plugin to quickly create search scopes.

Installation

Add gem 'searchable-by' to your Gemfile.

Usage

class Post < ActiveRecord::Base
  belongs_to :author

  # Limit the number of terms per query to 3.
  # Ignore search terms shorter than 3 characters (useful for trigram indexes).
  searchable_by max_terms: 3, min_length: 3 do
    # Allow to search strings with custom match type.
    column :title,
      match: :prefix,       # Use btree index-friendly prefix match, e.g. `ILIKE 'term%'` instead of default `ILIKE '%term%'`.
      match_phrase: :exact, # For phrases use exact match type, e.g. searching for `"My Post"` will query `WHERE LOWER(title) = 'my post'`.

    # ... and integers.
    column :id, type: :integer

    # Allow custom arel nodes.
    column { Author.arel_table[:name] }
    column { Arel::Nodes::NamedFunction.new('CONCAT', [arel_table[:prefix], arel_table[:suffix]]) }

    # Support custom scopes.
    scope do
      joins(:author)
    end
  end

  # Multiple profiles can be defined. This one only searches title and metadata.
  searchable_by :metadata do
    column :title, match: :prefix

    # Allow custom wildcard replacement using a match e.g. searching for `"My*Post"` will query `ILIKE 'My%Post'`.
    column :metadata, match: :prefix, wildcard: '*'
  end
end

# Search for 'alice'
Post.search_by('alice') # => ActiveRecord::Relation

# Search for 'alice' AND 'pie recipe'
Post.search_by('alice "pie recipe"')

# Search for 'alice' but NOT for 'pie recipe'
Post.search_by('alice -"pie recipe"')

# Search using metadata profile
Post.search_by('meta', profile: :metadata)