Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T02:05:11Z

Onkashid: /* Introduction: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented. This project works on improving the search functionality of expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
We plan to two types of testing
=== UI Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible 

=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated in.
 
* Assignment Model ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
* Rubrics
# Search by name
# Search by courses used in
# Search by assignments used in
 
* Reviews
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T02:00:16Z

Onkashid: /* Introduction: */

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:28:04Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:27:37Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:27:15Z

Onkashid:

CSC/ECE 517 Fall 2018- Project E1861. Improving search facility in Expertiza

2019-11-11T01:25:20Z

Onkashid:

==Introduction:==

The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.

==Problem Definition:==

# An instructor or administrator can search for a user by name, user-ID, or other characteristics.
# An instructor should be able to search for assignments by name, due date, or other characteristics.
# An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
## For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

===Search for User:===

In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the name of the user in the search box available below the ‘Users’ tab
:#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters.
:#All the entries that match the given criteria will be returned.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the name of the assignment in the search box available below the ‘Assignments’ tab
:#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).
:#All the entries that match the given criteria will be returned.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

All the above will be available under Manage > Questionnaires.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.

==Use Case Diagram==
[[File:Usecase search.png|center]]

== Proposed Code Changes ==
We though about 2 ways of adding the search functionality in the system
:# Adding a search controller to the system
:# Adding search functionality to individual models

===Adding a search controller ===
If we followed this approach the search query would be like
*localhost:port/search/user?name=<>
*localhost:port/search/assignment?name=<>

This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach

===Adding search functionality to individual models===

If we followed this approach the search query would be like
:#localhost:port/user/search?name=<>
:#localhost:port/assignment/search?name=<>

On discussions we concluded that that the latter was a more RESTFul design
For most of the cases we have tried to minimize the changes required in the respective model by reuse
We propose to add search methods in each model for corresponding changes.

Therefore in order to perform search every entity required changes in all the three layers
*View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
*Controller : Parses the changes from UI, essentially takes params[] hash.
*Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.

User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI.
React based View changes are in app/assets/javascripts/tree_display.jsx.

====User====
* Search fields
** username
** name
** email

* Modified files:
** app/views/users/list.html.erb
** app/controllers/users_controller.rb
** app/models/user.rb

* Modified functions
** UsersController#list : Parses the username, name and email from the params hash.
** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.

====Assignment====
* Search fields
** name
** assignee_username
** assignee_name
** due_date_before
** due_date_after
** created_before
** created_after

* Modified files
** app/assets/javascripts/tree_display.jsx
** app/controllers/tree_display_controller.rb
** app/models/assignment_node.rb

* Modified functions
** TreeDisplayController#initialize_fnode_update_children
** TreeDisplayController#update_fnode_children
** AssignmentNode.get

====Questionnaire====
* Search fields
** name
** text
** course
** assignment

* Modified files
** app/assets/javascripts/tree_display.jsx
** app/controllers/tree_display_controller.rb
** app/models/questionnaire_node.rb

* Modified functions
** TreeDisplayController#get_tmp_res
** QuestionnaireNode.get

====Review====
* Search fields
** team
** text
** min_score
** max_score

* Modified files
** app/views/review_mapping/_searchbox.html.erb
** app/controllers/review_mapping_controller.rb
** app/helpers/summary_helper.rb

* Modified functions
** ReviewMappingController#response_report
** SummaryHelper#summarize_reviews_by_reviewees

==Database Design==

===ER Diagram:===
The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.
[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]

[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
We plan to two types of testing
=== UI Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible 

=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email

CSC/ECE 517 Fall 2018- Project E1861. Improving search facility in Expertiza

2019-11-11T01:24:43Z

Onkashid:

==Introduction:==

The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.

==Problem Definition:==

# An instructor or administrator can search for a user by name, user-ID, or other characteristics.
# An instructor should be able to search for assignments by name, due date, or other characteristics.
# An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
## For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

===Search for User:===

In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the name of the user in the search box available below the ‘Users’ tab
:#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters.
:#All the entries that match the given criteria will be returned.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the name of the assignment in the search box available below the ‘Assignments’ tab
:#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).
:#All the entries that match the given criteria will be returned.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.

To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

All the above will be available under Manage > Questionnaires.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.

==Use Case Diagram==
[[File:Usecase search.png|center]]

== Proposed Code Changes ==
We though about 2 ways of adding the search functionality in the system
:# Adding a search controller to the system
:# Adding search functionality to individual models

===Adding a search controller ===
If we followed this approach the search query would be like
*localhost:port/search/user?name=<>
*localhost:port/search/assignment?name=<>

This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach

===Adding search functionality to individual models===

If we followed this approach the search query would be like
:#localhost:port/user/search?name=<>
:#localhost:port/assignment/search?name=<>

On discussions we concluded that that the latter was a more RESTFul design
For most of the cases we have tried to minimize the changes required in the respective model by reuse
We propose to add search methods in each model for corresponding changes.

Therefore in order to perform search every entity required changes in all the three layers
*View : Changes in view are changes added to UI, and it is used to pass search parameters to controller
*Controller : Parses the changes from UI, essentially takes params[] hash.
*Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects.

User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI.
React based View changes are in app/assets/javascripts/tree_display.jsx.

====User====
* Search fields
** username
** name
** email

* Modified files:
** app/views/users/list.html.erb
** app/controllers/users_controller.rb
** app/models/user.rb

* Modified functions
** UsersController#list : Parses the username, name and email from the params hash.
** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.

====Assignment====
* Search fields
** name
** assignee_username
** assignee_name
** due_date_before
** due_date_after
** created_before
** created_after

* Modified files
** app/assets/javascripts/tree_display.jsx
** app/controllers/tree_display_controller.rb
** app/models/assignment_node.rb

* Modified functions
** TreeDisplayController#initialize_fnode_update_children
** TreeDisplayController#update_fnode_children
** AssignmentNode.get

====Questionnaire====
* Search fields
** name
** text
** course
** assignment

* Modified files
** app/assets/javascripts/tree_display.jsx
** app/controllers/tree_display_controller.rb
** app/models/questionnaire_node.rb

* Modified functions
** TreeDisplayController#get_tmp_res
** QuestionnaireNode.get

====Review====
* Search fields
** team
** text
** min_score
** max_score

* Modified files
** app/views/review_mapping/_searchbox.html.erb
** app/controllers/review_mapping_controller.rb
** app/helpers/summary_helper.rb

* Modified functions
** ReviewMappingController#response_report
** SummaryHelper#summarize_reviews_by_reviewees

==Database Design==

===ER Diagram:===
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.
[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]

[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
We plan to two types of testing
=== UI Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible 

=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:11:52Z

Onkashid:

File:UseCaseExpertizaSearch.png

2019-11-11T01:10:21Z

Onkashid:

File:Downlo6564a.png

2019-11-07T02:29:19Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T23:04:34Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for the students. Faculties can assign assignments with staged deadlines. Expertiza supports creation of teams for the students, tracking the team members and reviewing the work done by the other team members. Students can also review their peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Project Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in the assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in the assignment.rb file related to stage deadlines. There existed five functions to check the kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Refractors implemented''' ==
The following is the list of refractors done in the code. It discusses the issues we found in the code with respect to Ruby conventions and the solutions that we provided for the same.

==='''1.To avoid multiple calls to DueDate.get_next_due_date()'''===

<h4>Problem with Existing code</h4>
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

<h4>Solution</h4>
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
<h4>Code snippet</h4>
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored.

<h4>Screenshots</h4>

==='''2.To not have finished status checked with static string “Finished”'''===

<h4>Problem with Existing code</h4>
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

<h4>Solution</h4>
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
<h4>Code</h4>
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places.

<h4>Screenshots</h4>

==='''3.Return “Unknown” when topic_id is missing'''===

<h4>Problem with existing code:</h4>
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

<h4>Solution</h4>
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb
<h4>Code snippet</h4>
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places:
<h4>Screenshots</h4>

==='''4.find_current_stage method removed'''===

<h4>Problem with the existing code:</h4>
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

<h4>Solution</h4>
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

<h4>Code snippet</h4>
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places:

<h4>Screenshots</h4>

==='''5.link_for_current_stage method removed'''===

<h4>Problem with existing code</h4>
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

<h4>Solution</h4>
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

<h4>Screenshots</h4>

== '''Automated Testing using RSPEC''' ==

==='''Tests for get_current_stage()'''===

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
<h4>Code snippet</h4>
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

==='''Tests for finished?'''===

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 
<h4>Code snippet</h4>

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T22:54:25Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for the students. Faculties can assign assignments with staged deadlines. Expertiza supports creation of teams for the students, tracking the team members and reviewing the work done by the other team members. Students can also review their peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Project Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in the assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in the assignment.rb file related to stage deadlines. There existed five functions to check the kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Refractors implemented''' ==
We found the following issues with the code with respect to Ruby conventions :

===''' To avoid multiple calls to DueDate.get_next_due_date()'''===

<h4>Problem with Existing code</h4>
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

<h4>Solution</h4>
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
<h4>Code snippet</h4>
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored.

<h4>Screenshots</h4>

==='''To not have finished status checked with static string “Finished”'''===

<h4>Problem with Existing code</h4>
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

<h4>Solution</h4>
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
<h4>Code</h4>
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places.

<h4>Screenshots</h4>

==='''Return “Unknown” when topic_id is missing'''===

<h4>Problem with existing code:</h4>
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

<h4>Solution</h4>
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb
<h4>Code snippet</h4>
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places:
<h4>Screenshots</h4>

==='''find_current_stage method removed'''===

<h4>Problem with the existing code:</h4>
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

<h4>Solution</h4>
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

<h4>Code snippet</h4>
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places:

<h4>Screenshots</h4>

==='''link_for_current_stage method removed'''===

<h4>Problem with existing code</h4>
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

<h4>Solution</h4>
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

<h4>Screenshots</h4>

== '''Automated Testing using RSPEC''' ==

==='''Tests for get_current_stage()'''===

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
<h4>Code snippet</h4>
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

==='''Tests for finished?'''===

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 
<h4>Code snippet</h4>

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:53:03Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Problem Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Solution Provided''' ==
We have found the following issues with the code with respect to Ruby conventions :

==='''Multiple calls to DueDate.get_next_due_date()'''===

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

==='''Checking finished status with static string “Finished”'''===

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

==='''Return “Unknown” when topic_id is missing'''===

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

==='''find_current_stage method removed'''===

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

==='''link_for_current_stage method removed'''===

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== '''Automated Testing using RSPEC''' ==

==='''Tests for get_current_stage()'''===

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

==='''Tests for finished?'''===

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:52:31Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Problem Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Solution Provided''' ==
We have found the following issues with the code with respect to Ruby conventions :

==='''Multiple calls to DueDate.get_next_due_date()'''===

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

==='''Checking finished status with static string “Finished”'''===

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

==='''Return “Unknown” when topic_id is missing'''===

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

==='''find_current_stage method removed'''===

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

==='''link_for_current_stage method removed'''===

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== '''Automated Testing using RSPEC''' ==

==='''Tests for get_current_stage()'''===

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

==='''Tests for finished?'''====

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:49:11Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Problem Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Solution Provided''' ==
We have found the following issues with the code with respect to Ruby conventions :

==='''Multiple calls to DueDate.get_next_due_date()'''===

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

==='''Checking finished status with static string “Finished”'''===

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

==='''Return “Unknown” when topic_id is missing'''===

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

==='''find_current_stage method removed'''===

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

==='''link_for_current_stage method removed'''===

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== '''Automated Testing using RSPEC''' ==

Tests for get_current_stage() 

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

Tests for finished? 

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:43:02Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Problem Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Solution Provided''' ==
We have found the following issues with the code with respect to Ruby conventions :

Multiple calls to DueDate.get_next_due_date() 

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

Checking finished status with static string “Finished” 

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

Return “Unknown” when topic_id is missing 

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

find_current_stage method removed 

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

link_for_current_stage method removed 

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== '''Automated Testing using RSPEC''' ==

Tests for get_current_stage() 

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

Tests for finished? 

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:39:17Z

Onkashid:

== '''Expertiza Background''' ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== '''Problem Description''' ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== '''Important Links''' ==
1. [https://152.46.19.152:8080\ VCL Link for expertiza deployed with changes] 
2. [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1942._Refactor_stage_deadlines_in_assignment.rb\ OSS documentation] 

== '''Current Scenario''' ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

== '''Solution Provided''' ==
We have found the following issues with the code with respect to Ruby conventions :

Multiple calls to DueDate.get_next_due_date() 

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

Checking finished status with static string “Finished” 

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

Return “Unknown” when topic_id is missing 

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

find_current_stage method removed 

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

link_for_current_stage method removed 

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== Automated Testing using RSPEC ==

Tests for get_current_stage() 

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

Tests for finished? 

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:37:33Z

Onkashid:

== Expertiza Background ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== Problem Description ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== Current Scenario ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

We have found the following issues with the code with respect to Ruby conventions :

Multiple calls to DueDate.get_next_due_date() 

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

Checking finished status with static string “Finished” 

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

Return “Unknown” when topic_id is missing 

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

find_current_stage method removed 

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

link_for_current_stage method removed 

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== Automated Testing using RSPEC ==

Tests for get_current_stage() 

The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

Tests for finished? 

Tests for new finished? function have been added. 
File: spec/models/assignment_spec.rb 

describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(true)
end
end
end
describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end

topic_missing method is a private method and hence no tests have been added for the same.

== Team ==
[mailto:onkashid@ncsu.edu Omkar Kashid] 
[mailto:drao@ncsu.edu Deeksha Rao] 
[mailto:sdinaka@ncsu.edu Swathi Dinakar]

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:35:11Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:33:28Z

Onkashid:

== Expertiza Background ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== Problem Description ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== Current Scenario ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

We have found the following issues with the code with respect to Ruby conventions :

Multiple calls to DueDate.get_next_due_date() 

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

Checking finished status with static string “Finished” 

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

Return “Unknown” when topic_id is missing 

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

find_current_stage method removed 

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

link_for_current_stage method removed 

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== Automated Testing using RSPEC ==

Tests for get_current_stage() 
The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end
context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end
context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:33:03Z

Onkashid:

== Expertiza Background ==
[http://expertiza.ncsu.edu/ Expertiza] is an assignment portal developed by faculties and students at NCSU. It provides a platform for the faculties to create assignments for students. Faculties can have assignments with staged deadlines. Expertiza has support to create teams for students, track the team members and provide review for the work done by team members. Students can also provide reviews for peer team's assignment submission. Expertiza has been developed on Ruby on Rails and is available on github.

== Problem Description ==
Following is an OSS project which deals with refactoring of stage deadlines in assignment.rb file. An assignment can have incremental deadlines for different topics in a single assignment. This project involves refactoring the functions in assignment.rb file related to stage deadlines. There were five functions to check what kind of stage an assignment is in. However, the names of these functions were ambiguous and functionalities implemented in some of them overlapped with each other. By the end of this project we have refactored these deadline functions.

== Current Scenario ==
The assignment.rb file has the following functions implemented : 
1. current_stage_name(topic_id = nil) 
2. find_current_stage(topic_id = nil) 
3. get_current_stage(topic_id = nil) 
4. link_for_current_stage(topic_id = nil) 
5. stage_deadline(topic_id = nil) 

We have found the following issues with the code with respect to Ruby conventions :

Multiple calls to DueDate.get_next_due_date() 

Problem with Existing code: 
In the existing code, DueDate.get_next_due_date(self.id, topic_id) has been called at numerous places. This does not follow the ruby coding standards.

Solution: 
New private method next_due_date(topic_id) has been added. This function returns the next_due_date by calling the get_next_due_date method on DueDate.

File: app/models/assignment.rb 
Code:
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end

Following places have been refactored. 

Screenshots.

Checking finished status with static string “Finished” 

Problem with Existing code: 
The above methods have been used at various places to check finish status of assignment by comparing with “Finished”. This does not follow ruby coding standards, as we should never compare with static things. Otherwise it becomes difficult to refactor the code later.

Solution: 
Assignment is said to be finished if the next due is nil. A new private method finished? has been added. It calls the above next_due_date method and returns true if the next_due_date is nil.

File: app/models/assignment.rb
Code:
def finished?( topic_id = nil )
next_due_date(topic_id).nil?
end

The check with “Finished” has been replaces with a call to finished? . The code has been refactored at following places. 

Screenshots.

Return “Unknown” when topic_id is missing 

Problem with existing code: 
When it is staggered deadline and the topic_id is nil, “Unknown” is returned. This does not follow the DRY Principle. Never should we compare with static strings.

Solution: 
To make the code more readable and understandable, and to DRY out the code we have added a new private method topic_missing? to check if the topic is missing in case of staggered deadline.

File:app/models/assignment.rb 
Code:
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end

The code has been refactored at following places: 
#TODO

find_current_stage method removed 

Problem with the existing code: 
The method find_current_stage has been used locally in assignment.rb and once in students controller. However internally, this method calls the next_due_date method for the assignment which has already been separated out.

Solution: 
The method find_current_stage has been removed. The places where it was called has been replaced by a call to next_due_date method.

File: app/models/assignment.rb , app/controllers/student_controller.rb

Code:
Before:
due_date = find_current_stage(topic_id)

After:
due_date = DueDate.get_next_due_date(self.id.topic_id)

The code has been refactored in assignments.rb and the students controller at following places: 

#TODO

link_for_current_stage method removed 

Problem with existing code: 
The method link_for_current_stage was called once in list.html.erb. This method checks if the current assignment has any URL specified with it and would return it if present. However, the database has no such value. As a result, the if condition where the function was called always evaluated to false.

Solution: 
The function link_for_current_stage has been removed. The call to this function has also been removed and the code has been refactored accordingly.

File: app/models/assignment.rb , app/views/list.html.erb

The code in list.html.erb has been refactored as follows:

#TODO

== Automated Testing using RSPEC ==

Tests for get_current_stage() 
The current stage of expertiza did not have any tests for get_current_stage. We have added the test for the same as follows:

File: spec/models/assignment_spec.rb 
Code:
describe '#get_current_stage ' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage (123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(assignment).to receive(:next_due_date).with(123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage(123)).to eq('Review')
end
end
end
end

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:30:43Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:29:27Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:27:44Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-11-06T21:01:07Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-29T02:59:45Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-29T02:59:23Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-29T02:59:07Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-29T02:52:47Z

Onkashid:

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-28T23:55:39Z

Onkashid:

== Expertiza Background ==

CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb

2019-10-28T23:36:12Z

Onkashid: Created page with "hi"

CSC/ECE 517 Fall 2019

2019-10-28T23:29:14Z

Onkashid:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]

CSC/ECE 517 Fall 2019

2019-10-28T23:26:49Z

Onkashid: