Summary

Add ExtensionHook for User Pages

Review Request #3875 — Created Feb. 16, 2013 and submitted Aug. 9, 2013, 3:12 p.m.

Information

Owner

rajasaur

Repository

Review Board

Branch

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Add support for extensions in UserPage
    
This patch adds support for adding extensions in UserPage and works very similar to the DashboardHook. It takes a dictionary of label, url and an optional subitems -- which itself can be an array of (label,url) -- to add custom links in the /users/<username> page.

Also updated the documentation page to indicate the usage of this. Im not sure how to build the doc page into html, so the formatting hasnt been checked for the new documentation.

I added support for this hook so that people wanting to build user-specific reports can use this. For e.g. reports like review-requests assigned to me, or a users' RSS feed can all be linked directly from a user page.

Testing Done

Ran all existing tests. 
Added a new test for the UserPageHook.
Added a new test extension that demonstrates the use of this (Screenshot attached).
Tested without extension to ensure no other breakage.

Files

Issues

Description	From	Last Updated
There's some trailing whitespace here and elsewhere in the file.	chipx86	Feb. 18, 2013, 7:21 a.m.
It's possible we'd want to add other sorts of hooks to this page (such as a banner of some sort …	chipx86	Feb. 18, 2013, 7:21 a.m.
Let's see an example with subitems too.	mike_conley	March 4, 2013, 12:14 a.m.
Nit - let's put these in alphabetical ordering.	mike_conley	March 4, 2013, 12:14 a.m.
Looks like all the newly introduced tags should be indented by 1 space (to be relative to the endif). The …	chipx86	March 4, 2013, 12:14 a.m.

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/views.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py
  Ignored Files:
    docs/codebase/extending/extensions.txt
    reviewboard/templates/reviews/user_page.html

Description:: Add support for extensions in UserPage

This patch adds support for adding extensions in UserPage and works very similar to the DashboardHook. It takes a dictionary of label, url and an optional subitems -- which itself can be an array of (label,url) -- to add custom links in the /users/<username> page.

~
Also updated the documentation page to indicate the usage of this. Im not sure how to build the doc page into html, so the formatting hasnt been checked for the new documentation
~
Also updated the documentation page to indicate the usage of this. Im not sure how to build the doc page into html, so the formatting hasnt been checked for the new documentation.
+
+
I added support for this hook so that people wanting to build user-specific reports can use this. For e.g. reports like review-requests assigned to me, or a users' RSS feed can all be linked directly from a user page.

docs/codebase/extending/extensions.txt (Diff revision 1)
The issue has been resolved. Show all issues
```
There's some trailing whitespace here and elsewhere in the file.
```

reviewboard/extensions/hooks.py (Diff revision 1)

The issue has been resolved. Show all issues

It's possible we'd want to add other sorts of hooks to this page (such as a banner of some sort above the list of review requests). That may make this name confusing.

I think a more fitting name would be UserPageSidebarHook.

RA

rajasaur Feb. 18, 2013, 7:21 a.m.
```
Renamed the hook as UserPageSidebarHook
```

Change Summary:

Updated diff addressing review comments

Diff:

Revision 2 (+118 -2)

Show changes

	docs/codebase/extending/extensions.txt
	reviewboard/extensions/hooks.py
	reviewboard/extensions/tests.py
	reviewboard/reviews/views.py
	reviewboard/templates/reviews/user_page.html

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/views.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py
  Ignored Files:
    docs/codebase/extending/extensions.txt
    reviewboard/templates/reviews/user_page.html

I'm quite happy with this change. Just two suggestions, and then I'll give my ship-it.

Thanks for the excellent patch!

docs/codebase/extending/extensions.txt (Diff revision 2)
The issue has been resolved. Show all issues
```
Let's see an example with subitems too.
```
1. RA
  
  rajasaur March 4, 2013, 12:16 a.m.
  Ive added another code block to show with sub-items as they are optional.
reviewboard/reviews/views.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Nit - let's put these in alphabetical ordering.
```

reviewboard/templates/reviews/user_page.html (Diff revision 2)

The issue has been resolved. Show all issues

Looks like all the newly introduced tags should be indented by 1 space (to be relative to the endif).

The other tags in this file are all pretty off. Even that endif should really be indented by 2. Oh well.. Might as well get a little closer to correct.

rajasaur March 4, 2013, 12:16 a.m.

Please let me know if the other changes (outside of my diff) needs to be fixed. I can open a bug and work on that (maybe find a tool that could do it for all other template files as well)

Diff:

Revision 3 (+144 -2)

Show changes

	docs/codebase/extending/extensions.txt
	reviewboard/extensions/hooks.py
	reviewboard/extensions/tests.py
	reviewboard/reviews/views.py
	reviewboard/templates/reviews/user_page.html

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/views.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py
  Ignored Files:
    docs/codebase/extending/extensions.txt
    reviewboard/templates/reviews/user_page.html

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (452211a). Thanks!

		Add support for extensions in UserPage

		This patch adds support for adding extensions in UserPage and works very similar to the DashboardHook. It takes a dictionary of label, url and an optional subitems -- which itself can be an array of (label,url) -- to add custom links in the /users/<username> page.

~		Also updated the documentation page to indicate the usage of this. Im not sure how to build the doc page into html, so the formatting hasnt been checked for the new documentation
	~	Also updated the documentation page to indicate the usage of this. Im not sure how to build the doc page into html, so the formatting hasnt been checked for the new documentation.
	+
	+	I added support for this hook so that people wanting to build user-specific reports can use this. For e.g. reports like review-requests assigned to me, or a users' RSS feed can all be linked directly from a user page.