Feature 项目技术文档

1. 安装指南

首先，确保您使用的Ruby版本为2.0及以上，并且如果您使用的是Rails，版本应为4.0及以上。对于老版本的Ruby和Rails，本项目支持到以下版本：Ruby 1.9至1.2.0版，Ruby 1.8至0.7.0版，ActiveRecord/Rails 3至1.1.0版。

安装Feature库，您需要在您的项目Gemfile文件中添加以下代码：

gem 'feature'

然后执行bundle install命令来安装gem。

2. 项目的使用说明

本项目是一个功能切换（feature toggle）库，允许您在代码中动态地开启或关闭某些功能。以下是基本的使用步骤：

设置功能仓库

首先，您需要创建一个功能仓库（repository），并设置它为Feature库的仓库。

require 'feature'
repo = Feature::Repository::SimpleRepository.new
Feature.set_repository(repo)

在生产代码中使用Feature

在生产代码中，您可以使用以下方法来检查功能是否激活：

Feature.active?(:feature_name) # 返回true/false
Feature.inactive?(:feature_name) # 返回true/false

# 获取当前激活的所有功能
Feature.active_features # 返回一个激活功能的列表

# 在功能激活的上下文中执行代码块
Feature.with(:feature_name) do
  # 在这里编写代码
end

# 在功能未激活的上下文中执行代码块
Feature.without(:feature_name) do
  # 在这里编写代码
end

# 根据功能的激活状态返回不同的值
Feature.switch(:feature_name, value_true, value_false)

在测试代码中使用Feature

为了在测试中可靠地测试依赖功能的代码，可以使用以下方法：

require 'feature/testing'

# 激活一个功能进行测试
Feature.run_with_activated(:feature) do
  # 编写测试代码
end

# 激活多个功能进行测试
Feature.run_with_deactivated(:feature, :another_feature) do
  # 编写测试代码
end

功能切换缓存

默认情况下，Feature会在首次检查功能状态时懒加载功能列表，并在内存中缓存这些数据。如果您需要刷新功能列表，可以使用Feature.refresh!方法。

您也可以在设置仓库时传递参数，以强制在每次功能检查时刷新列表，或设置一个刷新间隔时间。

3. 项目API使用文档

项目API主要包括几个部分：

• Feature.set_repository(repo, [auto_refresh])：设置功能仓库，可选地开启自动刷新。
• Feature.active?(:feature_name)：检查一个功能是否激活。
• Feature.inactive?(:feature_name)：检查一个功能是否未激活。
• Feature.active_features：返回所有激活的功能列表。
• Feature.with(:feature_name)：在功能激活的上下文中执行代码块。
• Feature.without(:feature_name)：在功能未激活的上下文中执行代码块。
• Feature.switch(:feature_name, value_true, value_false)：根据功能激活状态返回不同的值。

4. 项目安装方式

请参考“安装指南”部分的内容进行项目的安装。简而言之，您需要在Gemfile中添加gem，然后执行bundle install。如果您使用特定的后端存储（如Redis、YAML文件、数据库等），则需要根据“如何设置不同的后端”部分的说明进行配置。