RoleModel 技术文档

1. 安装指南

安装步骤

1. 打开终端或命令行工具。
2. 输入以下命令安装 role_model gem：

   gem install role_model
   

3. 等待安装完成。

依赖项

• Ruby 版本：确保你的 Ruby 版本符合 role_model 的要求。
• Gem 依赖：role_model 可能依赖其他 gem，安装时会自动处理。

2. 项目的使用说明

基本概念

RoleModel 是一个与框架无关的角色管理库，通过位掩码（bitmask）高效地存储用户角色。它允许你在模型中直接配置角色属性，并通过简单的 API 进行角色管理。

使用示例

以下是一个简单的使用示例：

require 'rubygems'
require 'role_model'

class User
  attr_accessor :roles_mask   # 仅用于演示目的
  include RoleModel

  roles_attribute :roles_mask
  roles :admin, :manager, :author, prefix: "is_"
end

# 创建用户实例
u = User.new

# 分配角色
u.roles = [:admin]

# 添加角色
u.roles << :manager

# 删除角色
u.roles.delete(:manager)

# 查询角色
u.has_role? :author  # 返回 false
u.is_author?         # 返回 false

角色管理

• 分配角色：通过 roles= 或 roles << 方法分配角色。
• 添加角色：使用 roles.add 或动态方法（如 u.manager = true）添加角色。
• 删除角色：使用 roles.delete 或动态方法（如 u.manager = false）删除角色。
• 查询角色：使用 has_role? 或动态方法（如 u.author?）查询角色。

3. 项目API使用文档

主要API

• roles_attribute :attribute_name：指定存储角色的属性名称，默认为 :roles_mask。
• roles :role1, :role2, ...：声明有效的角色，顺序不可更改。
• roles=：分配角色。
• roles <<：添加角色。
• roles.add：添加角色。
• roles.delete：删除角色。
• has_role? :role：检查是否具有某个角色。
• has_any_role? :role1, :role2, ...：检查是否具有任意一个角色。
• has_all_roles? :role1, :role2, ...：检查是否具有所有角色。
• roles_mask：获取角色的位掩码表示。
• User.mask_for :role1, :role2, ...：获取指定角色的位掩码。

动态方法

• role?：动态生成的角色查询方法，如 u.admin?。
• is_role?：如果设置了 prefix: "is_"，则生成 is_role? 方法，如 u.is_admin?。

4. 项目安装方式

通过 Gem 安装

gem install role_model

在 Rails 项目中使用

1. 在 Gemfile 中添加：

   gem 'role_model'
   

2. 运行 bundle install。
3. 在模型中引入 RoleModel，并配置角色属性。

手动安装

1. 下载 role_model 源码。
2. 将源码放置在项目目录中。
3. 在项目中引入 role_model。

通过以上步骤，你可以轻松地在项目中使用 RoleModel 进行角色管理。