Mongoid-Tree 项目技术文档

1. 安装指南

环境要求

在使用 Mongoid-Tree 前，请确保您的项目中已经安装了 Mongoid，版本要求为 mongoid (>= 4.0, < 10.0)。如果您使用的是 mongoid 3.x 或 2.x 版本，请使用对应的 mongoid-tree 版本。

安装步骤

1. 将 mongoid-tree 添加到您的 Gemfile 文件中：

   gem 'mongoid-tree', require: 'mongoid/tree'
   

2. 如果您需要获取最新的开发版本，可以使用以下配置：

   gem 'mongoid-tree', git: 'git://github.com/benedikt/mongoid-tree', branch: :main
   

3. （可选）如果您希望在某些特定文件中显式地引入 mongoid-tree，可以在 Gemfile 中添加 require: nil 选项，并在需要的地方手动引入 require 'mongoid/tree'。

4. 运行以下命令安装依赖：

   bundle install
   

2. 项目使用说明

快速开始

在您的 Mongoid 文档中包含 Mongoid::Tree 模块，以实现树状结构：

class Node
  include Mongoid::Document
  include Mongoid::Tree
end

实用方法

Mongoid-Tree 提供了多种实用方法来帮助您在树结构中导航：

Node.root
Node.roots
Node.leaves

node.root
node.parent
node.children
node.ancestors
node.ancestors_and_self
node.descendants
node.descendants_and_self
node.siblings
node.siblings_and_self
node.leaves

此外，您还可以检查文档在树中的位置：

node.root?
node.leaf?
node.depth
node.ancestor_of?(other)
node.descendant_of?(other)
node.sibling_of?(other)

排序

默认情况下，Mongoid-Tree 不对子节点进行排序。若要启用排序，请包含 Mongoid::Tree::Ordering 模块：

class Node
  include Mongoid::Document
  include Mongoid::Tree
  include Mongoid::Tree::Ordering
end

遍历

使用 Mongoid::Tree::Traversal 模块，您可以用不同的遍历方法遍历树：

class Node
  include Mongoid::Document
  include Mongoid::Tree
  include Mongoid::Tree::Traversal
end

node.traverse(:breadth_first) do |n|
  # 在此处处理 Node n
end

删除

Mongoid-Tree 默认不处理节点的删除。但是，它提供了几种策略来帮助您处理被删除文档的子节点。您可以将它们作为 before_destroy 回调添加到您的类中。

3. 项目API使用文档

有关 Mongoid-Tree 的 API 文档，请访问 RubyDoc 网站查看 Mongoid::Tree 模块的相关信息。

4. 项目安装方式

请参考本文档的“安装指南”部分获取 Mongoid-Tree 的安装方式。