Switch User 项目技术文档

1. 安装指南

1.1 添加 Gem

首先，在项目的 Gemfile 中添加 switch_user 依赖：

gem "switch_user"

1.2 解决兼容性问题

如果你在使用较旧版本的 Rails（<4），可能会遇到以下错误：

undefined method `before_action' for SwitchUserController:Class

此时，你可以使用以下 Gem 来解决兼容性问题：

gem "rails3-before_action"

1.3 生成配置文件

如果你需要自定义配置，可以运行以下命令生成配置文件：

rails g switch_user:install

生成的配置文件将位于 config/initializers/switch_user.rb。

2. 项目的使用说明

2.1 在布局页面中添加切换用户的选择框

在项目的布局页面中添加以下代码，以便用户可以切换当前用户：

ERB 示例：

<%= switch_user_select %>

HAML 示例：

= switch_user_select

2.2 自定义样式

如果你需要为选择框添加类或样式，可以使用以下代码：

ERB 示例：

<%= switch_user_select class: 'special-select', styles: 'width: 220px' %>

HAML 示例：

= switch_user_select class: 'special-select', styles: 'width: 220px'

2.3 手动切换用户

如果用户数量较多，选择框可能不是最佳选择。此时，你可以手动调用切换用户的请求：

ERB 示例：

<%= link_to user.login, "/switch_user?scope_identifier=user_#{user.id}" %>
<%= link_to admin.login, "/switch_user?scope_identifier=admin_#{admin.id}" %>

HAML 示例：

= link_to user.login, "/switch_user?scope_identifier=user_#{user.id}"
= link_to admin.login, "/switch_user?scope_identifier=admin_#{admin.id}"

2.4 路由配置

如果你的项目中有通配符路由，请确保在通配符路由之前添加以下路由：

# config/routes.rb
get 'switch_user', to: 'switch_user#set_current_user'
get 'switch_user/remember_user', to: 'switch_user#remember_user'
# 通配符路由
get ':id' => 'pages#show'

3. 项目API使用文档

3.1 配置选项

switch_user 提供了多种配置选项，以下是一些常用的配置：

SwitchUser.setup do |config|
  # 提供者可以是 :devise, :authlogic, :clearance, :restful_authentication, :sorcery, 或 {name: :devise, store_sign_in: true}
  config.provider = :devise

  # available_users 是一个哈希，
  # 键是用户模型的名称（:user, :admin 等），
  # 值是一个返回可切换用户的块。
  config.available_users = { user: -> { User.all } }

  # available_users_identifiers 是一个哈希，
  # 键应与 available_users 中的键匹配，
  # 值是用于查找用户的标识列的名称，默认为 id。
  config.available_users_identifiers = { user: :id }

  # available_users_names 是一个哈希，
  # 键应与 available_users 中的键匹配，
  # 值是将在选择框中显示的列名。
  config.available_users_names = { user: :email }

  # controller_guard 是一个块，
  # 如果返回 true，请求将继续，
  # 否则请求将被拒绝并返回 "Permission Denied"。
  config.controller_guard = ->(current_user, request) { Rails.env.development? }

  # view_guard 是一个块，
  # 如果返回 true，切换用户的选择框将显示，
  # 否则选择框将不显示。
  config.view_guard = ->(current_user, request)  { Rails.env.development? }

  # redirect_path 是一个块，
  # 返回切换用户后重定向的页面。
  config.redirect_path = ->(request, params) { '/' }
end

3.2 切换回原用户

有时你可能需要切换到一个非特权用户，然后再切换回原用户。为此，你可以进行以下配置：

config.switch_back = true
config.controller_guard = ->(current_user, request, original_user) { current_user && current_user.admin? || original_user && original_user.super_admin? }

4. 项目安装方式

4.1 通过 Gemfile 安装

在项目的 Gemfile 中添加以下代码：

gem "switch_user"

然后运行 bundle install 安装依赖。

4.2 生成配置文件

运行以下命令生成配置文件：

rails g switch_user:install

生成的配置文件将位于 config/initializers/switch_user.rb。

4.3 配置路由

在 config/routes.rb 中添加以下路由：

get 'switch_user', to: 'switch_user#set_current_user'
get 'switch_user/remember_user', to: 'switch_user#remember_user'

4.4 在布局页面中添加切换用户的选择框

在项目的布局页面中添加以下代码：

<%= switch_user_select %>

或

= switch_user_select

通过以上步骤，你就可以成功安装并使用 switch_user 项目。