Skip to content

Update badges, ensure pnpm 10 #192

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
RobbieTheWagner merged 2 commits into from
Apr 25, 2025
Merged

Update badges, ensure pnpm 10 #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef474d9
Update badges, ensure pnpm 10
RobbieTheWagner Apr 25, 2025
32a4876
Update README.md
RobbieTheWagner Apr 25, 2025
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
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 18
Expand All @@ -39,6 +41,8 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 18
Expand Down Expand Up @@ -72,6 +76,8 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 18
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/push-dist.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 18
Expand Down
95 changes: 44 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
# Ember-can

<p align="center">
<a href="http://badge.fury.io/js/ember-can" title="Package version">
<img src="https://badge.fury.io/js/ember-can.svg"/>
</a>
<a href="http://badge.fury.io/js/ember-can" title="Package version">
<img src="https://badge.fury.io/js/ember-can.svg"/>
</a>

<a href="https://emberobserver.com/addons/ember-can" title="Ember Observer">
<img src="http://emberobserver.com/badges/ember-can.svg" alt="Ember Observer"/>
</a>
<a href="https://emberobserver.com/addons/ember-can" title="Ember Observer">
<img src="http://emberobserver.com/badges/ember-can.svg" alt="Ember Observer"/>
</a>

<a href="https://travis-ci.org/minutebase/ember-can" title="Travis CI status">
<img src="https://travis-ci.org/minutebase/ember-can.svg?branch=master" alt="Travis CI Status"/>
</a>
[![CI](https://github.com/minutebase/ember-can/actions/workflows/ci.yml/badge.svg)](https://github.com/minutebase/ember-can/actions/workflows/ci.yml)

<a href="https://david-dm.org/minutebase/ember-can" title="dependencies status">
<img src="https://david-dm.org/minutebase/ember-can/status.svg"/>
</a>
</p>

___
---

Simple authorisation addon for Ember.

Expand All @@ -45,6 +37,7 @@ Resolver = extendResolver(Resolver);
Without this update, the app will encounter an error where it cannot find your abilities.

After these changes your app file should look something like:

```js
import Application from '@ember/application';
import Resolver from 'ember-resolver';
Expand All @@ -61,18 +54,17 @@ export default class App extends Application {
loadInitializers(App, config.modulePrefix);
```


## Compatibility

* Ember.js v4.12 or above
* Embroider or ember-auto-import v2
- Ember.js v4.12 or above
- Embroider or ember-auto-import v2

## Quick Example

You want to conditionally allow creating a new blog post:

```hbs
{{#if (can "create post")}}
{{#if (can 'create post')}}
Type post content here...
{{else}}
You can't write a new post!
Expand Down Expand Up @@ -152,8 +144,9 @@ export default class CreatePostComponent extends Component {
The `can` helper is meant to be used with `{{if}}` and `{{unless}}` to protect a block (but can be used anywhere in the template).

```hbs
{{can "doSth in myModel" model extraProperties}}
{{can 'doSth in myModel' model extraProperties}}
```

- `"doSth in myModel" ` - The first parameter is a string which is used to find the ability class call the appropriate property (see [Looking up abilities](#looking-up-abilities)).

- `model` - The second parameter is an optional model object which will be given to the ability to check permissions.
Expand All @@ -164,8 +157,9 @@ The `can` helper is meant to be used with `{{if}}` and `{{unless}}` to protect a
automatically update accordingly.**

#### Example

```hbs
{{#if (can "edit post" post)}}
{{#if (can 'edit post' post)}}
...
{{else}}
...
Expand All @@ -176,7 +170,7 @@ As it's a sub-expression, you can use it anywhere a helper can be used.
For example to give a div a class based on an ability you can use an inline if:

```hbs
<div class={{if (can "edit post" post) "is-editable"}}>
<div class={{if (can 'edit post' post) 'is-editable'}}>

</div>
```
Expand All @@ -186,10 +180,9 @@ For example to give a div a class based on an ability you can use an inline if:
Cannot helper is a negation of `can` helper with the same API.

```hbs
{{cannot "doSth in myModel" model extraProperties}}
{{cannot 'doSth in myModel' model extraProperties}}
```


## Abilities

An ability class protects an individual model which is available in the ability as `model`.
Expand Down Expand Up @@ -229,7 +222,7 @@ You can do this in the helpers, for example this will set the `model` to `projec
but also `member` as a bound property.

```hbs
{{#if (can "remove member from project" project member=member)}}
{{#if (can 'remove member from project' project member=member)}}
...
{{/if}}
```
Expand All @@ -255,20 +248,20 @@ Then for the ability name we remove some basic stopwords (of, for in) at the end

For example:

| String | property | resource | pod |
|-----------------------------|--------------------|-------------------------|--------------------------------|
| write post | `canWrite` | `/abilities/post.js` | `app/pods/post/ability.js` |
| manage members in project | `canManageMembers` | `/abilities/project.js`| `app/pods/project/ability.js` |
| view profile for user | `canViewProfile` | `/abilities/user.js` | `app/pods/user/ability.js` |
| String | property | resource | pod |
| ------------------------- | ------------------ | ----------------------- | ----------------------------- |
| write post | `canWrite` | `/abilities/post.js` | `app/pods/post/ability.js` |
| manage members in project | `canManageMembers` | `/abilities/project.js` | `app/pods/project/ability.js` |
| view profile for user | `canViewProfile` | `/abilities/user.js` | `app/pods/user/ability.js` |

Current stopwords which are ignored are:

* for
* from
* in
* of
* to
* on
- for
- from
- in
- of
- to
- on

## Custom Ability Lookup

Expand All @@ -289,7 +282,7 @@ export default class AbilitiesService extends Service {
let [abilityName, propertyName] = str.split('.');
return { propertyName, abilityName };
}
};
}
```

You can also modify the property prefix by overriding `parseProperty` in our ability file:
Expand Down Expand Up @@ -326,7 +319,7 @@ The ability classes will now have access to `session` which can then be used to

## Components & computed properties

In a component, you may want to expose abilities as computed properties
In a component, you may want to expose abilities as computed properties
so that you can bind to them in your templates.

```js
Expand All @@ -351,7 +344,7 @@ export default class MyComponent extends Component {

## Accessing abilities within an Ember engine

If you're using [engines](http://ember-engines.com/) and you want to access an *ability* within it, you will need it to be present in your Engine’s namespace. This is accomplished by doing what is called a "re-export":
If you're using [engines](http://ember-engines.com/) and you want to access an _ability_ within it, you will need it to be present in your Engine’s namespace. This is accomplished by doing what is called a "re-export":

```javascript
//my-engine/addon/abilities/foo-bar.js
Expand Down Expand Up @@ -383,26 +376,26 @@ stub the service following [the official EmberJS guide](https://guides.emberjs.c

### Installation

* `git clone https://github.com/minutebase/ember-can.git`
* `cd ember-can`
* `npm install`
- `git clone https://github.com/minutebase/ember-can.git`
- `cd ember-can`
- `npm install`

### Linting

* `npm run lint:hbs`
* `npm run lint:js`
* `npm run lint:js -- --fix`
- `npm run lint:hbs`
- `npm run lint:js`
- `npm run lint:js -- --fix`

### Running tests

* `ember test` – Runs the test suite on the current Ember version
* `ember test --server` – Runs the test suite in "watch mode"
* `ember try:each` – Runs the test suite against multiple Ember versions
- `ember test` – Runs the test suite on the current Ember version
- `ember test --server` – Runs the test suite in "watch mode"
- `ember try:each` – Runs the test suite against multiple Ember versions

### Running the dummy application

* `ember serve`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `ember serve`
- Visit the dummy application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).

Expand Down