DRY CRUD 技术文档

1. 安装指南

要安装 dry_crud，可以直接使用 dry_crud 的应用模板创建 Rails 应用：

rails new APP_NAME -m https://raw.github.com/codez/dry_crud/master/template.rb

如果您的应用已经存在，或者您希望自行安装，那么可以安装 Gem (gem install dry_crud)，将其添加到 Gemfile 中，并运行生成器。安装完成后，可以从 Gemfile 中移除 dry_crud 条目，因为它不再是必需的。

rails generate dry_crud [--templates haml] [--tests rspec]

默认情况下，dry_crud 会生成 ERB 模板和 Test::Unit 测试。通过上述选项可以生成 HAML 模板和/或 RSpec 示例。

2. 项目的使用说明

为了使用 dry_crud，您需要对 CRUD 控制器进行一些简单的扩展和配置：

• 让您的控制器继承自 CrudController 并定义 permitted_attrs（用于 StrongParameters）。
• 重写模型的 to_s 方法以在标题中提供人性化的表示。
• 可选地，在模型中定义一个 list 范围，用于 index 动作。
• 可选地，在模型中定义一个 options_list 范围，用于下拉选择。

从版本 5.0 开始，dry_crud 的主要和次要版本号将与 Rails 保持同步，并且仅支持匹配的 Rails 版本。

3. 项目API使用文档

dry_crud 主要通过生成器使用，所有代码都驻留在您的应用中，可以自由检查和扩展。以下是主要类的简要说明：

• CrudController：提供 CRUD 功能的基本控制器类。
• TableHelper 和 FormHelper：包含用于创建表单和表格的辅助方法。
• Crud::Searchable：实现简单的搜索功能。

4. 项目安装方式

除了使用应用模板和 Gem 安装之外，dry_crud 还可以作为 Rails 引擎直接使用。只需将 gem 添加到 Gemfile 中，然后可以根据需要生成单个文件：

rails generate dry_crud:file list/index.html.erb

如果应用中存在 dry_crud 文件，它将被使用；如果不存在，则使用引擎中的文件。这适用于控制器、辅助方法和视图模板。

通过以上指南，您可以开始使用 dry_crud 来简化 Rails 项目中的 CRUD 操作，并通过定制来满足特定需求。dry_crud 的目标是提供一个简洁轻量级的起点，以帮助您高效地开发应用程序。