make_resourceful 项目技术文档

1. 安装指南

1.1 使用 Gem 安装

对于 Rails 3.0 及以上版本，可以通过 Gem 安装 make_resourceful：

gem "make_resourceful"

1.2 使用 Git 安装

如果你更喜欢通过 Git 安装，可以使用以下命令：

$ git clone git://github.com/hcatlin/make_resourceful.git

2. 项目的使用说明

make_resourceful 是一个用于简化 Rails 控制器开发的 gem。它通过自动生成 RESTful 动作和响应，减少了重复代码的编写。以下是使用 make_resourceful 的基本步骤：

2.1 基本使用

如果你想在一个现有的控制器中使用 make_resourceful，只需将重复的代码替换为以下内容：

class FooController < ApplicationController
  make_resourceful do
    actions :all
  end
end

这三行代码将替换掉 scaffold_resource 生成器生成的默认控制器代码。

2.2 嵌套资源

make_resourceful 支持嵌套资源。你可以在 make_resourceful 块中使用 belongs_to 方法来声明嵌套关系：

make_resourceful do
  actions :all
  belongs_to :post
end

2.3 自定义 permalink

如果你需要使用自定义的 permalink，可以重写 current_object 方法：

def current_object
  @current_object ||= current_model.find_by_permalink(params[:id])
end

2.4 分页

对于分页功能，可以重写 current_objects 方法：

def current_objects
  @current_objects ||= current_model.find(:all,
    :order => "created_at DESC", :page => {:current => params[:page], :size => 10 } )
end

2.5 中间操作

如果你想在某个动作的中间执行一些操作，可以使用 before 和 after 回调：

before :show, :index do
  @page_title = "Awesome!"
end

after :create_fails do
  @page_title = "Not So Awesome!"
end

2.6 自定义响应

make_resourceful 支持自定义响应格式。你可以使用 response_for 方法来定义不同格式的响应：

response_for :show do |format|
  format.html
  format.js
  format.xml
end

response_for :update_fails do |format|
  format.html { render :action => 'edit' }
  format.json { render :json => false.to_json, :status => 422 }
end

3. 项目API使用文档

3.1 make_resourceful 方法

make_resourceful 方法是 make_resourceful 的核心。你可以在其中指定要自动生成的动作、回调代码等。

3.2 辅助方法

make_resourceful 提供了许多有用的辅助方法，例如 current_object 和 current_objects。这些方法可以在回调和视图中使用。

3.3 嵌套资源

make_resourceful 支持嵌套资源的管理。通过 belongs_to 方法，你可以轻松设置嵌套关系。

3.4 方法重写

你可以通过重写辅助方法来自定义 make_resourceful 的行为。例如，重写 current_objects 方法来实现自定义的分页逻辑。

4. 项目安装方式

4.1 通过 Gem 安装

在 Rails 项目中，将以下代码添加到 Gemfile 中：

gem "make_resourceful"

然后运行 bundle install 进行安装。

4.2 通过 Git 安装

如果你更喜欢通过 Git 安装，可以使用以下命令：

$ git clone git://github.com/hcatlin/make_resourceful.git

安装完成后，将 make_resourceful 添加到你的 Rails 项目中。

---

通过以上文档，你应该能够顺利安装和使用 make_resourceful，并根据需要进行自定义配置。