RequireJS for Rails 技术文档

1. 安装指南

首先，确保您使用的 Rails 版本为 3 或更高版本。在 Rails 应用的 Gemfile 中添加以下代码：

gem 'requirejs-rails'

然后执行以下命令安装 Gem：

bundle install

2. 项目的使用说明

在安装完成后，您需要进行以下步骤来使用 RequireJS：

1. 删除 application.js 文件中所有的 Sprockets 指令，例如 //= require jquery。
2. 在应用的布局文件（通常是 app/views/layouts/application.html.erb）中使用 requirejs_include_tag 标签：

<%= requirejs_include_tag "application" %>

3. 将您的 JavaScript 或 CoffeeScript 代码组织成模块，使用 define()：

# app/assets/javascripts/views/tweet_view.js.coffee

define ['backbone'], (Backbone) ->
  class TweetView extends Backbone.View
    # ...

4. 在顶层模块（如 application.js）中使用 require() 实例化应用：

# app/assets/javascripts/application.js.coffee

require ['jquery', 'backbone', 'TheApp'], ($, Backbone, TheApp) ->

  $ ->
    window.App = new TheApp()
    Backbone.history.start
      pushState: true
    window.App.start()

5. 当准备就绪时，为生产部署构建资产：

rake assets:precompile

3. 项目API使用文档

requirejs Include_tag 是一个辅助方法，用于生成包含 RequireJS 库的 script 标签。它可以接受一个可选的块，该块返回一个哈希，用于填充额外的 data-... 属性。

<%= requirejs_include_tag "page1" do |controller|
      { 'foo' => controller.foo,
        'bar' => controller.bar
      }
    end
%>

这将生成如下所示的 script 标签：

<script data-main="/assets/page1.js" data-foo="..." data-bar="..." src="/assets/require.js"></script>

4. 项目安装方式

项目的安装方式已在“安装指南”部分中详细说明。简而言之，您需要将 requirejs-rails 添加到您的 Gemfile 中，然后执行 bundle install 命令。之后按照使用说明配置和整合 RequireJS 到您的 Rails 应用中。