Scoped Search 技术文档

本文档旨在帮助用户安装、使用并深入了解 Scoped Search 项目。以下内容将涵盖安装指南、项目使用说明以及项目 API 使用文档。

1. 安装指南

首先，确保您的项目环境满足以下要求：

• Rails 版本：4.2 至 5.0
• Ruby 版本：2.0.0 或更高

在 Gemfile 文件中添加以下代码：

gem "scoped_search"

然后运行以下命令安装依赖：

bundle install

2. 项目的使用说明

Scoped Search 是一个 Ruby on Rails 的扩展，使得对 ActiveRecord 模型的搜索变得更加简单。通过传入一个查询字符串到命名作用域 search_for，它可以在指定的字段上构建查询条件。

以下是如何在模型中使用 Scoped Search 的示例：

class User < ActiveRecord::Base
  scoped_search on: [:first_name, :last_name]
end

现在，您可以在查询中使用 search_for 作用域：

User.search_for('我的搜索字符串').each { |user| ... }

返回的结果是一个命名作用域，因此可以与其他作用域或 will_paginate 进行链式调用。

搜索配置

您可以为 scoped_search 调用添加一个 :profile 选项，这样指定的字段只有在包含该 :profile 时才会被搜索：

class User < ActiveRecord::Base
  scoped_search on: :public_information
  scoped_search on: :private_information, profile: :members
end

这样，以下调用只会搜索 :public_information 字段：

User.search_for('blah blah blah')

而以下调用只会搜索 :private_information 字段：

User.search_for('blah blah blah', profile: :members)

更多关于用法的信息，请参考项目 wiki。

3. 项目 API 使用文档

Scoped Search 提供了简单的查询语言，支持多种复杂的查询构造：

• 单词：每个单词都需要出现，例如：some search keywords
• 短语：使用引号括起来的多词短语，例如："police car"
• 否定：搜索“除了...之外的所有内容”，例如：police -uniform，-"police car"，police NOT car
• 逻辑关键词：使用 AND, OR, &&, ||, &, | 运算符进行逻辑构造，例如：uniform OR car，scoped && search
• 圆括号：用于组织逻辑，例如："police AND (uniform OR car)"
• 比较运算符：用于搜索数值或时间字段，例如：> 22，< 2009-01-01
• 明确字段：仅在给定字段中搜索，例如：username = root，created_at > 2009-01-01
• NULL 检查：使用 set? 和 null? 运算符与字段名一起使用，例如：null? graduated_at，set? parent_id

一个复杂的查询示例，用于查找没有 COBOL 经验、年龄超过 18 岁、最近更新的记录以及非菜的昵称的 Ruby on Rails 程序员：

("Ruby" OR "Rails") -cobol, age >= 18, updated_at > 2009-01-01 && nickname !~ l33t

更多关于查询语言的信息，请参考项目 wiki。

4. 项目安装方式

Scoped Search 项目可以通过以下方式安装：

• 将上述 Gemfile 中的代码添加到您的项目 Gemfile 中，并运行 bundle install
• 通过源代码，从 GitHub 仓库克隆项目：https://github.com/wvanbergen/scoped_search

以上是 Scoped Search 的技术文档，希望对您有所帮助。