Summary

Add a decorator that makes a view require a feature

Review Request #9007 — Created June 9, 2017 and submitted June 15, 2017, 3:50 p.m.

Information

Owner

brennie

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

The @feature_required(f) decorator makes the decorated view require

the f feature to be enabled to be executed. Otherwise a backup view

will be called, which by default returns a 404 Not Found error. This

view may be customized by the caller to return any sort of response.

Testing Done


Tested this with an upcoming patch for RB.
Ran unit tests.

Issues

Description	From	Last Updated
This needs unit tests.	chipx86	June 13, 2017, 3:47 p.m.
W293 blank line contains whitespace	reviewbot	June 12, 2017, 4:27 p.m.
W293 blank line contains whitespace	reviewbot	June 12, 2017, 4:27 p.m.
Thinking we may want to allow for a little more flexibility in what's returned here. A 404 might be appropriate …	chipx86	June 13, 2017, 3:30 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/features/decorators.py (Diff revision 1)
The issue has been resolved. Show all issues
```
W293 blank line contains whitespace
```
djblets/features/decorators.py (Diff revision 1)
The issue has been resolved. Show all issues
```
W293 blank line contains whitespace
```

Change Summary:

whitespace

Diff:

Revision 2 (+29)

Show changes

djblets/features/decorators.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues
```
This needs unit tests.
```

djblets/features/decorators.py (Diff revision 2)

The issue has been resolved. Show all issues

Thinking we may want to allow for a little more flexibility in what's returned here. A 404 might be appropriate for a lot of things, but a 403 might be for others. It might also be really nice to allow some other thing to be returned (redirect, custom page with instructions on requesting access to the thing, etc.).
How about letting feature_required take a not_enabled_view argument that defaults to lambda *args, **kwargs: HttpResponseNotFound()? Then callers could leave it at the default to get a 404, or could override the behavior to return whatever they want.

Change Summary:

Address Christian's issues; add unit tests.

Description:

		The `@feature_required(f)` decorator makes the decorated view require
~		the `f` feature to be enabled to be executed. Otherwise a 404 will be
~		returned.
	~	the `f` feature to be enabled to be executed. Otherwise a backup view
	~	will be called, which by default returns a 404 Not Found error. This
	+	view may be customized by the caller to return any sort of response.

Testing Done:

~		Tested this with an upcoming patch for RB. [TODO: r/?]
	~	Tested this with an upcoming patch for RB.
	+
	+	Added unit tests.

Diff:

Revision 3 (+125 -1)

Show changes

	dev-requirements.txt
	djblets/features/decorators.py
	djblets/features/tests/test_decorators.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:: ~
Tested this with an upcoming patch for RB.
~
~
Tested this with an upcoming patch for RB.
~
Ran unit tests.
-
Added unit tests.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-0.10.x (e6511ad)

~		Tested this with an upcoming patch for RB.
~
	~	Tested this with an upcoming patch for RB.
	~	Ran unit tests.
-		Added unit tests.