From cebc7115d133801d438836d622600e2f472bc831 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Mon, 10 Feb 2014 21:00:19 -0500 Subject: Document the MessagesController. --- docs/DesignDocument.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md index 65603c4..e896202 100644 --- a/docs/DesignDocument.md +++ b/docs/DesignDocument.md @@ -153,7 +153,9 @@ layouts/application.html (abstract) logout button that causes a POST to `LoginController#logout()`. It may contain an alert box of recent alerts submitted by a tournament host. It contains a searc form that is POSTed to - `SearchController#show_results`. + `SearchController#show_results`. If the user is authorized to + publish alerts, it also contains a button that causes the browser + to GET `MessagesController#new_alert()`. common/permission_denied.html : A generic page for when a user attempts to do something for which @@ -309,12 +311,21 @@ SearchController view. MessagesController - : TODO + : This controller handles inter-user messages. It has a couple + methods that respond to GET requests: + + - `new_alert()` Renders the `messages/new_alert` template, + assuming the user has permission. + - `show_private()` Renders the `messages/private template, + assuming the user has permission. + + It also has methods that respond to POST requests: - - `new_alert()` TODO: GET - - `post_alert()` TODO: POST - - `show_private()` TODO: GET - - `post_private()` TODO: POST + - `post_alert()` Publishes a new system-wide alert, assuming the + user has permission. It then redirects the browser to whichever + page it would otherwise be on. + - `post_private()` Sends a new private message, assuming the user + has permission. TournamentsController : This controller will have methods: -- cgit v1.2.3 From 4945ce02b45dacee020f8919f51fa3dfb23cc194 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Mon, 10 Feb 2014 21:06:10 -0500 Subject: mostly document the remaining controllers --- docs/DesignDocument.md | 51 +++++++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md index e896202..885e679 100644 --- a/docs/DesignDocument.md +++ b/docs/DesignDocument.md @@ -328,9 +328,7 @@ MessagesController has permission. TournamentsController - : This controller will have methods: - - The following methods respond to GET requests by rendering the + : The following methods respond to GET requests by rendering the `tournaments/*` view with the same name: - `index()` @@ -353,36 +351,47 @@ TournamentsController TournamentSettings. MatchesController - : TODO + : The following methods respond to GET requests by rendering the + `matches/*` view with the same name: - - `index()`: TODO: GET - - `show()` TODO: GET - - `edit()` TODO: GET - - `update()` TODO: POST + - `index()` + - `show()` + - `edit()` + + The following methods respond to POST requests, assuming the user + has permission: + + - `update()` Updates the specified `Match` with the POSTed data. TeamsController - : TODO + : The following methods respond to GET requests by rendering the + `teams/*` view with the same name: + + - `index()` + - `show()` + - `edit()` + + The following methods respond to POST requests, assuming the user + has permission: - - `index()` TODO: GET - - `show()` TODO: GET - - `edit()` TODO: GET - `update()` TODO: POST UsersController - : TODO + : The following methods respond to GET requests by rendering the + `users/*` view with the same name: + + - `index()` + - `show()` + - `new()` + - `edit()` + + The following methods respond to POST requests, assuming the user + has permission: - - `index()` TODO: GET - - `show()` TODO: GET - - `new()` TODO: GET - `create()` TODO: POST - - `edit()` TODO: GET - `update()` TODO: POST - `delete()` TODO: POST ## UML Diagram of Classes -TODO – I’m working on this – see images.pptx ~ Tomer - -So am I: ~ Luke - ![](DesignDocument-classes.pdf)\ -- cgit v1.2.3