Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T21:24:50Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

''Issue 1:'' When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
''Issue 2:'' For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
''Issue 3:'' In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
''Issue 4:'' For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
''Issue 5:'' For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
''Issue 6:'' Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file renders the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)
* app/views/reports/_team_score_score_awarded.html.erb (issue 4)
** This file will be created to assist with the rendering within _review_report.html.erb

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

Additional files changed from bugs we discovered: 

*app/model/assignment.rb - Fixed the varying_rubrics_by_round? method
*spec/model/assignment_spec.rb - Added Rspec tests for varying_rubrics_by_round? method

== '''UML Diagram''' ==

[[File:USE_CASE.png|720px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. We also fixed the bugs by adjusting a method inside assignment.rb, and so we added automated tests to cover this method. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines. 

The following is an overview of jQuery TableSorter which we used to preform the column header sorting on each of our three reports: 
==='''jQuery tablesorter 2.0'''===

* Multi-column sorting
* Multi-tbody sorting
* Parsers for sorting text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats), time. Add your own easily
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria)
* Extensibility via widget system
* Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+
* Small code size
 
To learn more about the use of tablesorter jQuery to sort the author feedback, review, and teemate review reports, see the [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc#Solution, E2018 Design Doc] 

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
Previous:

[[File:To i previous.png|720px]]

[[File:-=bug.png|720px]]

Current:

[[File:Fixed view.png|720px]]

[[File:Fixedmodel.png|720px]]

[[File:Fixed author feedback.png|720px]]

3. Formatting issue in review report:
*The review report table was previously created with a different style and format than the other tables; however, it seems that this problem only occurred when opening within a Chrome browser.
*We edited _review_report.html.erb to ensure the review report table matched the formatting of the other tables.

Previous Layout:

[[File:review_report_format_prev.png|720px]]

Current Layout:

[[File:review_report_format.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb
* /views/reports/_teammate_review_report.html.erb

Changes made:

* For each of the listed files there were many one or two letter words that did not properly explain the variable's use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Original Implementation: 
[[File:Current_implementation_1.png|480px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

File:Review report format prev.png

2020-11-17T21:24:01Z

Mbgaffor:

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T21:22:57Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

''Issue 1:'' When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
''Issue 2:'' For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
''Issue 3:'' In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
''Issue 4:'' For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
''Issue 5:'' For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
''Issue 6:'' Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file renders the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)
* app/views/reports/_team_score_score_awarded.html.erb (issue 4)
** This file will be created to assist with the rendering within _review_report.html.erb

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

Additional files changed from bugs we discovered: 

*app/model/assignment.rb - Fixed the varying_rubrics_by_round? method
*spec/model/assignment_spec.rb - Added Rspec tests for varying_rubrics_by_round? method

== '''UML Diagram''' ==

[[File:USE_CASE.png|720px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. We also fixed the bugs by adjusting a method inside assignment.rb, and so we added automated tests to cover this method. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines. 

The following is an overview of jQuery TableSorter which we used to preform the column header sorting on each of our three reports: 
==='''jQuery tablesorter 2.0'''===

* Multi-column sorting
* Multi-tbody sorting
* Parsers for sorting text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats), time. Add your own easily
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria)
* Extensibility via widget system
* Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+
* Small code size
 
To learn more about the use of tablesorter jQuery to sort the author feedback, review, and teemate review reports, see the [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc#Solution, E2018 Design Doc] 

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
Previous:

[[File:To i previous.png|720px]]

[[File:-=bug.png|720px]]

Current:

[[File:Fixed view.png|720px]]

[[File:Fixedmodel.png|720px]]

[[File:Fixed author feedback.png|720px]]

3. Formatting issue in review report:
*The review report table was previously created with a different style and format than the other tables; however, it seems that this problem only occurred when opening within a Chrome browser.
*We edited _review_report.html.erb to ensure the review report table matched the formatting of the other tables.

Previous Layout:

Current Layout:

[[File:review_report_format.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb
* /views/reports/_teammate_review_report.html.erb

Changes made:

* For each of the listed files there were many one or two letter words that did not properly explain the variable's use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Original Implementation: 
[[File:Current_implementation_1.png|480px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T21:19:46Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

''Issue 1:'' When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
''Issue 2:'' For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
''Issue 3:'' In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
''Issue 4:'' For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
''Issue 5:'' For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
''Issue 6:'' Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file renders the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)
* app/views/reports/_team_score_score_awarded.html.erb (issue 4)
** This file will be created to assist with the rendering within _review_report.html.erb

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

Additional files changed from bugs we discovered: 

*app/model/assignment.rb - Fixed the varying_rubrics_by_round? method
*spec/model/assignment_spec.rb - Added Rspec tests for varying_rubrics_by_round? method

== '''UML Diagram''' ==

[[File:USE_CASE.png|720px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. We also fixed the bugs by adjusting a method inside assignment.rb, and so we added automated tests to cover this method. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines. 

The following is an overview of jQuery TableSorter which we used to preform the column header sorting on each of our three reports: 
==='''jQuery tablesorter 2.0'''===

* Multi-column sorting
* Multi-tbody sorting
* Parsers for sorting text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats), time. Add your own easily
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria)
* Extensibility via widget system
* Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+
* Small code size
 
To learn more about the use of tablesorter jQuery to sort the author feedback, review, and teemate review reports, see the [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc#Solution, E2018 Design Doc] 

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
Previous:

[[File:To i previous.png|720px]]

[[File:-=bug.png|720px]]

Current:

[[File:Fixed view.png|720px]]

[[File:Fixedmodel.png|720px]]

[[File:Fixed author feedback.png|720px]]

3. Formatting issue in review report:
*The review report table was previously created with a different style and format than the other tables.
*We edited _review_report.html.erb to ensure the review report table matched the formatting of the other tables.

Previous Layout:

Current Layout:

[[File:review_report_format.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb
* /views/reports/_teammate_review_report.html.erb

Changes made:

* For each of the listed files there were many one or two letter words that did not properly explain the variable's use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Original Implementation: 
[[File:Current_implementation_1.png|480px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

File:Review report format.png

2020-11-17T21:18:23Z

Mbgaffor:

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T21:02:40Z

Mbgaffor: /* Refactoring and Redocumentation */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

''Issue 1:'' When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
''Issue 2:'' For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
''Issue 3:'' In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
''Issue 4:'' For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
''Issue 5:'' For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
''Issue 6:'' Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file renders the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)
* app/views/reports/_team_score_score_awarded.html.erb (issue 4)
** This file will be created to assist with the rendering within _review_report.html.erb

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

Additional files changed from bugs we discovered: 

*app/model/assignment.rb - Fixed the varying_rubrics_by_round? method
*spec/model/assignment_spec.rb - Added Rspec tests for varying_rubrics_by_round? method

== '''UML Diagram''' ==

[[File:USE_CASE.png|720px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. We also fixed the bugs by adjusting a method inside assignment.rb, and so we added automated tests to cover this method. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines. 

The following is an overview of jQuery TableSorter which we used to preform the column header sorting on each of our three reports: 
==='''jQuery tablesorter 2.0'''===

* Multi-column sorting
* Multi-tbody sorting
* Parsers for sorting text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats), time. Add your own easily
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria)
* Extensibility via widget system
* Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+
* Small code size
 
To learn more about the use of tablesorter jQuery to sort the author feedback, review, and teemate review reports, see the [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc#Solution, E2018 Design Doc] 

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
Previous:

[[File:To i previous.png|720px]]

[[File:-=bug.png|720px]]

Current:

[[File:Fixed view.png|720px]]

[[File:Fixedmodel.png|720px]]

[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb
* /views/reports/_teammate_review_report.html.erb

Changes made:

* For each of the listed files there were many one or two letter words that did not properly explain the variable's use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Original Implementation: 
[[File:Current_implementation_1.png|480px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T20:17:05Z

Mbgaffor: /* Files Requiring Modification */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file renders the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)
* app/views/reports/_team_score_score_awarded.html.erb (issue 4)
** This file will be created to assist with the rendering within _review_report.html.erb

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

Additional files changed from bugs we discovered: 

*app/model/assignment.rb - Fixed the varying_rubrics_by_round? method
*spec/model/assignment_spec.rb - Added Rspec tests for varying_rubrics_by_round? method

== '''UML Diagram''' ==

[[File:USE_CASE.png|720px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
Previous:

[[File:To i previous.png|720px]]

[[File:-=bug.png|720px]]

Current:

[[File:Fixed view.png|720px]]

[[File:Fixedmodel.png|720px]]

[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|480px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:44:58Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:44:43Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

<script>
$(function () {
/*Function for sorting the table */
$("#myTable").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
});
$.tablesorter.addParser({
id: "customParser", //customParser for sorting by volume
is: function (stringValue) {
return false;
},
format: function (stringValue) {
var stringNumericPart = stringValue.split(" "); //split the data by spaces
var numericValue = parseInt(stringNumericPart[2], 10); //extract the numeric data
return numericValue;
},
type: 'numeric'
});

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:43:42Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

[[File:Sort_code3.png|720px]]

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

File:Sort code3.png

2020-11-17T01:42:52Z

Mbgaffor:

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:40:56Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

[[File:AssignHeader.png | 360px]]

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:39:27Z

Mbgaffor: /* Sort/Modify Headers in Author Feedback report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

[[File:Sort_code1.png|520px]] [[File:Sort_code2.png|460px]]

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

Current Implementation:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:37:34Z

Mbgaffor: /* Sort/Modify Headers in Author Feedback report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

[[File:Sort_code1.png|520px]] [[File:Sort_code2.png|460px]]

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.
* An example of the change can be seen below:

[[File:feedback_report_header.png|1080px]]

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

File:Feedback report header.png

2020-11-17T01:36:23Z

Mbgaffor:

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:29:33Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below:

[[File:Sort_code1.png|520px]] [[File:Sort_code2.png|460px]]

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

File:Sort code2.png

2020-11-17T01:26:34Z

Mbgaffor:

File:Sort code1.png

2020-11-17T01:26:13Z

Mbgaffor:

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-17T01:22:14Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.
* The sorting was implemented using tablesorter jQuery. An example of the script that was used for this can be found below.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:
*There was a problem where assignments that had two different rubrics across rounds appeared with some graphical bugs.
*Changes were made in model/assignment.rb and view/_feedback_report.html.erb
*Originally, view caused crash due to undefined "+" with nil object, so the to_i method was called to prevent this.
*A graphical error happened causing poor layouts to appear, which was fixed by altering some model logic (<= to <)
[[File:Fixed author feedback.png|720px]]

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 
[[File:Fixed implementation1.png|720px|]] 
==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

==== Google Chrome Error ====
The bug couldn't be replicated on Windows 10. The prior group failed to find this bug as well, so we assumed that it has been patched in the past. It was likely poorly documented, but we recommend closing that issue.

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:24:49Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

Previous:

[[File:BeforeRefactor.png|360px]]

Current:

[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:23:51Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

[[File:BeforeRefactor.png|360px]]
[[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:23:34Z

Mbgaffor: /* Previous Implementation Bug Fixes */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.

[[File:BeforeRefactor.png|360px]] [[File:AfterRefactor.png|360px]]

2. Formatting issue in the author feedback report table:

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:19:43Z

Mbgaffor: /* Solution Implemented */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===
All changes for this issue were made in the files:

* /views/reports/_feedback_report.html.erb

Changes made to fix the bugs that were found:

1. Drag and Drop capability in the author feedback report table:
* The previous implementation had enable the sortable feature found in tablesorter jQuery tables. This feature allows the user to drag an entry within the table and move it to do manual sorting. This would cause the layout of the table to mess and so we removed the feature to prevent this.
2. Formatting issue in the author feedback report table:

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:09:59Z

Mbgaffor: /* Solution Implemented */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

==='''Previous Implementation Bug Fixes'''===

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:09:18Z

Mbgaffor: /* Refactoring and Redocumentation */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:04:35Z

Mbgaffor: /* Refactoring and Redocumentation */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Refactor and enhance documentation in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

Changes made:
*

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to each file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:04:11Z

Mbgaffor: /* Solution Implemented */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Refactor and enhance documentation in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

Changes made:
*

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

=== '''Refactoring and Redocumentation''' ===
All changes for this issue were made in the files:

* /views/reports/_review_report.html.erb
* /views/reports/_feedback_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to the file to ensure that it is easily explained and readable for future developers

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:00:57Z

Mbgaffor: /* Refactor and Re-document Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Refactor and Re-document Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to the file to ensure that it is easily explained and readable for future developers

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Refactored and enhanced documentation in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T23:00:45Z

Mbgaffor: /* Refactor and Re-document Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Refactor and Re-document Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly explain the variables use. We changed these variable names to make them more readable.
* We added comments to the file to ensure that it is easily explained and readable for future developers

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Refactored and enhanced documentation in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T22:59:48Z

Mbgaffor: /* Refactor and Re-document Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Refactor and Re-document Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb

Changes made:

* Throughout the .erb file responsible for rendering the review report page there were many one or two letter words that did not properly
explain the variables use. We changed these variable names to make them more readable.
* We added comments to the file to ensure that it is easily explained and readable for future developers

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Verify added Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Previous implementation added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

Verified that prior implementation indeed was successful. Hence, no further additions were required for this issue.

=== '''Fix formatting in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown menu performance''' ===
Issue wasn't replicable in Chrome on Windows 10, same as prior implementation group. Hence, no changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T22:55:38Z

Mbgaffor: /* Sort Headers in View Review Report */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Refactor and Re-document Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Changes needed for this issue were:
* Add a header to the top of the "View Reports" page for each assignment

This added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

No further additions were required for this issue.

=== '''Fix formatting in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown performance in dropdown''' ===
Issue wasn't replicable in Chrome on Windows 10. Hence, no changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T22:55:04Z

Mbgaffor: /* Solution Implemented */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Changes needed for this issue were:
* Add a header to the top of the "View Reports" page for each assignment

This added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

No further additions were required for this issue.

=== '''Fix formatting in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown performance in dropdown''' ===
Issue wasn't replicable in Chrome on Windows 10. Hence, no changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T22:48:47Z

Mbgaffor: /* Solution */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:''' 
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

To address the sorting issues stated above the previous team utilized tablesorter jQuery. This implementation worked well to solve the sorting problems and so our group will reuse that strategy; however, by using that implementation we introduced a lot of bugs that were not previously fixed as well as code that needed to be refactored to ensure it followed proper Ruby guidelines. We were able to find the root of each bug we found using UI testing, and fixed each issue. Additionally, we added numerous comments to further explain both the new code introduced into the project by our group and the previous team, and the code that was already present within the project. While at the same time renaming variables and refactoring code within views that did not follow proper guidelines.

*To learn more about the use of tablesorter jQuery to sort the tables view the following design document:

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Changes needed for this issue were:
* Add a header to the top of the "View Reports" page for each assignment

This added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

No further additions were required for this issue.

=== '''Fix formatting in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown performance in dropdown''' ===
No changes were made for this issue.

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-11-16T21:51:45Z

Mbgaffor: /* Problem Statement */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports that can be viewed for a specific assignment. Our issue revolves around formatting these report views correctly and in a way that displays all necessary information in an organized fashion, as well as implementing and improving upon the sorting functions for each report/table of information. We also refined the existing code by increasing the documentation, removing out-standing bugs, and writing additional rspec tests. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library. This project was attempted previously and was partially merged. We will need to review their code and fix the bugs and refactor the code to ensure that the implementation will be able to merge.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

'''Current Implentation:'''
https://github.com/expertiza/expertiza/pull/1845 
https://github.com/lburgess07/expertiza/tree/beta 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. We have reviewed the code and found bugs that are preventing the program from working correctly that need to be fixed. 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''UML Diagram''' ==

[[File:USE_CASE.png|1080px|]] 

== '''Solution''' ==

We will be using tablesorter jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter library supports to sort those columns. According to the problem type, we are supposed to perform three kinds of sorting. All these have one thing in common. Adding up the tablesorter script in the body before using them. After including the script, we are supposed to do some modifications in the table tag by including the class. Three types of scenario may arise:

1) Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it to enable the sorting alphabetically.

2) Sorting by date - It includes adding of a date default format in the script to denote the sorter type that must be used to sort the column of the date.

3) Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

==='''jQuery tablesorter 2.0'''===

* Multi-column sorting
* Multi-tbody sorting
* Parsers for sorting text, URIs, integers, currency, floats, IP addresses, dates (ISO, long and short formats), time. Add your own easily
* Support secondary "hidden" sorting (e.g., maintain alphabetical sort when sorting on other criteria)
* Extensibility via widget system
* Cross-browser: IE 6.0+, FF 2+, Safari 2.0+, Opera 9.0+
* Small code size

== '''Solution Implemented''' ==
=== '''Sort Headers in View Review Report''' ===
All changes for this issue were made in the files:

* /views/reports/review_report.html.erb
* /views/reports/_team_score_score_awarded.html.erb

The changes required for the Review Report table were:

* Make the "Reviews Done", "Team Reviewed", and "Score Awarded/Average Score" columns sortable.

=== '''Sort/Modify Headers in Author Feedback report''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The changes required for Author Feedback table were -

* Changing the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”.

=== '''Sort Teammate Review report''' ===

All changes for this issue were made in the file /views/reports/_teammate_review_report.html.erb

Changes needed for these issue were -

* We have to sort the first 3 columns as a string and sort the last column as a date in the “Teammate Reviews” table

=== '''Add Header to View Reports''' ===
All changes for this issue were made in the file /views/reports/response_report.html.haml

Changes needed for this issue were:
* Add a header to the top of the "View Reports" page for each assignment

This issue was trivial to resolve. It came down to adding the following three lines of haml to the top of the aforementioned file:

%h1
Reports for
= @assignment.name

This added a header to the top of the "View Reports" page reading "Reports for <name of assignment>".

=== '''Fix formatting in Author Feedback Reports''' ===

All changes for this issue were make in the file /views/reports/_feedback_report.html.erb

The issues presented were -
* For "Author feedback reports" table when no feedback has been submitted, the names of students appear in a strange horizontal format. This formatting should be fixed.

=== '''Verify dropdown performance in dropdown''' ===
No changes were made for this issue.

== '''Increased Code Documentation''' ==

== '''Test Plan''' ==
For our project, which is mostly concerned with making changes to different views, we are planning to do the majority of testing through manual UI testing.
As of now, we don't anticipate having to make many/any changes to files that are not views. If any changes are made to controllers, models, etc to accomplish our tasks, we will adjust or add SPEC tests to make sure our code is covered.
=== '''UI Testing''' ===
==== Configuration ====
1. Log in as an instructor6 
2. Click manage and then assignments. 
3. Choose an assignment and click the button/icon for 'View Reports' 
* A good assignment to use is the 'Final project (and design doc)' for testing purposes.

==== Review Report Sorting ====
1. From the dropdown, select '''Review report''' and click '''View'''
Test the following features for correctness:
* “Reviewer” and “Metric” are sortable
* “Review done” by the first number then the second number (e.g., 0/1, 0/2, 0/3, 1/1, 1/5, 2/2...)
* “Team reviewed” is sorted alphabetically
* “Score awarded / Avg. score” (the first percentage) is sorted in both ascending or descending order

==== Author Feedback Report Sorting ====
1. From the dropdown, select '''Author feedback''' and click '''View'''
Verify the following changes:
* Header name “Review response rejoined” -> “Review responded to”
* Change “Last rejoined at” to “Last responded at”.
* Verify sorting works as expected:
** Sort “Rejoinder” and “Review responded to” as string (alphabetically) 
** Sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table)
** Sort “Last responded at” as date. 
Current Implementation: 
[[File:Current_implementation_1.png|720px|]] 
Fixed Implementation: 

==== Teammate Review Report Sorting ====
1. From the dropdown, select '''Teammate Review Report''' and click '''View'''
Verify the following changes:
* Able to sort the first 3 columns as string
* Able to sort the last column as date.

==== Drag and Drop Bug ====
Upon implementation of previous groups' work, we found a drag and drop bug where items in report were draggable. We have fixed the bug, but testing can be performed by the following:
* Navigate to all three of the different reports outlined above
* Verify no items/cells are draggable

=== '''Automated Testing''' ===
We made changed to the Assignmnet#vary_rubrics_by_round? method in order to fix a bug. The method did not have any RSPEC tests written. 
We have written RSPEC tests to throughly test this method. The RSPEC tests are added in spec/models/assignment_spec.rb and are as follows:

describe '#vary_rubrics_by_round?' do
context 'when rubrics varies over rounds' do
it 'should return true' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 2
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1, assignment_questionnaire2])
expect(assignment.varying_rubrics_by_round?).to be true
end
end
context 'when rubrics do not vary over rounds' do
it 'should return false' do
assignment_questionnaire1.used_in_round = 2
assignment_questionnaire2.used_in_round = 1
allow(AssignmentQuestionnaire).to receive(:where).and_return([assignment_questionnaire1])
expect(assignment.varying_rubrics_by_round?).to be false
end
end
end

== '''Team Information''' ==

John Bumgardner 
Luke Burgess 
Robert Casano 
Micah Gafford

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-10-22T01:58:03Z

Mbgaffor: /* Use Case Diagram */

== '''Introduction''' ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. 

== '''Problem Statement''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, average should be made sortable by using the same existing sort library.
Note: This project has been attempted and partially merged.

'''Previous Implementation:'''
There has been an attempt on this project this spring after the partial merge, and the following submission was made: 
https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2020_-_E2018_sort_instructor_reports_by_name_ID_score_etc 
https://github.com/expertiza/expertiza/pull/1723 
https://github.com/jandres61/expertiza/tree/beta 
https://youtu.be/uZfo4MWsnrI 

=== '''What needs to be done''' ===

1. When the user clicks on the “View reports” icon, a page appears with a drop-down. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top. 
2. For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback. 
3. In Chrome on Windows 10, the dropdown has a tendency to freeze up, especially after one report has been viewed. Please reproduce the problem, find a fix, and implement it. 
4. For “Author feedback report” table, change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date. 
5. For “Teammate review report” table, sort the first 3 columns as string and sort the last column as date. 
6. Refactor previous implementation. There is a heavy amount of code in views that can be moved into models to make the code more DRY and follow Ruby guidelines better 

==== '''Add Assignment Name Header''' ====

Our goal is to add a header to every “Review Report” view page that will show the name of the assignment that is being viewed.

==== '''Author Feedback Report Formatting''' ====

Our goal is to format the Author Feedback Report to resolve a formatting issue when no feedback has been submitted by any student. When this is the case, the names of the participants appear in a strange horizontal format. We must resolve this so that the formatting is correct regardless of how many participants have done author feedback.

==== '''Chrome Dropdown Freezing''' ====

Our to reproduce the problem of the drop down freezing when viewing within a Chrome browser and if possible change the current implementation to prevent the freezing from occurring.

==== '''Edit Author Feedback Report table headers''' ====
Our goal is to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at” within the author feedback report table view.

==== '''Sorting Author Feedback Report Table''' ====

Our goal is to refactor the sorting mechanism for sorting the author feedback report table. This will consist of four different ways to sort:
Sort “Rejoinder” as string (alphabetically)
Sort “Review responded to” as string (alphabetically)
Sort “# Author Feedbacks Done” by the first number and then the second number
Same as “Review done” in the “View review report” table
Sort “Last responded to” as date

==== '''Sort Teammate Review Report table''' ====
Our goal is to edit the way the sorting operates for the teammate review report table. The first three columns of the teammate review report table will be sorted as strings and the last column as date.

== '''Design''' ==

==='''Files Requiring Modification'''===

* app/views/reports/response_report.html.haml (issue 1, 3, 4)
It appears this HAML file defines the dropdown that appears at the top of the “Review reports” page and renders the partials for the requested type of report when submitting the dropdown.

* app/controllers/reports_controller.rb (issue 1)

We will also likely need to be adding a line to determine the assignment name and pass it into the view.

* app/views/reports/_feedback_report.html.erb (issue 2, 4)

This file contains the code which generates the author Feedback reports table. This is a form that is rendered by the response_report.html.haml file when the Feedback report is requested from the dropdown. This gives us access to the column names which require change. Making the columns sortable will be done in this file.

* app/helpers/review_mapping_helper.rb (issue 2)

This file has code which generates the instance variables used by the Feedback reports table and it also creates the headers used by the reports table. Changes may be needed to the header to make the columns sortable.

* app/views/reports/_searchbox.html.erb (issue 3)

This file contains the html erb form code for the dropdown to select which type of review the user wants to render. After reproducing and determining the root of the issue, we will likely need to make edits to this file in order to resolve the problem. This is for Chrome on Windows 10, and will have to be reproduced to see what’s causing the issue.

* app/views/reports/_review_report.html.erb (issue 4)

This issue requires the assignment name to be displayed for the particular review report. We will use the set instance variables to display the assignment name.

* app/views/reports/_teammate_review_report.html.erb (issue 5)

This file contains the source for displaying the teammate review report. We will have to edit this file to adjust the sorting of the columns.

Design Patterns aren't applicable to our project since all it involves is to make columns sortable and some isolated issues.

== '''Use Case Diagram''' ==

CSC/ECE 517 Fall 2020 - E2084 sort instructor reports by name ID score etc

2020-10-22T01:56:40Z

Mbgaffor: Created page with "== '''Introduction''' == Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT..."

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-21T17:01:25Z

Mbgaffor: /* UI Testing */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. 
- (This particular error is out of scope of our current project) 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

[[File:Screenshot_2020-10-21_113943.png|720px]]

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand. 
2. Currently, if there are no reviews for an assignment you are thrown an error when trying to review the report. We did not fix this, due to it being out of scope of our project, but this error could be caught and the user could be redirected which would make the project work much better.

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-21T17:00:34Z

Mbgaffor: /* UI Testing */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. (This particular error is out of scope of our current project) 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

[[File:Screenshot_2020-10-21_113943.png|720px]]

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand. 
2. Currently, if there are no reviews for an assignment you are thrown an error when trying to review the report. We did not fix this, due to it being out of scope of our project, but this error could be caught and the user could be redirected which would make the project work much better.

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-21T16:59:54Z

Mbgaffor: /* Scope for future improvement */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

[[File:Screenshot_2020-10-21_113943.png|720px]]

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand. 
2. Currently, if there are no reviews for an assignment you are thrown an error when trying to review the report. We did not fix this, due to it being out of scope of our project, but this error could be caught and the user could be redirected which would make the project work much better.

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-21T16:59:37Z

Mbgaffor: /* Scope for future improvement */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

[[File:Screenshot_2020-10-21_113943.png|720px]]

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand.
2. Currently, if there are no reviews for an assignment you are thrown an error when trying to review the report. We did not fix this, due to it being out of scope of our project, but this error could be caught and the user could be redirected which would make the project work much better.

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-21T15:42:36Z

Mbgaffor: /* UI Testing */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

[[File:Screenshot_2020-10-21_113943.png|720px]]

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand.

File:Screenshot 2020-10-21 113943.png

2020-10-21T15:40:52Z

Mbgaffor:

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-20T00:52:27Z

Mbgaffor: /* UI Testing */

This wiki page is for the description of changes made under E2072 OSS assignment for Fall 2020, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU and supported by MIT and the National Science Foundation.

It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentParticipant model and Review Mapping helper. It focuses on refactoring unkept, unused and misleading methods within the aforementioned files. The project’s goal is to enhance some of the methods in use and clean up others that were either outdated or in need of improvement. Some other parts of the application were modified as well to work with our changes in the Assignment Participant model.

== Files Modified ==

Our project focused primarily on refactoring the assignment_partipant.rb Model file. The files modified for this project are: 
1. assignment_participant.rb 
2. review_mapping_helper.rb 
3. assignment_participant_spec.rb 
4. publishing_controller.rb 
5. user.rb 
6. quiz_assignment.rb 
7. response.rb 
8. response_spec.rb 

=== Assignment Participant Model ===

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

=== ReviewMappingHelper ===

This is a helper class that contained methods to help calculate and display information regarding participant reviews and the volume of each review. One non-functional method was removed from the file and two other methods were updated to support sorting the volume of an arbitrary number of review rounds.

== List of Changes ==
We worked on the following work items(WIs) 
WI1: Refactor self.grant_publishing_rights to assign_copyright 
WI2: Determine whether reviews_by_reviewer method is still needed. 
WI3: Refactor copy method name 
WI4: Refactor assign_quiz 
WI5: Refactor Review Score 
WI6: Rewrite Score calculation within the scores method 
WI7: Refactor Volume - # Distinct Words in a Review 
WI8: Provide documentation for Compute_Assignment_Score 

=== Solutions Implemented and Delivered ===
'''Refactoring Review Volume'''

This involved three methods in review_mapping_helper.rb, sort_reviewer_by_review_volume_desc, initialize_chart_elements and display_volume_metric. The first two methods worked together to sort the reviews by the average volume of reviews in each round of an assignment and then move the data of reviews in each round from a current round to prepare to display the information in chart form. The last method was found to not be used within the entirety of the project.

The following changes were made:

1. The methods were originally implemented in a way that only allowed for the information from three rounds of an assignment to be gathered. The functions had to be re-implemented using a loop that could gather and initialize the data from any given number of rounds.

2. The display_volume_metric was no longer being used within the rest of the project and so was removed to clean up the file.

sort_review_by_review_volume_desc loop re-implementation:

[[File:expertiza_change_1.png|1080px|]]

Initialize_chart_elements loop re-implementation:

[[File:517_screenshot3.png|500px|]] [[File:517_screenshot4.png|500px|]]

Display_volume_metric removal:

[[File:517_screenshot5.png|720px|]]

 
'''Rewrite Scores Method''' 

The scores method returns the scores that a specific assignment_participant has received Originally, the scores method contained several convoluted method calls with some unused and commented out code. Our team was tasked with rewriting the scores method in assignment_participant.rb to make it more readable and transparent.

The following changes were made to accomplish this task: 
1. Removed topic_total_scores (score calculations for a microtask) and moved it into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_1.png|720px|]] 
2. Removed calculate_scores method and refactored the code into the scores method, since this method was only called once and wasn't used anywhere else. I also removed the associated tests. 
[[File:rewrite_scores_2.png|720px|]] 

3. Refactored the merge_scores method which is called by Scores. 
* DRYed out the code by adding a new update_min_or_max method that dynamically sets the min or max 
[[File:rewrite_scores_3a.png|720px|]] 
* Refactored merge_scores to use update_min_or_max method. 
[[File:rewrite_scores_3b.png|720px|]] 
* Added 6 RSPEC tests for this new update_min_or_max method 

4. Added comments for the scores method and merge_scores method 
<Image Here>

 
'''Refactor assign_quiz Method''' 

The assign_quiz method was originally located in the assignment_participant.rb file and was requested to be moved into quiz_questionnaire.rb. However, upon further investigation, it was discovered that there existed two assign_quiz_dynamically methods, one which called the aforementioned assign_quiz method. Our investigation concluded that a newly constructed assign_quiz_dynamically method, located in review_mapping_controller.rb, had become the primary method of performing the tasks associated with assign_quiz and assign_quiz dynamically. Hence, following the consultation of our mentor, we elected to remove the definition and all instances of assign_quiz (assignment_participant.rb) and assign_quiz_dynamically (quiz_assignment.rb).

The following changes were made:

1. Removed definition of assign_quiz method (assignment_participant.rb)

[[File:remove_quiz.png|1080px|]]

2, Removed all unused instances assign_quiz_dynamically (defined in quiz_assignment.rb)
* Alternative assign_quiz_dynamically method located in review_mapping_controller.rb became the primary method used in recent years

[[File:dynamic.png|720px|]]

3. Ensured all instances of assign_quiz_dynamically (review_mapping_controller.rb) were untouched and operational as expected
* This definition does not implement assign_quiz method from assignment_participant

4. Removed #assign_quiz spec test from assignment_participant_spec.rb (see "Testing Details")

 
'''Investigate reviews_by_reviewer Method''' 

The reviews_by_reviewer method returns the reviews of a certain assignment_participant. However, for the past 5 years or so all reviews have been of assignment_teams, not assignment_participant. Our team was tasked with investigating the reviews_by_reviewer method in assignment_participant.rb to determine whether it is still used, or would be useful to continue maintaining.

The following determinations were made:
1. Determined that all reviews are of assignment_teams and not of assignment_participant
2. The only calls to reviews_by_reviewer method happen in CollusionCycle.
3. After verifying with Yang and Dr. Gehringer, we determined that Collusion Cycle is no longer used in the application. CollusionCycle was originally a piece of code that helped detect whether bias existed when teammates gave reviews of other teammates' work.
4. Because CollusionCycle is unused, we deemed it appropriate to make the following changes:
* Removed the method definition from assignment_participant.rb
[[File:reviews_by_reviewer_1.png]] 
* Removed the rspec test for this method
[[File:reviews_by_reviewer_2.png]] 

 
'''Refactor copy Method Name''' 

The copy method was determined to have a misleading name for a method that copies a participant to a course. As a result, the copy method name was refactored into 'copy_participant'.

The resulting changes were made to correspond to the name change:

1. Refactored copy method in assignment_participant.rb into 'copy_participant'

[[File:copy_part.png|720px|]]

2. Refactored all instances of copy_participant associated with a assignment_participant
* Spec test in assignment_participant_spec.rb was only instance found (see "Testing Details")

 
'''Refactor self.grant_publishing_rights to assign_copyright''' 

Aside from simply refactoring the name of self.grant_publishing_rights into assign_copyright, upon further investigation, we noted that the definition of the method in assignment_participant.rb, did not require the participant parameter and participant loop, but was simplified by moving this functionality to wherever the method is called in the application.

The following changes were made:

1. Refactored self.grant_publishing_rights into 'assign_copyright'
* Refactored definition of the method in assignment_participant.rb, removing the participant parameter and participant loop; moving this functionality to wherever the method is called in the application

[[File:assign_copyright.png|720px|]]

2. Altered functionality of the method call in def generate_keys (user.rb) to handle the 'participants.each do' loop

[[File:user_part.png|720px|]]

3. Altered functionality of the method call in grant_with_private_key (publishing_controller.rb) to handle the 'participants.each do' loop

[[File:pub_part.png|720px|]]

4. Built spec test for modified assign_copyright method in assignment_participant_spec.rb (see "Testing Details")
* Creates new RSA key-pair for a participant
* Tests if key matches using assign_copyright

 
'''Refactor review_score method''' 

The review_score method returns the review score for a particular questionnaire. The issue originally stated that the method should be able to determine the review score for any round of review. The original method returned the first round (index position 0) review score.

We made the following determinations:
1. The review_score method only returns the first round review score which is from index position 0: 
[[File:review_score_1.png|720px|]] 
2. We determined that review_score method is only being called in collusion_cycle.rb, which is no longer used in the Expertiza application. 

3. We determined there was a reference to a “review_score” model in question.rb but there is no model that this refers to: 
[[File:review_score_2.png|720px|]] 
Changes Made:
1. Since review_score was only being called in collusion_cycle.rb, and collusion_cycle.rb is no longer used in the application, we deemed it correct to remove the review_score method from assignment_participant.rb: 
[[File:review_score_3.png|720px|]] 
2. Removed the reference to “review_score” model which appeared to be made in error since there is no review_score model. This change was made in question.rb file. 
[[File:review_score_4.png|720px|]] 

=== Additional Changes to Files ===
 
'''Response.rb''' 
Additionally, in making some of the changes to the way expertiza calculates volumetric scores, we noticed incompatibilities because the methods in assignment_participant.rb call other methods to retrieve score information and calculations, which were hard coded for a maximum of three rounds of review.

We identified two methods in response.rb which dealt with the comments for different rounds of reviews, but would only calculate up to three rounds. These two methods were *self.concatenate_all_review_comments* and *self.get_volume_of_review_comments*. Although these methods are in response.rb which is not the primary focus of our project, our mentor instructed us to change the related methods to be able to run their calculations for any number of rounds of reviews.

The original methods (before our changes) were as follows: 
[[File:response_1.png|720px|]] 
As you can see, self.get_volume_of_review_comments relies and directly calls self.concantenate_all_review_comments. Thus, we needed to rewrite both of these methods to use the same convention as in sort_review_by_review_volume_desc where the calculations should be for any number of rounds, not just three.

We rewrote these two methods as follows to work with any number of rounds of reviews and comments. 
[[File:response_2.png|720px|]] 

In the rewritten code displayed above, our team has changed both methods to function to concatenate all review comments and then get the average word volume for each of those review comments for any number of rounds. This makes the code far more functional and universal to our changes elsewhere in the application.

We also made changes to the RSpec tests for these methods, which will be discussed in the Rspec Testing Section below.

== Testing Details==
=== Test Plan ===
For testing our changes, we focused on updating and designing new automated ''RSpec'' tests for every method. We also made sure to design a UI test to display that more than three rounds of reviews can be displayed on a page. See the [[#UI_Testing]] section. 
 
For RSpec testing, we focused on designing an extensive suite of rspec tests for the assignment_participant model that we primarily dealt with. However, whenever we made any sort of change, we immediately went and updated/created the test cases regarding our changes. All RSPEC test changes are listed below in the [[#RSpec_Testing]] section.
 

=== RSpec ===
'''Refactor assign_quiz Method'''

Removed assign_quiz spec test from assignment_participant_spec.rb to correlate with the deletion of the assign_quiz method itself. 

[[File:assign_quiz_spec.png|720px|]] 

'''Refactor copy Method Name'''

Refactored copy to copy_participant in all spec test instances (assignment_participant_spec.rb).

[[File:copy_spec.png|720px|]]

'''Refactor self.grant_publishing_rights to assign_copyright'''

Following refactor, a new spec test needed to be built for the modified assign_copyright method in assignment_participant_spec.rb.
* Creates new RSA key-pair for a participant
* Assigns the public key of this key-pair to the user.public_key attribute.
* Tests if key matches using assign_copyright 

[[File:copyright_spec.png|720px|]] 
In this test, we created a new RSA key pair in order to effectively test the functionality of the assign_copyright method. We then call the assign_copyright and pass the private key to this method. In order to test whether the function succeeded, we test to make sure that the permission_granted field is set to true for this participant.

'''Rewrite Scores Method'''
As described in the previous section, during the rewrite of the scores method our team cleaned up the merge scores method as well, by creating a new update_max_or_min method and abstracting/DRYing out the code. We wanted to make sure to thoroughly test this new method by adding the following rspec tests: 

1. Removed topic_total_scores tests 
2. Removed calculate_scores tests 
[[File:spec_rewrite_scores_1.png|720px|]] 

We verified that the current scores tests were testing the functionality well and no changes were made to these tests.

3. We added 6 new tests to the rspec file to test the new methods for update_max_or_min. As displayed below, we test updating the min, and the max, under three different conditions. 
[[File:spec_rewrite_scores_2.png|720px|]] 

'''Reviews_by_reviewer Method'''
Since we decided to remove this method because it is unused in the application (besides Collusion_cycle.rb), we removed the associated rspec tests as well: 
[[File:spec_reviews_by_reviewer.png|720px|]] 

'''Review Score'''
We also removed the Rspec tests for review_score method which we removed as stated in the previous section. 
[[File:spec_review_score.png|720px|]] 

'''Collusion Cycle''' 
As discussed in previous section, we also removed some failing tests in collusion_cycle_spec.rb, as per request from Dr. Gehringer, which began failing after we removed methods Collusion Cycle called from assignment_participant.rb. These test removals are displayed below: 
[[File:spec_collusion_cycle_1.png|720px|]]
[[File:spec_collusion_cycle_2.png|720px|]]
[[File:spec_collusion_cycle_3.png|720px|]]
[[File:spec_collusion_cycle_4.png|720px|]]
[[File:spec_collusion_cycle_5.png|720px|]] 

'''Response''' 
As discussed in a previous section, the response.rb file had to be edited so that the methods in this file are able to perform the comment volumetric calculations for any given number of rounds. Because of the changes discussed in the previous section, we had to update the corresponding Rspec tests to work with the new return format. 
[[File:spec_response.png|1080px|]] 

=== UI Testing ===

Following steps needs to be performed to test the volume refactoring in the UI: 
1. Login as instructor and enter anonymized view using the manage tag. 
2. Go to the manage tab and enter the assignments page 
3. Choose any of the listed assignments, under the action section, click “view reports” 
- If the course comes up with an error that means that the chosen assignment does not have any reviews. Please choose another assignment. 
- A good choice for an assignment would be 'Final Project (and design doc) 
4. Select the view button 
5. You should see the volume of reviews by round for each reviewer. 

== Scope for future improvement ==
1. We found that scores are calculated in many different places and in many different ways throughout the code. An interesting future project would be to identify where these different calculations are made, and refactor so they are all made in one place for the same type of scores. This will make the code more universal and easier to follow and understand.

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-14T13:35:27Z

Mbgaffor: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-14T13:26:51Z

Mbgaffor: /* Solutions Implemented and Delivered */

File:517 screenshot5.png

2020-10-14T13:25:34Z

Mbgaffor:

File:517 screenshot4.png

2020-10-14T13:25:21Z

Mbgaffor:

File:517 screenshot3.png

2020-10-14T13:24:49Z

Mbgaffor:

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-14T13:16:04Z

Mbgaffor: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2020/oss E2072 RLM

2020-10-14T02:07:14Z

Mbgaffor: