punditというユーザーの権限管理をするGemを試してみる

ユーザーの権限管理をしてくれるGemを試してみました。

インストール

installはいつもどおりbundlerで行います。

gem "pundit"

ApplicationControllerでPunditをincludeします。

pundit_userは後で登場するApplicationPolicyの初期化時に渡すパラメータです。
本来はcurrent_userが返るのですが、今回はユーザー作成は行っていないのでnilを返すようにする。

class ApplicationController < ActionController::Base
  include Pundit

  def pundit_user
    nil
  end
end

次に下コマンドで初期化をします。

rails g pundit:install

app/policiesフォルダが作られるのでそこに機能単位のポリシーをセットしていきます。

例えばCommentControllerへのアクセスを制御する場合を考えます。

まずは以下コマンドでcommentへのpolicyを作成します。

rails g pundit:policy comment

CommentPolicyにindex?メソッドを追加します。

class CommentPolicy < ApplicationPolicy
  def index?
    false
  end

  class Scope < Scope
    def resolve
      scope
    end
  end
end

この状態でCommentControllerのindexでauthorizeメソッドを呼んだ場合、CommentPolicy#index?メソッドがfalseを返すのでPundit::NotAuthorizedErrorというエラーになります。

class CommentsController < ApplicationController
  def index
    @comments = Comment.all
    authorize @comments
  end
end

f:id:llcc:20160105205631p:plain

CommentPolicy#index?の戻り値をtrueにするとエラーが起きなくなります。

例えばviewでのチェックをしたい場合は以下のようにします。

<% if policy(@comments).index? %>
<h1>Listing Comments</h1>
<% end %>