Rails-Dev-Tweaks 技术文档

1. 安装指南

rails-dev-tweaks 是一个用于优化 Rails（3.1+）开发体验的 Gem。它通过调整 Rails 的自动加载机制，减少不必要的代码重新加载，从而提升开发效率。

安装步骤

1. 在您的 Rails 项目的 Gemfile 中添加以下行：

   gem 'rails-dev-tweaks', '~> 1.1'
   

2. 运行 bundle install 命令以安装 Gem。

2. 项目的使用说明

rails-dev-tweaks 提供了一套默认配置，适用于大多数 Rails 应用。以下是其主要功能：

• 资源请求不会重新加载应用代码：这意味着在开发过程中，对静态资源（如 CSS、JavaScript 文件）的请求不会触发应用代码的重新加载。这通常不会影响开发，除非您在资源中使用了自定义的 Sass 函数或引用了应用代码。

• XHR 请求会重新加载应用代码：与之前的版本不同，rails-dev-tweaks 现在会在处理 XHR（Ajax）请求时重新加载应用代码。

如果您发现默认配置不符合您的需求，可以通过简单的配置调整来覆盖默认行为。

3. 项目 API 使用文档

3.1 细粒度自动加载配置

您可以通过在应用或环境配置中添加配置块来指定自动加载规则。这些规则通过 skip（排除）和 keep（包含）来定义，后定义的规则会覆盖之前的规则。

config.dev_tweaks.autoload_rules do
  # 使用命名匹配器（见下文）。此匹配器会清除所有默认匹配器
  keep :all

  # 排除所有以 /search 开头的请求
  skip '/search'
  # 但包含包含 smerch 的路由
  keep /smerch/

  # 使用块来检查请求
  skip { |request| request.post? }
end

默认的自动加载规则适用于大多数开发场景：

config.dev_tweaks.autoload_rules do
  keep :all

  skip '/favicon.ico'
  skip :assets
  keep :forced
end

默认情况下，每个跳过自动加载钩子的请求都会在日志中生成一条额外的日志行，以便您了解发生了什么。如果您希望日志更简洁，可以禁用此日志消息：

config.dev_tweaks.log_autoload_notice = false

3.2 命名匹配器

命名匹配器是定义在 RailsDevTweaks::GranularAutoload::Matchers:: 下的类，它们定义了一个 call 方法，该方法接收一个 ActionDispatch::Request 对象，并返回一个布尔值，表示该请求是否匹配。匹配器名称通过 "#{name.to_s.classify}Matcher" 转换为模块名。例如，:assets 会指定 RailsDevTweaks::GranularAutoload::Matchers::AssetMatcher。

任何传递给 skip 或 keep 的额外参数都将作为初始化参数传递给匹配器。

3.2.1 :all

匹配所有传递给它的请求。

3.2.2 :assets

Rails 3.1 集成了 Sprockets 作为其资源打包工具。不幸的是，由于资源打包工具是通过传统的 Rails 调度基础设施挂载的，它隐藏在 Rails 自动加载器（卸载器）后面。此匹配器将匹配任何路由到 Sprockets 的请求（特别是任何挂载的 Sprockets::Base 实例）。

3.2.3 :forced

为了帮助您在需要时进行实时调试，此匹配器将匹配任何将 force_autoload 设置为参数（GET 或 POST）的请求，或者将 Force-Autoload 头设置为某个值的请求。

如果您正在调试 jQuery Ajax 请求，以下代码片段将在浏览器的会话期间启用强制自动加载：

$.ajaxSetup({"beforeSend": function(xhr) {xhr.setRequestHeader("Force-Autoload", "true")} })

3.2.4 :path

通过正则表达式匹配请求的路径。

keep :path, /thing/ # 匹配路径中包含 "thing" 的任何请求。

注意，keep '/stuff' 是 keep :path, /^\/stuff/ 的简写。同样，keep /thing/ 是 keep :path, /thing/ 的简写。

3.2.5 :xhr

匹配任何 XHR 请求（通过 request.xhr?）。这里的假设是您通常不会实时调试 XHR 请求，而是在运行新响应代码之前刷新触发它们的页面。

4. 项目安装方式

rails-dev-tweaks 的安装非常简单，只需在 Gemfile 中添加相应的 Gem 并运行 bundle install 即可。具体步骤已在“安装指南”部分详细说明。

---

通过本文档，您应该能够顺利安装、配置并使用 rails-dev-tweaks 来优化您的 Rails 开发体验。如果您有任何问题或需要进一步的帮助，请参考项目的官方文档或社区支持。