Petergate 开源项目教程

Petergate 开源项目教程

petergateEasy to use and read action and content based authorizations.项目地址:https://gitcode.com/gh_mirrors/pe/petergate

项目介绍

Petergate 是一个易于使用和阅读的动作和内容基于授权的 Ruby gem。它旨在为您的 Rails 项目提供简单而强大的权限管理功能。如果您喜欢 Strong Parameters 的直接和有效性，并且认为 CanCan 可能对您的项目来说过于复杂，那么您会喜欢 Petergate 的易用性和可读性。

项目快速启动

安装

1. 在您的 Rails 应用的 Gemfile 中添加以下行：

   gem 'petergate'
   

2. 运行以下命令安装 gem：

   bundle install
   

配置

1. 确保您的用户模型定义在 app/models/user.rb 中，并且命名为 User。如果您使用 Devise，那么您已经准备好了，否则您需要添加以下方法到您的项目中：

   current_user
   after_sign_in_path_for(current_user)
   authenticate_user
   

2. 运行生成器以安装 Petergate：

   rails g petergate:install
   rake db:migrate
   

用户模型配置

在 app/models/user.rb 中配置可用角色：

############################################################################################
## PeterGate Roles
## The :user role is added by default and shouldn't be included in this list
## The :root_admin can access any page regardless of access restrictions
petergate(roles: [:admin, :editor], multiple: false)
############################################################################################

控制器配置

在控制器中设置权限，类似于 before_filter：

class ApplicationController < ActionController::Base
  access all: [:show, :index], user: {except: [:destroy]}
end

应用案例和最佳实践

单角色模式

在单角色模式下，用户只能有一个角色。以下是一个示例表单：

<%= form_for @user do |f| %>
  <% if @user.errors.any? %>
    <div id="error_explanation">
      <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
      <ul>
        <% @user.errors.full_messages.each do |message| %>
          <li><%= message %></li>
        <% end %>
      </ul>
    </div>
  <% end %>

  <div class="field">
    <%= f.label :email %>
    <%= f.text_field :email %>
  </div>

  <% if @user.new_record? || params[:passwd] %>
    <div class="field">
      <%= f.label :password %>
      <%= f.text_field :password %>
    </div>
    <div class="field">
      <%= f.label :password_confirmation %>
      <%= f.text_field :password_confirmation %>
    </div>
  <% end %>

  <div class="field">
    <%= f.label :role %>
    <%= f.select :role, @user.available_roles %>
  </div>

  <div class="actions">
    <%= f.submit %>
  </div>
<% end %>

多角色模式

如果需要用户拥有多个角色，可以将 multiple 选项设置为 true：

petergate(roles: [:admin, :editor], multiple: true)

典型生态项目

Petergate 可以与其他流行的 Ruby on Rails 插件和 gem 一起使用，例如 Devise（用于用户身份验证）和 CanCanCan（用于权限管理）。通过结合这些工具，您可以构建一个功能强大且灵活的 Rails 应用程序。

结合 Devise

Devise 是一个广泛使用的 Rails 身份验证解决方案。Petergate 可以无缝集成 Devise，提供完整的用户管理和权限控制。

结合 CanCanCan

虽然 Petergate 提供了自己的权限管理功能，但您仍然可以结合 CanCanCan 使用，以实现更复杂的权限逻辑。

通过这些集成，您可以构建一个既强大又灵活的 Rails 应用程序，满足各种复杂的业务需求。

petergateEasy to use and read action and content based authorizations.项目地址:https://gitcode.com/gh_mirrors/pe/petergate