Mongoid Orderable 技术文档

1. 安装指南

在您的Ruby项目中，首先确保您的项目满足以下依赖版本要求：

• Ruby 2.6+
• Mongoid 7.0+
• Rails 5.2+

然后，在您的项目Gemfile文件中添加以下依赖：

gem 'mongoid_orderable'

之后，执行以下命令安装Gem：

bundle install

2. 项目的使用说明

要使用Mongoid Orderable，首先需要在您的模型中包含Mongoid::Orderable模块，并调用orderable方法。以下是一个基本示例：

class MyModel
  include Mongoid::Document
  include Mongoid::Orderable

  orderable
end

此外，您还可以自定义一些参数，例如：

• scope: 定义排序索引的范围。
• field: 指定用于排序的字段。
• base: 定义排序的起始值。
• index: 是否在MongoDB中为排序字段创建索引。

例如：

class MyModel
  include Mongoid::Document
  include Mongoid::Orderable

  orderable scope: :drawer, field: :pos, base: 0, index: false
end

3. 项目API使用文档

以下是Mongoid Orderable提供的一些主要API方法：

移动位置

item.move_to 2 # 更改位置
item.move_to! 2 # 更改并保存位置
item.move_to = 2 # 可赋值方法

# 使用符号位置
item.move_to :top
item.move_to :bottom
item.move_to :higher
item.move_to :lower

# 生成的方法
item.move_to_top
item.move_to_bottom
item.move_higher
item.move_lower

item.next_items # 返回列表中位置更高的项目集合
item.previous_items # 返回列表中位置更低的项目集合

item.next_item # 返回列表中的下一个项目
item.previous_item # 返回列表中的前一个项目

多个字段

class Book
  include Mongoid::Document
  include Mongoid::Orderable

  orderable base: 0
  orderable field: sno, as: :serial_no
end

这将定义两个不同的可排序字段，以及相应的方法。

嵌入文档

class Question
  include Mongoid::Document
  include Mongoid::Orderable

  embedded_in :survey

  orderable
end

确保在使用嵌入文档时正确设置cascade_callbacks: true。

禁用排序

class Book
  include Mongoid::Document
  include Mongoid::Orderable

  field :track_position, type: Boolean

  orderable if: :track_position, unless: -> { created_at < Date.parse('2020-01-01') }
end

4. 项目安装方式

如上所述，项目安装方式为：

• 确保项目满足依赖版本要求。
• 在Gemfile中添加gem 'mongoid_orderable'。
• 执行bundle install命令。

按照以上步骤操作，即可成功安装Mongoid Orderable并在项目中使用。