diff --git a/readme.md b/readme.md index 0d04ff3..e41ca52 100644 --- a/readme.md +++ b/readme.md @@ -42,7 +42,7 @@ your backend.** ### Creating a policy A policy accepts a user, often the current user of your session, and the -resource you wish to authorise against. +resource you wish to authorise against, referred to as a record. Policies can be defined by extending the `Policy` class. Add a constructor that accepts the user and record objects as parameters, also calling @@ -115,38 +115,54 @@ You can determine what is shown based on what a user is authorised to see by using the `When` component. ```jsx - - - +import { When } from 'pundit' +import PostPolicy from 'src/policies/post.policy.js' + +// ... + +return ( + + + +) ``` The `user` and `record` attributes are not required if these passed into the policy's contructor when instantiating it. The following acts as a shorthand: ```jsx - - - +return ( + + + +) ``` In order to avoid passing user/policy/record props to every usage of the `When` component you can use the `PunditProvider`. ```jsx - - - - - - - - - - - - - - +import { PunditProvider, When } from 'pundit' +import PostPolicy from 'src/policies/post.policy.js' + +// ... + +return ( + + + + + + + + + + + + + + +) ``` As with the `When` component, you can pass the `user` and `record` attributes @@ -155,17 +171,19 @@ attributes for particular usages of `When` within the provider, for example to check if an alternative user or record is authorised. ```jsx - - - View Post - - - View Post Masquerading as {masqueradeUser.name} - - - View Next Post - - +return ( + + + View Post + + + View Post Masquerading as {masqueradeUser.name} + + + View Next Post + + +) ``` ### Testing @@ -173,6 +191,8 @@ check if an alternative user or record is authorised. Policies can be unit tested, for example with Jest/Vitest: ```javascript +import PostPolicy from 'src/policies/post.policy.js' + describe('post policy, edit action', () => { const user = { id: 1 } @@ -201,7 +221,7 @@ MIT 1. Push to the branch (`git push origin my-new-feature`) 1. Create new Pull Request ---- +## Authors -> Built by [johno](https://johno.com) ([@4lpine](https://twitter.com/4lpine)) -> and [Chris Alley](https://github.com/chrisalley). +Built by [johno](https://johno.com) ([@4lpine](https://twitter.com/4lpine)) and +[Chris Alley](https://github.com/chrisalley).