Mongoid Slug 技术文档

1. 安装指南

1.1 添加 Gem 到 Gemfile

首先，将 mongoid-slug 添加到你的 Gemfile 中：

gem 'mongoid-slug'

1.2 安装 Gem

运行以下命令来安装 Gem：

bundle install

1.3 生成索引

安装完成后，运行以下命令来生成索引：

rake db:create_indexes

2. 项目的使用说明

2.1 设置 Slug

在 Mongoid 模型中，通过 slug 方法来设置 URL slug 或 permalink。以下是一个示例：

class Book
  include Mongoid::Document
  include Mongoid::Slug

  field :title
  slug :title
end

2.2 查找文档

你可以通过 slug 来查找文档：

# GET /books/a-thousand-plateaus
book = Book.find params[:book_id]

Mongoid Slug 会根据传入的参数自动判断是使用 slugs 字段还是 _id 字段进行查找。

2.3 更新现有记录

对于现有记录，你可以通过以下 rake 任务来设置 slug：

rake mongoid_slug:set

你还可以指定模型名称来设置特定模型的 slug：

rake mongoid_slug:set[Model1,Model2]

3. 项目 API 使用文档

3.1 自定义 Slug 生成

默认情况下，Mongoid Slug 使用 stringex 生成 slug。如果你需要自定义 slug 生成方式，可以通过以下两种方式实现：

全局配置

在 config/initializers/mongoid_slug.rb 中配置一个块：

Mongoid::Slug.configure do |c|
  c.slug = proc { |cur_obj|
    cur_obj.slug_builder.to_url
  }
end

在模型中配置

class Caption
  include Mongoid::Document
  include Mongoid::Slug

  slug do |cur_obj|
    cur_obj.slug_builder.to_url
  end
end

3.2 索引生成

默认情况下，Mongoid Slug 会自动为 slug 生成索引。你可以通过设置 index: false 来跳过索引生成：

class Employee
  include Mongoid::Document
  include Mongoid::Slug

  field :name

  slug :name, index: false
end

3.3 范围限制

你可以通过 scope 选项来限制 slug 的范围：

class Company
  include Mongoid::Document

  references_many :employees
end

class Employee
  include Mongoid::Document
  include Mongoid::Slug

  field :name
  referenced_in :company

  slug :name, scope: :company
end

4. 项目安装方式

4.1 通过 Gemfile 安装

将 mongoid-slug 添加到 Gemfile 中，然后运行 bundle install 进行安装。

4.2 手动安装

你也可以手动安装 Gem：

gem install mongoid-slug

4.3 生成索引

安装完成后，运行以下命令来生成索引：

rake db:create_indexes

通过以上步骤，你可以成功安装并使用 Mongoid Slug 来生成和管理 URL slug。