Humanizer 项目技术文档

1. 安装指南

1.1 基本安装

1. 在您的 Gemfile 中添加 humanizer：

   gem "humanizer"
   

2. 在终端中运行以下命令以安装 gem 并生成相关文件：

   bundle
   rails g humanizer
   

1.2 高级安装

• 安装所有语言环境：

  rails g humanizer --all-locales
  

• 显示可用语言环境：

  rails g humanizer --show-locales
  

• 安装选定的语言环境：

  rails g humanizer en fi de
  

2. 项目使用说明

2.1 在模型中使用

1. 在您的模型中包含 Humanizer，并添加 #require_human_on 方法，例如：

   class User < ActiveRecord::Base
     include Humanizer
     require_human_on :create
   end
   

2. 在表单中提问，例如：

   <%= f.label :humanizer_answer, @model.humanizer_question %>
   <%= f.text_field :humanizer_answer %>
   <%= f.hidden_field :humanizer_question_id %>
   

3. 如果您使用 attr_accessible，请记住将 :humanizer_answer 和 :humanizer_question_id 列入白名单。

4. 如果您使用 strong_parameters，请记住允许 :humanizer_answer 和 :humanizer_question_id。

2.2 配置

默认翻译文件位于 config/locales/ 目录下。您可以通过添加或修改 locales 文件中的条目来轻松添加或更改问题和答案对。

2.3 跳过验证

在测试或 Rails 控制台中，您可能希望跳过 humanizer 验证。可以通过在模型中添加一个简单的属性来实现，例如：

attr_accessor :bypass_humanizer
require_human_on :create, unless: :bypass_humanizer

当 bypass_humanizer 为 true 时，验证将被跳过。

2.4 重新加载问题

如果您希望为用户提供更改问题的选项，可以使用 #change_humanizer_question 方法。为确保当前问题不会再次被提问，可以将当前问题的 ID 传递给该方法，例如：

@user.change_humanizer_question(params[:user][:humanizer_question_id])

3. 项目API使用文档

3.1 require_human_on 方法

该方法用于在模型中指定何时需要进行人机验证。例如：

require_human_on :create

3.2 change_humanizer_question 方法

该方法用于重新加载问题，避免重复提问。例如：

@user.change_humanizer_question(params[:user][:humanizer_question_id])

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 humanizer：

gem "humanizer"

然后运行 bundle 命令进行安装。

4.2 生成器命令

使用以下命令生成相关文件：

rails g humanizer

4.3 高级选项

• 安装所有语言环境：

  rails g humanizer --all-locales
  

• 显示可用语言环境：

  rails g humanizer --show-locales
  

• 安装选定的语言环境：

  rails g humanizer en fi de
  

通过以上步骤，您可以成功安装并使用 Humanizer 项目。