Skip to content

Fix: Inconsistencies in user policy code examples #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Fix: Inconsistencies in user policy code examples #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions code/examples/user-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function getPolicyByRole(role) {

return {
canInvite: policy.includes("invite"),
canRead: policy.includes("view")
canView: policy.includes("view")
};
}

Expand Down Expand Up @@ -69,14 +69,14 @@ function Page() {
return (
<div>
<Button disabled={false}>Invite</Button>
<Button disabled={false}>Read</Button>
<Button disabled={false}>View</Button>
</div>
);
case "viewer":
return (
<div>
<Button disabled={true}>Invite</Button>
<Button disabled={false}>Read</Button>
<Button disabled={false}>View</Button>
</div>
);
default:
Expand All @@ -88,20 +88,20 @@ function Page() {
### B. 조건을 한눈에 볼 수 있는 객체로 만들기

권한을 다루는 로직을 컴포넌트 안에서 객체로 관리해서, 여러 차례의 시점 이동 없이 한눈에 조건을 파악할 수 있게 수정할 수 있어요.
`canInvite`와 `canRead`의 조건을 `Page` 컴포넌트만 보면 확인할 수 있어요.
`canInvite`와 `canView`의 조건을 `Page` 컴포넌트만 보면 확인할 수 있어요.

```tsx
function Page() {
const user = useUser();
const policy = {
admin: { canInvite: true, canRead: true },
viewer: { canInvite: false, canRead: true },
admin: { canInvite: true, canView: true },
viewer: { canInvite: false, canView: true },
}[user.role];

return (
<div>
<Button disabled={!policy.canInvite}>Invite</Button>
<Button disabled={!policy.canRead}>Read</Button>
<Button disabled={!policy.canView}>View</Button>
</div>
);
}
Expand Down
14 changes: 7 additions & 7 deletions en/code/examples/user-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function getPolicyByRole(role) {

return {
canInvite: policy.includes("invite"),
canRead: policy.includes("view")
canView: policy.includes("view")
};
}

Expand Down Expand Up @@ -69,14 +69,14 @@ function Page() {
return (
<div>
<Button disabled={false}>Invite</Button>
<Button disabled={false}>Read</Button>
<Button disabled={false}>View</Button>
</div>
);
case "viewer":
return (
<div>
<Button disabled={true}>Invite</Button>
<Button disabled={false}>Read</Button>
<Button disabled={false}>View</Button>
</div>
);
default:
Expand All @@ -88,20 +88,20 @@ function Page() {
### B. Creating an Object to View Conditions at a Glance

By managing the logic for handling permissions within the component as an object, you can modify it to be able to grasp the conditions at a glance without multiple context shifts.
You can check the conditions for `canInvite` and `canRead` just by looking at the `Page` component.
You can check the conditions for `canInvite` and `canView` just by looking at the `Page` component.

```tsx
function Page() {
const user = useUser();
const policy = {
admin: { canInvite: true, canRead: true },
viewer: { canInvite: false, canRead: true },
admin: { canInvite: true, canView: true },
viewer: { canInvite: false, canView: true },
}[user.role];

return (
<div>
<Button disabled={!policy.canInvite}>Invite</Button>
<Button disabled={!policy.canRead}>Read</Button>
<Button disabled={!policy.canView}>View</Button>
</div>
);
}
Expand Down