Backbone on Rails 技术文档

1. 安装指南

1.1 安装依赖

首先，确保你的系统已经安装了 Ruby 和 Rails。然后，在项目的 Gemfile 中添加以下内容：

gem 'backbone-on-rails'

接着，运行以下命令来安装依赖：

bundle install

1.2 生成项目结构

安装完成后，运行以下命令来生成 Backbone.js 的基本项目结构：

rails generate backbone:install

此命令会在 app/assets/javascripts 目录下生成一个基本的 Backbone.js 应用结构。

1.3 重启服务器

安装完成后，记得重启 Rails 服务器以确保所有更改生效。

2. 项目的使用说明

2.1 生成脚手架

你可以使用以下命令来生成一个 Backbone.js 的脚手架：

rails generate backbone:scaffold NAME

其中，NAME 是你想要创建的模型名称。例如，如果你想创建一个名为 planet 的模型，可以运行：

rails generate backbone:scaffold planet

此命令会生成以下文件结构：

app/assets/
├── javascripts
│   ├── application.js
│   ├── space_app.js.coffee
│   ├── collections
│   │   └── planets.js.coffee
│   ├── models
│   │   └── planet.js.coffee
│   ├── routers
│   │   └── planets_router.js.coffee
│   └── views
│       └── planets
│           └── planets_index.js.coffee
└── templates
    └── planets
        └── index.jst.eco

2.2 自定义生成选项

你可以通过以下选项来自定义生成的内容：

• 自定义清单文件：使用 --manifest 选项指定清单文件名称。
• 生成 JavaScript：使用 --javascript 选项生成 JavaScript 文件而不是 CoffeeScript。
• 自定义应用名称：使用 --app 选项指定自定义应用名称。
• 自定义目录结构：使用 --dir 选项指定生成的代码所在的子目录。
• 使用 Handlebars 模板：使用 --template=hbs 选项生成 Handlebars 模板文件。
• 自定义模板命名空间：使用 --template_namespace 选项指定模板命名空间。

例如：

rails generate backbone:scaffold planet --javascript --app=CustomApp --dir=custom_app --template=hbs --template_namespace=SHT

2.3 删除生成的文件

如果你想删除通过脚手架生成的文件，可以使用以下命令：

rails destroy backbone:scaffold planet

3. 项目 API 使用文档

3.1 模型 (Model)

生成的模型文件位于 app/assets/javascripts/models 目录下。你可以在此文件中定义模型的属性和方法。

例如，planet.js.coffee 文件可能如下所示：

class CustomApp.Models.Planet extends Backbone.Model
  defaults:
    name: ""
    distance: 0

3.2 集合 (Collection)

生成的集合文件位于 app/assets/javascripts/collections 目录下。你可以在此文件中定义集合的 URL 和其他属性。

例如，planets.js.coffee 文件可能如下所示：

class CustomApp.Collections.Planets extends Backbone.Collection
  model: CustomApp.Models.Planet
  url: '/planets'

3.3 视图 (View)

生成的视图文件位于 app/assets/javascripts/views 目录下。你可以在此文件中定义视图的渲染逻辑。

例如，planets_index.js.coffee 文件可能如下所示：

class CustomApp.Views.PlanetsIndex extends Backbone.View
  template: JST['planets/index']

  render: ->
    @$el.html(@template(planets: @collection.toJSON()))
    this

3.4 路由器 (Router)

生成的路由器文件位于 app/assets/javascripts/routers 目录下。你可以在此文件中定义路由和对应的动作。

例如，planets_router.js.coffee 文件可能如下所示：

class CustomApp.Routers.Planets extends Backbone.Router
  routes:
    "": "index"

  index: ->
    @collection = new CustomApp.Collections.Planets()
    view = new CustomApp.Views.PlanetsIndex(collection: @collection)
    $('#container').html(view.render().el)

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 backbone-on-rails gem，然后运行 bundle install 来安装。

4.2 生成项目结构

安装完成后，运行 rails generate backbone:install 来生成项目的基本结构。

4.3 生成脚手架

使用 rails generate backbone:scaffold NAME 来生成 Backbone.js 的脚手架。

4.4 自定义生成选项

你可以通过 --manifest、--javascript、--app、--dir、--template 和 --template_namespace 等选项来自定义生成的内容。

4.5 删除生成的文件

使用 rails destroy backbone:scaffold NAME 来删除通过脚手架生成的文件。

---

通过以上步骤，你可以轻松地在 Rails 项目中使用 Backbone.js，并根据需要自定义生成的内容。希望这篇文档能帮助你更好地理解和使用 backbone-on-rails 项目。