REST in Place 项目下载及安装教程

1. 项目介绍

REST in Place 是一个 AJAX Inplace-Editor，它与 RESTful 控制器进行通信。该项目要求服务器端代码完全符合 RESTful 规范，即使用 HTTP PUT 方法更新记录，并在请求带有 "Accept: application/json" 头时以 JSON 格式返回对象。编辑器通过向服务器发送 PUT 请求来更新值，并在之后获取更新后的记录以显示更新后的值。

2. 项目下载位置

REST in Place 项目的源代码托管在 GitHub 上。你可以通过以下命令克隆项目到本地：

git clone https://github.com/janv/rest_in_place.git

3. 项目安装环境配置

3.1 环境要求

• Rails: REST in Place 需要 Rails >= 3.1 版本，因为它通过资产管道加载。
• jQuery: 项目依赖于 jQuery，但不会自动安装 jquery-rails 依赖，因此你需要确保 jQuery 已存在。
• CoffeeScript: 项目使用 CoffeeScript 编写，但如果你不熟悉 CoffeeScript，也可以将其转换为 JavaScript 使用。

3.2 环境配置示例

以下是一个简单的环境配置示例：

# 安装 Rails 和相关依赖
gem install rails -v '>= 3.1'

# 安装 jQuery
npm install jquery

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加以下行：

gem 'rest_in_place'

然后运行：

bundle install

4.2 通过 JavaScript 文件加载

你也可以通过在 app/assets/javascripts 目录下的 JavaScript 文件中手动加载 REST in Place：

//= require 'rest_in_place'

确保在加载 REST in Place 之前已经加载了 jQuery。

5. 项目处理脚本

REST in Place 提供了多种处理脚本，包括：

• 激活事件: 当开始编辑元素时触发。
• 准备事件: 当表单构建完成后触发。
• 成功事件: 当服务器成功保存数据后触发。
• 失败事件: 当服务器保存数据失败后触发。
• 更新事件: 在向服务器发送更新请求之前触发。
• 中止事件: 当用户中止编辑过程时触发。

你可以通过 jQuery 绑定这些事件：

$('#my-editable-element').bind('success.rest-in-place', function(event, data) {
  console.log("Yay it worked, The new value is", data.whatever);
});

通过这些事件，你可以自定义 REST in Place 的行为，例如在成功保存后执行特定的操作。

---

以上是 REST in Place 项目的下载及安装教程。希望这些信息能帮助你顺利安装和使用该项目。