Surveyor 项目技术文档

1. 安装指南

环境要求

Surveyor 支持以下环境：

• Ruby 版本：2.0.0 和 2.1.1
• Rails 版本：3.2 和 4.0

依赖项包括：

• HAML
• Sass
• Formtastic

安装步骤

1. 将 Surveyor 添加到 Gemfile 中：

   gem "surveyor"
   

2. 执行以下命令进行安装和迁移：

   bundle install
   script/rails generate surveyor:install
   bundle exec rake db:migrate
   

3. 解析示例调查文件：

   bundle exec rake surveyor FILE=surveys/kitchen_sink_survey.rb
   

4. 启动应用程序，访问 /surveys 路径，查看并尝试响应调查。

2. 项目使用说明

Surveyor 是一个用于在 Rails 应用程序中发布调查的开发者工具。调查使用 Surveyor DSL (领域特定语言) 编写。这种 DSL 使得导入长调查变得更为容易，并允许非程序员编写、编辑和审阅调查。

如果你的 Rails 应用程序需要询问用户问题作为调查、小测验或问卷的一部分，你应该考虑使用 Surveyor。此 gem 被设计用于向大量人群发布临床研究调查，但它可以用于任何类型的调查。

Surveyor 作为 Ruby gem 分发的 Rails 引擎，意味着你可以在不维护分支的情况下轻松地在你的 Rails 应用程序中覆盖或扩展其行为。

3. 项目 API 使用文档

Surveyor 提供了丰富的 API，允许自定义所有模型、视图、控制器以及助手和路由。以下是部分 API 的概述：

• ResponseSet 方法：提供了一些方法来支持必填问题，例如 make_question_mandatory 和 make_questionOptional。

更多 API 细节，请参考官方文档。

4. 项目安装方式

Surveyor 的安装方式已在“安装指南”部分详细说明。以下是简要概述：

1. 在 Gemfile 中添加 Surveyor 依赖。
2. 运行 bundle install 命令安装依赖。
3. 使用 script/rails generate surveyor:install 生成初始配置。
4. 运行 bundle exec rake db:migrate 进行数据库迁移。
5. 解析示例调查文件并启动应用程序进行测试。

以上是 Surveyor 项目的技术文档，希望对您有所帮助。