Resort 项目技术文档

本文档旨在帮助用户安装和使用Resort项目，该项目为Rails（4+）模型提供了排序功能。

1. 安装指南

首先，通过以下命令安装Resort：

$ gem install resort

或者在Gemfile中添加以下代码：

gem 'resort'

然后执行bundle install。

2. 使用说明

迁移

对于想要排序的模型，首先运行以下迁移命令：

$ rails generate resort:migration product
$ rake db:migrate

模型配置

在模型中添加resort!方法：

class Product < ActiveRecord::Base
  resort!
end

如果需要限制排序范围，例如，将每个ProductLine视为一个独立的可排序产品树，可以重写siblings方法：

class Product < ActiveRecord::Base
  resort!

  def siblings
    # 仅包含同一产品线的产品
    self.product_line.products
  end
end

并发处理

多个用户同时修改同一列表可能会出现问题，因此建议将更改包装在事务中：

Product.transaction do
  my_product.append_to(another_product)
end

3. 项目API使用文档

创建产品时，该产品将被追加到列表的最后。

以下是与Product相关的API方法：

• first? — 如果元素是列表的第一个元素，则返回true。
• append_to(other_element) — 将元素追加到另一个元素之后。
• prepend — 将元素移动到列表的开头（设置为第一个元素）。
• next — 返回列表中的下一个元素。
• previous — 返回列表中的前一个元素。

Product类有一个名为ordered的新作用域，返回按顺序排列的产品。

示例

以下是使用Product类的示例：

获取顺序排列的产品：

Product.first_in_order # 返回第一个排序的产品。
Product.last_in_order # 返回最后一个排序的产品。
Product.ordered # 返回所有按顺序排列的产品，返回的是一个数组，而不是关系！

使用作用域或条件获取排序后的产品：

Product.where('price > 10').ordered # => 价格大于10的排序产品数组
Product.with_custom_scope.ordered # => 使用自定义条件的排序产品数组

修改产品列表：

product = Product.create(:name => 'Bread')
product.first? # => true

another_product = Product.create(:name => 'Milk')
yet_another_product = Product.create(:name => 'Salami')

yet_another_product.append_to(product) # 将产品放置在第一个产品之后

Product.ordered.map(&:name) # => ['Bread', 'Salami', 'Milk']

检查邻居：

product = Product.create(:name => 'Bread')
second_product = Product.create(:name => 'Milk')
third_product = Product.create(:name => 'Salami')

second_product.previous.name # => 'Bread'
second_product.next.name # => 'Salami'

third_product.next # => nil

根据产品供应商进行不同的排序：

class Product < ActiveRecord::Base
  resort!

  belongs_to :vendor

  def siblings
    self.vendor.products
  end
end

bread = Product.create(:name => 'Bread', :vendor => Vendor.where(:name => 'Bread factory').first)
bread.first? # => true

milk = Product.create(:name => 'Milk', :vendor => Vendor.where(:name => 'Cow world').first)
milk.first? # => true

# Bread和Milk不是邻居

4. 项目安装方式

请参考“安装指南”部分。

以上就是Resort项目的安装和使用说明，祝您使用愉快！