High Voltage 项目技术文档

1. 安装指南

1.1 通过 Gem 安装

你可以通过以下两种方式安装 High Voltage：

1.1.1 使用命令行安装

在终端中运行以下命令：

$ gem install high_voltage

1.1.2 通过 Gemfile 安装

在项目的 Gemfile 中添加以下内容：

gem 'high_voltage', '~> 4.0.0'

然后运行 bundle install 来安装 Gem。

2. 项目的使用说明

2.1 创建静态页面

High Voltage 用于管理 Rails 应用中的静态页面，如“关于我们”、“联系我们”等。

2.1.1 创建页面目录

首先，创建一个存放静态页面的目录：

$ mkdir app/views/pages

2.1.2 创建页面文件

在 app/views/pages 目录下创建静态页面文件，例如 about.html.erb：

$ touch app/views/pages/about.html.erb

2.1.3 链接静态页面

在应用的任意位置，可以通过以下代码链接到静态页面：

<%= link_to '关于我们', page_path('about') %>

2.2 嵌套页面

你可以在目录结构中嵌套页面，以适应 URL 结构：

<%= link_to 'Q4 报告', page_path('about/corporate/policies/HR/en_US/biz/sales/Quarter-Four') %>

2.3 获取静态页面列表

你可以通过调用 HighVoltage.page_ids 获取静态页面的列表，这在构建站点地图时非常有用。例如：

HighVoltage.page_ids.each do |page|
  add page, changefreq: 'monthly'
end

3. 项目API使用文档

3.1 路由配置

3.1.1 默认路由

默认情况下，静态页面的路由为 /pages/:id，其中 :id 是视图文件的名称。

3.1.2 自定义路由

如果你想将静态页面路由到其他位置（例如首页），可以这样做：

get 'pages/home' => 'high_voltage/pages#show', id: 'home'

3.2 根路径配置

你可以配置根路径指向一个 High Voltage 页面：

# config/initializers/high_voltage.rb
HighVoltage.configure do |config|
  config.home_page = 'home'
end

3.3 顶级路由

你可以移除 URL 路径中的 pages 目录，直接从根路径提供页面：

# config/initializers/high_voltage.rb
HighVoltage.configure do |config|
  config.route_drawer = HighVoltage::RouteDrawers::Root
end

3.4 禁用默认路由

你可以通过以下配置完全禁用默认路由：

# config/initializers/high_voltage.rb
HighVoltage.configure do |config|
  config.routes = false
end

4. 项目安装方式

4.1 通过 Gem 安装

4.1.1 使用命令行安装

$ gem install high_voltage

4.1.2 通过 Gemfile 安装

在 Gemfile 中添加：

gem 'high_voltage', '~> 4.0.0'

然后运行 bundle install。

4.2 手动安装

如果你不想使用 Gem，可以手动将 High Voltage 的源码下载到你的项目中，并按照其提供的说明进行配置。

5. 自定义控制器

5.1 创建自定义控制器

如果你需要对静态页面进行额外的控制（如身份验证、布局切换等），可以创建一个自定义的 PagesController：

$ rails generate controller pages

5.2 禁用默认路由

在 config/initializers/high_voltage.rb 中禁用默认路由：

HighVoltage.configure do |config|
  config.routes = false
end

5.3 定义新路由

在 config/routes.rb 中定义新路由：

get "/pages/*id" => 'pages#show', as: :page, format: false

5.4 修改控制器

在 PagesController 中包含 High Voltage 的静态页面模块：

class PagesController < ApplicationController
  include HighVoltage::StaticPage

  before_action :authenticate
  layout :layout_for_page

  private

  def layout_for_page
    case params[:id]
    when 'home'
      'home'
    else
      'application'
    end
  end
end

6. 本地化

6.1 设置本地化

在 ApplicationController 中添加本地化设置：

before_action :set_locale

def set_locale
  I18n.locale = params[:locale] || I18n.default_locale
end

6.2 禁用默认路由

HighVoltage.configure do |config|
  config.routes = false
end

6.3 定义本地化路由

scope "/:locale", locale: /en|bn|hi/ do
  get "/pages/:id" => "high_voltage/pages#show", :as => :page, :format => false
end

6.4 创建本地化页面

在 app/views/pages 目录下创建本地化页面，并在相应的本地化文件中定义内容。

7. 测试

你可以使用 RSpec 和 shoulda-matchers 来测试静态页面：

describe PagesController, '#show' do
  %w(earn_money screencast about contact).each do |page|
    context "on GET to /pages/#{page}" do
      before do
        get :show, id: page
      end

      it { should respond_with(:success) }
      it { should render_template(page) }
    end
  end
end

8. 贡献

如果你希望为 High Voltage 项目做出贡献，请参考项目的 CONTRIBUTING.md 文件。

9. 许可证

High Voltage 是 thoughtbot 公司开发的开源项目，遵循 MIT 许可证。详细信息请参阅 LICENSE 文件。