使用与安装指南 - Rollout

Rollout 是一个基于 Redis 实现的快速特性切换工具。以下是如何安装和使用 Rollout 的技术文档。

1. 安装指南

要安装 Rollout，您需要在您的项目中运行以下命令来安装 Ruby gem 包：

gem install rollout

2. 项目的使用说明

Rollout 允许您通过多种方式控制特性的激活状态，包括全局、用户组、特定用户以及按用户百分比。

• 初始化 Rollout 对象

  您需要初始化一个 Rollout 对象，并将其与 Redis 实例关联：

  require 'redis'
  
  $redis = Redis.new
  $rollout = Rollout.new($redis)
  

  也可以更简单地使用环境变量或默认的 Redis URL：

  require 'redis'
  $rollout = Rollout.new($redis) # 会使用 REDIS_URL 环境变量或默认的 Redis URL
  

• 设置特性数据

  您可以针对特定特性更新数据：

  $rollout.set_feature_data(:chat, description: 'foo', release_date: 'bar', whatever: 'baz')
  

• 检查特性是否激活

  对于特定用户：

  $rollout.active?(:chat, User.first) # => true/false
  

  全局检查：

  $rollout.active?(:chat)
  

• 使用用户组

  Rollout 默认提供了一个名为 "all" 的用户组，您可以这样激活它：

  $rollout.activate_group(:chat, :all)
  

  您也可以定义自己的用户组：

  $rollout.define_group(:caretakers) do |user|
    user.caretaker?
  end
  

  可以按如下方式停用用户组：

  $rollout.deactivate_group(:chat, :all)
  

• 特定用户

  如果您想允许特定用户加入测试，可以使用以下方法：

  $rollout.activate_user(:chat, @user)
  

  停用特定用户：

  $rollout.deactivate_user(:chat, @user)
  

• 用户百分比

  如果您想按百分比逐步启用新特性，可以使用以下方法：

  $rollout.activate_percentage(:chat, 20)
  

  停用所有百分比：

  $rollout.deactivate_percentage(:chat)
  

• 全局操作

  您可以全局激活或停用特性：

  $rollout.activate(:chat)
  $rollout.deactivate(:chat)
  

• 检查 Rollout 特性状态

  您可以检查特性的当前状态：

  $rollout.get(:chat)
  

• 命名空间

  Rollout 使用 "feature" 键空间与其他键区分开。如果您想进一步为不同环境命名空间，可以使用 redis-namespace gem：

  $ns = Redis::Namespace.new(Rails.env, redis: $redis)
  $rollout = Rollout.new($ns)
  

3. 项目API使用文档

请参考 GitHub 上的项目 Wiki 获取详细的 API 文档。

4. 项目安装方式

如安装指南所述，通过运行以下命令来安装 Rollout：

gem install rollout

以上即为 Rollout 的技术文档，帮助您了解如何安装和使用该项目。