Pacecar 技术文档

1. 安装指南

首先，确保您的项目已经使用 Ruby on Rails 4.x 版本。接下来，在您的 Gemfile 文件中添加以下依赖：

gem 'pacecar'

然后执行以下命令来安装该 gem：

bundle install

2. 项目的使用说明

Pacecar 为 ActiveRecord 类通过数据库列内省添加了作用域方法和其他常用功能。Pacecar 会自动将 Pacecar::Helpers 模块包含到所有 ActiveRecord::Base 类中。

要获取所有 Pacecar 功能，您需要在类中包含 Pacecar：

class User < ActiveRecord::Base
  include Pacecar
end

如果您只想获取某些子集（例如，仅状态功能），您可以像下面这样只包含所需的模块：

class Post < ActiveRecord::Base
  include Pacecar::State
end

Pacecar 支持:mysql、postgres 和 sqlite 数据库驱动程序，并与 Rails 4.x 版本兼容。

3. 项目API使用文档

以下是一些如何使用 Pacecar 的示例：

数据库列查询

获取 approved_at 列非空或空的记录：

User.approved_at_present
User.approved_at_missing

获取 first_name 列非空或空的记录：

User.first_name_present
User.first_name_missing

按照 first_name 列排序记录（默认为 'asc'，可以指定覆盖）：

User.by_first_name
User.by_first_name(:asc)
User.by_first_name(:desc)

获取属性与特定术语完全匹配的记录：

User.first_name_equals('John')

布尔列查询

获取所有管理员或非管理员的记录：

User.admin
User.not_admin

多态关联查询

获取 owner_type 为 User 的记录：

Post.for_owner_type(User)

状态列查询

获取处于特定状态或不在特定状态的记录：

Post.publication_state_draft
Post.post_type_not_open

在实例上查询状态：

Post.first.publication_state_draft?
Post.last.post_type_not_open?

限制查询

获取前 x 条记录：

User.limited(10)

命名作用域

由于这些都是作用域，您可以组合使用它们。获取有 first_name 设置且是管理员的所有用户：

User.first_name_present.admin

4. 项目安装方式

请遵循以上提到的安装指南。

确保您的项目使用的是兼容版本的 Ruby 和 Rails，并在 Gemfile 中添加 Pacecar 依赖。然后运行 bundle install 来安装 gem。

以上就是 Pacecar 的技术文档，希望对您使用和了解这个项目有所帮助。