CSC/ECE 517 Spring 2017/oss E1712: Difference between revisions
(Made changes to introduction and added a Background section) |
(Added more information about the current implementation) |
||
| Line 1: | Line 1: | ||
== Introduction == | |||
This project is part of an educational web application called Expertiza. This wiki gives the details on the refactoring tasks undertaken as part of continuous improvement of Expertiza. | This project is part of an educational web application called Expertiza. This wiki gives the details on the refactoring tasks undertaken as part of continuous improvement of Expertiza. | ||
| Line 5: | Line 5: | ||
[[Expertiza_documentation|Expertiza]] is an open source project managed by the faculty and students of NCSU. It is a web application which offers a platform for assignments and allows learning through peer reviews. | [[Expertiza_documentation|Expertiza]] is an open source project managed by the faculty and students of NCSU. It is a web application which offers a platform for assignments and allows learning through peer reviews. | ||
=== | ===Motivation=== | ||
In the existing code the InvitationController and the JoinTeamRequestsController do the expected task but the there is a lot of redundancy and duplicity in the code, and the comments in the code are few and sparse. The aim of our project was to reduce the complexity of the controller by removing redundant code adding comments so that the code is easy to understand and all the variables used in the code are clearly explained. | |||
==Current Implementation== | |||
===Invitations Controller=== | |||
Invitations controller handles the functions required to send invitations out to potential teammates for a project. Once a student decides to invite someone into his assignment team the controller performs some checks before sending out the invitations. These checks are performed in the create function. The current implementation has a lot of redundant code and many nested if statements. The ABC size of the method is also very high. | |||
===Join Team Requests Controller=== | |||
JoinTeamRequests controller deals with the actions to be performed after a student comes across an advertisement to join a project team. Whenever a project team creates an advertisement for others to join their team, students can see a link to the advertisement in the signup sheet. Once the student clicks on the link to the advertisement the student can then request to join the team. The create function in the JoinTeamRequestsController handles the checks before sending out the request. Again, the ABC size for this method is very high as there a lot of nested if conditions. Also, there is duplicate code in some of the functions in this controller which can be moved to a separate function. | |||
=== Tasks Identified === | === Tasks Identified === | ||
Revision as of 21:13, 30 March 2017
Introduction
This project is part of an educational web application called Expertiza. This wiki gives the details on the refactoring tasks undertaken as part of continuous improvement of Expertiza.
Background
Expertiza is an open source project managed by the faculty and students of NCSU. It is a web application which offers a platform for assignments and allows learning through peer reviews.
Motivation
In the existing code the InvitationController and the JoinTeamRequestsController do the expected task but the there is a lot of redundancy and duplicity in the code, and the comments in the code are few and sparse. The aim of our project was to reduce the complexity of the controller by removing redundant code adding comments so that the code is easy to understand and all the variables used in the code are clearly explained.
Current Implementation
Invitations Controller
Invitations controller handles the functions required to send invitations out to potential teammates for a project. Once a student decides to invite someone into his assignment team the controller performs some checks before sending out the invitations. These checks are performed in the create function. The current implementation has a lot of redundant code and many nested if statements. The ABC size of the method is also very high.
Join Team Requests Controller
JoinTeamRequests controller deals with the actions to be performed after a student comes across an advertisement to join a project team. Whenever a project team creates an advertisement for others to join their team, students can see a link to the advertisement in the signup sheet. Once the student clicks on the link to the advertisement the student can then request to join the team. The create function in the JoinTeamRequestsController handles the checks before sending out the request. Again, the ABC size for this method is very high as there a lot of nested if conditions. Also, there is duplicate code in some of the functions in this controller which can be moved to a separate function.
Tasks Identified
InvitationController
- Rename to invitations_controller.rb, in accordance with current naming convention.
- The ABC size for create method is too high and needs to be refactored along with removal of other nested if's in some methods
- Use find_by instead of find_by_name and find_by_user_id_and_assignment_id.
- Add comments explaining what each method does, and comments on how important variables are used
JoinTeamRequestsController
- Add comments on why some important variables are used.
- The ABC size for create method is too high and other 'nested-if's are refactored.
- Duplicacy in code is to be removed.
- Fix UI to maintain consistency in displaying information about team members.
Feature tests for theses controllers have to be updated.
Test case charts
Decline: Assert the change of status to 'D' in the database
Cancel
Create function
Running project remotely
VCL is used to host the project remotely. The login credentials as an instructor are "instructor6" with password "password". To login as a student, you can use 'student5425' with password 'password'