Expertiza_Wiki - User contributions [en]

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

2020-11-20T17:28:02Z

Jwbumga2: /* Automated Testing */

== '''Introduction''' ==

E2084 is concerned primarily with the different reports (review report, author feedback report, and teammate review report) 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 
https://youtu.be/uN2lifOT2CY 

=== '''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
* /views/reports/_teammate_review_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]] 
'''4. Row Background Color:'''
* The code implementation was setting the background colors of each row to be different colors depending on whether it was an even or odd row. This should give the table a nice, striped look when displaying data. However, after we included the dynamic JQuery sorting, this messed up the background color as the background color is set initailly when the data is loaded. 
Thus, in author feedback report and teammate review report, we removed the background color code, and included the '''Zebra''' Jquery widget which dynamically stripes the rows even when sorting. 

Previous Implementation: 
[[File:WCAE_2019_Old.png|720px|]] 
Fixed Implementation: 
[[File:WCAE_2019_Fixed.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. These tests are necessary as we modified some model logic, and there was lackluster coverage for this function anyway. We test very basic functionality, and ensures it behaves at the unit level as we expect; that is; return true when the assignment uses a rubric for more than one round. 
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-17T02:42:17Z

Jwbumga2: /* 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 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.

Additional files changed from bugs we discovered

*app/model/assignment.rb
*spec/model/assignment_spec.rb

== '''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 <)
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|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-17T02:15:41Z

Jwbumga2: /* 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.
* 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|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:Fixed view.png

2020-11-17T02:15:09Z

Jwbumga2:

File:Fixedmodel.png

2020-11-17T01:08:10Z

Jwbumga2:

File:-=bug.png

2020-11-17T01:04:53Z

Jwbumga2:

File:To i previous.png

2020-11-17T01:01:47Z

Jwbumga2:

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

2020-11-17T00:16:12Z

Jwbumga2: /* 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:
*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:Fixed author feedback.png

2020-11-17T00:15:04Z

Jwbumga2:

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

2020-11-16T23:51:57Z

Jwbumga2:

== '''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: 
[[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:Fixed implementation1.png

2020-11-16T22:52:06Z

Jwbumga2:

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T03:30:29Z

Jwbumga2:

This page provides a description of the Expertiza based OSS project.

== About Expertiza ==

[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

== About RSpec ==

RSpec is a unit test framework for the Ruby programming language. RSpec is different than traditional xUnit frameworks like JUnit because RSpec is a Behavior driven development tool. What this means is that, tests written in RSpec focus on the "behavior" of an application being tested. RSpec does not put emphasis on, how the application works but instead on how it behaves, in other words, what the application actually does.Each RSpec file contains one or more tests. Each test ensures if a particular feature of our website is working properly.The output of an RSpec run will tell you exactly what features aren't working. The benefit is that tested code is unlikely to break unnoticed.The tests are run every time someone makes, or updates, a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests Pull Request].

== DB Schema ==
Below are the tables that are related ti student task functionality
[http://wiki.expertiza.ncsu.edu/images/7/7a/ExpertizaDbSchema.jpg DB Schema]

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the student_task.rb and student_task_spec.rb. It focuses on writing RSpec unit tests for the code affected or added. The goal of this project is to attempt to add sufficient unit tests to this part of the application and increase its path coverage to above 90 percent.
The following tasks were accomplished in this project:

* Complete the insufficient unit tests for student_task.rb.
* Increase path coverage from only 31.91% with 30 lines covered to above 90% coverage
* Cover edge cases.
* High branch coverage to be achieved.

There are different tasks that a student can perform.
* They can see all the assignments that they have been assigned to.
* They can see details of each assignment like marks, their team, send invitation to student to join a team
* Review other students' work

== Tests Plan ==
*Mock Objects to test
*Topic name
*Complete?
*Incomplete?
*Not started?
*Revision?
*Met reviews given
*Teamed student
*Get due date
*Get peer review data
*Get author feedback
*Get submission data
*Get timeline data

== Implementation ==
describe StudentTask do
# Write your mocked object here!
let(:participant) { build(:participant, id: 1, user_id: user.id, parent_id: assignment.id) }
let(:participant2) { build(:participant, id: 2, user_id: user2.id, parent_id: assignment.id) }
let(:participant3) { build(:participant, id: 3, user_id: user3.id, parent_id: assignment2.id) }
let(:user) { create(:student) }
let(:user2) { create(:student, name: "qwertyui", id: 5) }
let(:user3) { create(:student, name: "qwertyui1234", id: 6) }
let(:course) { build(:course) }
let(:assignment) { build(:assignment, name: 'assignment 1') }
let(:assignment2) { create(:assignment, name: 'assignment 2', is_calibrated: true) }
let(:team) { create(:assignment_team, id: 1, name: 'team 1', parent_id: assignment.id, users: [user, user2]) }
let(:team2) { create(:assignment_team, id: 2, name: 'team 2', parent_id: assignment2.id, users: [user3]) }
let(:team_user) { create(:team_user, id: 3, team_id: team.id, user_id: user.id) }
let(:team_user2) { create(:team_user, id: 4, team_id: team.id, user_id: user2.id) }
let(:team2_user3) { create(:team_user, id: 5, team_id: team2.id, user_id: user3.id) }
let(:course_team) { create(:course_team, id: 3, name: 'course team 1', parent_id: course.id) }
let(:cource_team_user) { create(:team_user, id: 6, team_id: course_team.id, user_id: user.id) }
let(:cource_team_user2) { create(:team_user, id: 7, team_id: course_team.id, user_id: user2.id) }
let(:topic) { build(:topic) }
let(:topic2) { create(:topic, topic_name: "TestReview") }
let(:topic3) { create(:topic) }
let(:due_date) { build(:assignment_due_date, deadline_type_id: 1) }
let(:deadline_type) { build(:deadline_type, id: 1) }
let(:review_response_map) { build(:review_response_map, assignment: assignment, reviewer: participant, reviewee: team2) }
let(:metareview_response_map) { build(:meta_review_response_map, reviewed_object_id: 1) }
let(:response) { build(:response, id: 1, map_id: 1, response_map: review_response_map) }
let(:response2) { build(:response, id: 2, map_id: 1, response_map: review_response_map) }
let(:submission_record) {build(:submission_record, id:1, team_id: 1, assignment_id: 1) }
let(:student_task) do
StudentTask.new(
user: user,
participant: participant,
assignment: assignment,
topic: topic3,
)
end
let(:student_task2) do
StudentTask.new(
user: user,
participant: participant2,
assignment: assignment,
topic: topic2,
)
end

# Tests topic name to ensure it is stored or set as "-"
describe "#topic_name" do
it 'returns the topic name if given one' do
allow(student_task2).to receive(:topic).and_return(topic2)
expect(student_task2.topic_name).to eq("TestReview")
end

it 'returns - for blank name' do
expect(student_task.topic_name).to eq("-")
end
end

# Verifies completion status of a student task
describe "#complete?" do
it 'verifies a student task is complete' do
allow(student_task).to receive(:stage_deadline).and_return('Complete')
expect(student_task.complete?).to be true
end
it 'verifies a nil stage_deadline to not be complete' do
allow(student_task).to receive(:stage_deadline).and_return('')
expect(student_task.complete?).to be false
end
end

# tests if hyperlinks or other content is submitted during the submission stage
# current stage must be submission
# participant has to belong to a team
# the team has submitted some content
describe "content_submitted_in_current_stage?" do
it 'checks if content is submitted during submission stage'do
student_task.current_stage = "submission"
allow(participant).to receive(:team).and_return([team])
allow(participant.team).to receive(:has_submissions?).and_return(true)
expect(student_task.content_submitted_in_current_stage?).to eq(true)
end
end

# Tests the updating of the @hyperlinks instance variable based on participant's team
# Does not verify operation of ||= call, only tests cases of right hand side
describe "#hyperlinks" do
it 'returns empty array if participant has no team' do
allow(student_task).to receive_message_chain(:participant, :team, :nil?).and_return(true)
expect(student_task.hyperlinks).to eq([])
end
it 'assigns returns populated hyperlinks instance if participant has team' do
allow(student_task).to receive_message_chain(:participant, :team, :hyperlinks).and_return(['something'])
allow(student_task).to receive_message_chain(:participant, :team, :nil?).and_return(false)
expect(student_task.hyperlinks).to eq(['something'])
end
end

# Verifies incomplete status of student task
describe "#incomplete?" do
it 'checks a student_task is incomplete' do
expect(student_task.incomplete?).to be true
end
end

# Verifies that a task has not started
describe "#not_started?" do
it 'verfies started status' do
allow(student_task).to receive(:in_work_stage?).and_return(true)
allow(student_task).to receive(:started?).and_return(true)
expect(student_task.not_started?).to eq(false)
end

it 'is not started due to work stage' do
allow(student_task).to receive(:in_work_stage?).and_return(false)
allow(student_task).to receive(:started?).and_return(true)
expect(student_task.not_started?).to eq(false)
end
end

# Tests relative_deadline for proper assignment when stage_deadline is present
describe "#relative_deadline" do
it 'returns false without a valid stage deadline' do
allow(student_task).to receive(:stage_deadline).and_return(nil)
expect(student_task.relative_deadline).to be_falsey
end
it 'verifies a valid case where stage_deadline is present' do
allow(student_task).to receive(:stage_deadline).and_return(true)
allow(student_task).to receive(:time_ago_in_words).and_return("astring")
expect(student_task.relative_deadline).to eq("astring")
end
end

# Examines a task to determine if the task is a revision
describe "#revision?" do
it 'returns true if content is submitted' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(true)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(false)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(false)
expect(student_task.revision?).to eq(true)
end

it 'returns true if reviews given is true' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(false)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(true)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(false)
expect(student_task.revision?).to eq(true)
end

it 'returns true if metareviews given is true' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(false)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(false)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(true)
expect(student_task.revision?).to eq(true)
end
end
# Checks if metareview was given in current task stage
describe "#metreviews_given_in_current_stage?" do
it 'return true' do
student_task.current_stage = "metareview"
allow(student_task).to receive(:metareviews_given?).and_return(true)
expect(student_task.metareviews_given_in_current_stage?).to eq(true)
end
end
# Checks if review was given in current task stage
describe "#reviews_given_in_current_stage?" do
it 'return true' do
student_task.current_stage = "review"
allow(student_task).to receive(:reviews_given?).and_return(true)
expect(student_task.reviews_given_in_current_stage?).to eq(true)
end
end

# tests whether a student task has been started
# if the task is not incomplete && is not in the revision stage
# started? returns false
# if the task is incomplete && is in the revision stage
# started? returns true
describe "#started?" do
it 'is not started' do
allow(student_task).to receive(:incomplete?).and_return(false)
allow(student_task).to receive(:revision?).and_return(false)
expect(student_task.started?).to eq(false)
end

it 'is started' do
allow(student_task).to receive(:incomplete?).and_return(true)
allow(student_task).to receive(:revision?).and_return(true)
expect(student_task.started?).to eq(true)
end
end

# Tests works stage to ensure state is represented correctly
describe "#in_work_stage?" do
it "is true, submission is a work stage" do
allow(student_task).to receive(:current_stage).and_return("submission")
expect(student_task.in_work_stage?).to eq(true)
end
it "is true, review is a work stage" do
allow(student_task).to receive(:current_stage).and_return("review")
expect(student_task.in_work_stage?).to eq(true)
end
it "is true, metareview is a work stage" do
allow(student_task).to receive(:current_stage).and_return("metareview")
expect(student_task.in_work_stage?).to eq(true)
end
it "is false, empty object" do
allow(student_task).to receive(:current_stage).and_return("")
expect(student_task.in_work_stage?).to eq(false)
end
end

# Tests teamed students method which returns the unique students that are paired with the student at some point
# within their course
describe "#teamed_students" do
context 'when not in any team' do
it 'returns empty' do
expect(StudentTask.teamed_students(user3)).to eq({})
end
end
context 'when assigned in a cource_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([course_team])
expect(StudentTask.teamed_students(user)).to eq({})
end
end
context 'when assigned in a assignment_team ' do
it 'returns the students they are teamed with' do
allow(user).to receive(:teams).and_return([team])
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: assignment.id).and_return(participant)
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 5, parent_id: assignment.id).and_return(participant2)
allow(Assignment).to receive(:find_by).with(id: team.parent_id).and_return(assignment)
expect(StudentTask.teamed_students(user)).to eq({assignment.course_id => [user2.fullname]})
end
end
end

# Gets the due dates of an assigment
describe "#get_due_date_data" do
context 'when called with assignment having empty due dates' do
it "return empty time_list array" do
timeline_list = []
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when called with assignment having due date' do
context 'and due_at value nil' do
it "return empty time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
due_date.due_at=nil;
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'and due_at value not nil' do
it "return time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([{
:label=>(due_date.deadline_type.name + ' Deadline').humanize,
:updated_at=>due_date.due_at.strftime('%a, %d %b %Y %H:%M')
}])
end
end
end
end

# Verifies fetching of peer review data of a user and a timeline
describe "#get_peer_review_data" do
context 'when no review response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_peer_review_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to review response map' do
it 'returns timeline array' do
timeline_list=[]
allow(ReviewResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:round).and_return(1)
allow(response).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_peer_review_data(1,timeline_list)).to eq([{:id=>1, :label=>"Round 1 peer review", :updated_at=>timevalue}])
end
end
end

# Verifies retrieval of feedback from author
describe "#get_author_feedback_data" do
context 'when no feedback response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_author_feedback_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to feedback response map' do
it 'returns timeline array' do
timeline_list=[]
allow(FeedbackResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:updated_at).and_return(Time.now)
timevalue = Time.now.strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_author_feedback_data(1,timeline_list)).to eq([{:id=>1, :label=>"Author feedback", :updated_at=>timevalue}])
end
end
end

# Verrifies retrieval of submission data from submission
describe '#get_submission_data' do
context 'when no submission data mapped' do
it 'returns nil' do
timeline_list=[]
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq(nil)
end
end
context 'when submission data mapped and not submit hyperlink or Remove hyperlink' do
it 'returns timeline_list' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('testing_label')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Testing label", :updated_at=>timevalue}])
end
end
context 'when submission data mapped and operation is submit_hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Submit Hyperlink')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Submit hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
context 'when submission data mapped and operation is Remove Hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Remove Hyperlink')
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Remove hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
end

# Verifies retrieval of timeline data
describe '#get_timeline_data' do
context 'when no timeline data mapped' do
it 'returns nil' do
expect(StudentTask.get_timeline_data(assignment, participant, team)).to eq([])
end
end
end
end

== Line Coverage achieved ==
*94 relevant lines
*86 lines covered
*8 lines missed
*Coverage = 91.49%

== Issues ==
Some of the tests were rather shallow, get_timeline_data specifically needs depth added.

== Video of Tests running ==
[https://youtu.be/N6H1HtQ4eds]

== Pull Request ==
[https://github.com/expertiza/expertiza/pull/1810]

== Team Members ==
John Bumgardner, Pedro Benitez, Luke McConnaughey

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T03:23:23Z

Jwbumga2:

This page provides a description of the Expertiza based OSS project.

== About Expertiza ==

[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

== About RSpec ==

RSpec is a unit test framework for the Ruby programming language. RSpec is different than traditional xUnit frameworks like JUnit because RSpec is a Behavior driven development tool. What this means is that, tests written in RSpec focus on the "behavior" of an application being tested. RSpec does not put emphasis on, how the application works but instead on how it behaves, in other words, what the application actually does.Each RSpec file contains one or more tests. Each test ensures if a particular feature of our website is working properly.The output of an RSpec run will tell you exactly what features aren't working. The benefit is that tested code is unlikely to break unnoticed.The tests are run every time someone makes, or updates, a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests Pull Request].

== DB Schema ==
Below are the tables that are related ti student task functionality
[http://wiki.expertiza.ncsu.edu/images/7/7a/ExpertizaDbSchema.jpg DB Schema]

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the student_task.rb and student_task_spec.rb. It focuses on writing RSpec unit tests for the code affected or added. The goal of this project is to attempt to add sufficient unit tests to this part of the application and increase its path coverage to above 90 percent.
The following tasks were accomplished in this project:

* Complete the insufficient unit tests for student_task.rb.
* Increase path coverage from only 31.91% with 30 lines covered to above 90% coverage
* Cover edge cases.
* High branch coverage to be achieved.

There are different tasks that a student can perform.
* They can see all the assignments that they have been assigned to.
* They can see details of each assignment like marks, their team, send invitation to student to join a team
* Review other students' work

== Tests Plan ==
*Mock Objects to test
*Topic name
*Complete?
*Incomplete?
*Not started?
*Revision?
*Met reviews given
*Teamed student
*Get due date
*Get peer review data
*Get author feedback
*Get submission data
*Get timeline data

== Implementation ==
describe StudentTask do
# Write your mocked object here!
let(:participant) { build(:participant, id: 1, user_id: user.id, parent_id: assignment.id) }
let(:participant2) { build(:participant, id: 2, user_id: user2.id, parent_id: assignment.id) }
let(:participant3) { build(:participant, id: 3, user_id: user3.id, parent_id: assignment2.id) }
let(:user) { create(:student) }
let(:user2) { create(:student, name: "qwertyui", id: 5) }
let(:user3) { create(:student, name: "qwertyui1234", id: 6) }
let(:course) { build(:course) }
let(:assignment) { build(:assignment, name: 'assignment 1') }
let(:assignment2) { create(:assignment, name: 'assignment 2', is_calibrated: true) }
let(:team) { create(:assignment_team, id: 1, name: 'team 1', parent_id: assignment.id, users: [user, user2]) }
let(:team2) { create(:assignment_team, id: 2, name: 'team 2', parent_id: assignment2.id, users: [user3]) }
let(:team_user) { create(:team_user, id: 3, team_id: team.id, user_id: user.id) }
let(:team_user2) { create(:team_user, id: 4, team_id: team.id, user_id: user2.id) }
let(:team2_user3) { create(:team_user, id: 5, team_id: team2.id, user_id: user3.id) }
let(:course_team) { create(:course_team, id: 3, name: 'course team 1', parent_id: course.id) }
let(:cource_team_user) { create(:team_user, id: 6, team_id: course_team.id, user_id: user.id) }
let(:cource_team_user2) { create(:team_user, id: 7, team_id: course_team.id, user_id: user2.id) }
let(:topic) { build(:topic) }
let(:topic2) { create(:topic, topic_name: "TestReview") }
let(:topic3) { create(:topic) }
let(:due_date) { build(:assignment_due_date, deadline_type_id: 1) }
let(:deadline_type) { build(:deadline_type, id: 1) }
let(:review_response_map) { build(:review_response_map, assignment: assignment, reviewer: participant, reviewee: team2) }
let(:metareview_response_map) { build(:meta_review_response_map, reviewed_object_id: 1) }
let(:response) { build(:response, id: 1, map_id: 1, response_map: review_response_map) }
let(:response2) { build(:response, id: 2, map_id: 1, response_map: review_response_map) }
let(:submission_record) {build(:submission_record, id:1, team_id: 1, assignment_id: 1) }
let(:student_task) do
StudentTask.new(
user: user,
participant: participant,
assignment: assignment,
topic: topic3,
)
end
let(:student_task2) do
StudentTask.new(
user: user,
participant: participant2,
assignment: assignment,
topic: topic2,
)
end

# Tests topic name to ensure it is stored or set as "-"
describe "#topic_name" do
it 'returns the topic name if given one' do
allow(student_task2).to receive(:topic).and_return(topic2)
expect(student_task2.topic_name).to eq("TestReview")
end

it 'returns - for blank name' do
expect(student_task.topic_name).to eq("-")
end
end

# Verifies completion status of a student task
describe "#complete?" do
it 'verifies a student task is complete' do
allow(student_task).to receive(:stage_deadline).and_return('Complete')
expect(student_task.complete?).to be true
end
it 'verifies a nil stage_deadline to not be complete' do
allow(student_task).to receive(:stage_deadline).and_return('')
expect(student_task.complete?).to be false
end
end

# tests if hyperlinks or other content is submitted during the submission stage
# current stage must be submission
# participant has to belong to a team
# the team has submitted some content
describe "content_submitted_in_current_stage?" do
it 'checks if content is submitted during submission stage'do
student_task.current_stage = "submission"
allow(participant).to receive(:team).and_return([team])
allow(participant.team).to receive(:has_submissions?).and_return(true)
expect(student_task.content_submitted_in_current_stage?).to eq(true)
end
end

# Tests the updating of the @hyperlinks instance variable based on participant's team
# Does not verify operation of ||= call, only tests cases of right hand side
describe "#hyperlinks" do
it 'returns empty array if participant has no team' do
allow(student_task).to receive_message_chain(:participant, :team, :nil?).and_return(true)
expect(student_task.hyperlinks).to eq([])
end
it 'assigns returns populated hyperlinks instance if participant has team' do
allow(student_task).to receive_message_chain(:participant, :team, :hyperlinks).and_return(['something'])
allow(student_task).to receive_message_chain(:participant, :team, :nil?).and_return(false)
expect(student_task.hyperlinks).to eq(['something'])
end
end

# Verifies incomplete status of student task
describe "#incomplete?" do
it 'checks a student_task is incomplete' do
expect(student_task.incomplete?).to be true
end
end

# Verifies that a task has not started
describe "#not_started?" do
it 'verfies started status' do
allow(student_task).to receive(:in_work_stage?).and_return(true)
allow(student_task).to receive(:started?).and_return(true)
expect(student_task.not_started?).to eq(false)
end

it 'is not started due to work stage' do
allow(student_task).to receive(:in_work_stage?).and_return(false)
allow(student_task).to receive(:started?).and_return(true)
expect(student_task.not_started?).to eq(false)
end
end

# Tests relative_deadline for proper assignment when stage_deadline is present
describe "#relative_deadline" do
it 'returns false without a valid stage deadline' do
allow(student_task).to receive(:stage_deadline).and_return(nil)
expect(student_task.relative_deadline).to be_falsey
end
it 'verifies a valid case where stage_deadline is present' do
allow(student_task).to receive(:stage_deadline).and_return(true)
allow(student_task).to receive(:time_ago_in_words).and_return("astring")
expect(student_task.relative_deadline).to eq("astring")
end
end

# Examines a task to determine if the task is a revision
describe "#revision?" do
it 'returns true if content is submitted' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(true)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(false)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(false)
expect(student_task.revision?).to eq(true)
end

it 'returns true if reviews given is true' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(false)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(true)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(false)
expect(student_task.revision?).to eq(true)
end

it 'returns true if metareviews given is true' do
allow(student_task).to receive(:content_submitted_in_current_stage?).and_return(false)
allow(student_task).to receive(:reviews_given_in_current_stage?).and_return(false)
allow(student_task).to receive(:metareviews_given_in_current_stage?).and_return(true)
expect(student_task.revision?).to eq(true)
end
end
# Checks if metareview was given in current task stage
describe "#metreviews_given_in_current_stage?" do
it 'return true' do
student_task.current_stage = "metareview"
allow(student_task).to receive(:metareviews_given?).and_return(true)
expect(student_task.metareviews_given_in_current_stage?).to eq(true)
end
end
# Checks if review was given in current task stage
describe "#reviews_given_in_current_stage?" do
it 'return true' do
student_task.current_stage = "review"
allow(student_task).to receive(:reviews_given?).and_return(true)
expect(student_task.reviews_given_in_current_stage?).to eq(true)
end
end

# tests whether a student task has been started
# if the task is not incomplete && is not in the revision stage
# started? returns false
# if the task is incomplete && is in the revision stage
# started? returns true
describe "#started?" do
it 'is not started' do
allow(student_task).to receive(:incomplete?).and_return(false)
allow(student_task).to receive(:revision?).and_return(false)
expect(student_task.started?).to eq(false)
end

it 'is started' do
allow(student_task).to receive(:incomplete?).and_return(true)
allow(student_task).to receive(:revision?).and_return(true)
expect(student_task.started?).to eq(true)
end
end

# Tests works stage to ensure state is represented correctly
describe "#in_work_stage?" do
it "is true, submission is a work stage" do
allow(student_task).to receive(:current_stage).and_return("submission")
expect(student_task.in_work_stage?).to eq(true)
end
it "is true, review is a work stage" do
allow(student_task).to receive(:current_stage).and_return("review")
expect(student_task.in_work_stage?).to eq(true)
end
it "is true, metareview is a work stage" do
allow(student_task).to receive(:current_stage).and_return("metareview")
expect(student_task.in_work_stage?).to eq(true)
end
it "is false, empty object" do
allow(student_task).to receive(:current_stage).and_return("")
expect(student_task.in_work_stage?).to eq(false)
end
end

# Tests teamed students method which returns the unique students that are paired with the student at some point
# within their course
describe "#teamed_students" do
context 'when not in any team' do
it 'returns empty' do
expect(StudentTask.teamed_students(user3)).to eq({})
end
end
context 'when assigned in a cource_team ' do
it 'returns empty' do
allow(user).to receive(:teams).and_return([course_team])
expect(StudentTask.teamed_students(user)).to eq({})
end
end
context 'when assigned in a assignment_team ' do
it 'returns the students they are teamed with' do
allow(user).to receive(:teams).and_return([team])
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 1, parent_id: assignment.id).and_return(participant)
allow(AssignmentParticipant).to receive(:find_by).with(user_id: 5, parent_id: assignment.id).and_return(participant2)
allow(Assignment).to receive(:find_by).with(id: team.parent_id).and_return(assignment)
expect(StudentTask.teamed_students(user)).to eq({assignment.course_id => [user2.fullname]})
end
end
end

# Gets the due dates of an assigment
describe "#get_due_date_data" do
context 'when called with assignment having empty due dates' do
it "return empty time_list array" do
timeline_list = []
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when called with assignment having due date' do
context 'and due_at value nil' do
it "return empty time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
due_date.due_at=nil;
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([])
end
end
context 'and due_at value not nil' do
it "return time_list array" do
allow(due_date).to receive(:deadline_type).and_return(deadline_type)
timeline_list = []
assignment.due_dates = [due_date]
StudentTask.get_due_date_data(assignment, timeline_list)
expect(timeline_list).to eq([{
:label=>(due_date.deadline_type.name + ' Deadline').humanize,
:updated_at=>due_date.due_at.strftime('%a, %d %b %Y %H:%M')
}])
end
end
end
end

# Verifies fetching of peer review data of a user and a timeline
describe "#get_peer_review_data" do
context 'when no review response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_peer_review_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to review response map' do
it 'returns timeline array' do
timeline_list=[]
allow(ReviewResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:round).and_return(1)
allow(response).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_peer_review_data(1,timeline_list)).to eq([{:id=>1, :label=>"Round 1 peer review", :updated_at=>timevalue}])
end
end
end

# Verifies retrieval of feedback from author
describe "#get_author_feedback_data" do
context 'when no feedback response mapped' do
it 'returns empty' do
timeline_list=[]
StudentTask.get_author_feedback_data(user2,timeline_list)
expect(timeline_list).to eq([])
end
end
context 'when mapped to feedback response map' do
it 'returns timeline array' do
timeline_list=[]
allow(FeedbackResponseMap).to receive_message_chain(:where, :find_each).with(reviewer_id: 1).with(no_args).and_yield(review_response_map)
allow(review_response_map).to receive(:id).and_return(1)
allow(Response).to receive_message_chain(:where, :last).with(map_id: 1).with(no_args).and_return(response)
allow(response).to receive(:updated_at).and_return(Time.now)
timevalue = Time.now.strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_author_feedback_data(1,timeline_list)).to eq([{:id=>1, :label=>"Author feedback", :updated_at=>timevalue}])
end
end
end

# Verrifies retrieval of submission data from submission
describe '#get_submission_data' do
context 'when no submission data mapped' do
it 'returns nil' do
timeline_list=[]
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq(nil)
end
end
context 'when submission data mapped and not submit hyperlink or Remove hyperlink' do
it 'returns timeline_list' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('testing_label')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Testing label", :updated_at=>timevalue}])
end
end
context 'when submission data mapped and operation is submit_hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Submit Hyperlink')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Submit hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
context 'when submission data mapped and operation is Remove Hyperlink' do
it 'returns timeline_list with link' do
timeline_list=[]
allow(SubmissionRecord).to receive_message_chain(:where, :find_each).with(team_id: 1, assignment_id: 1).with(no_args).and_yield(submission_record)
allow(submission_record).to receive(:operation).and_return('Remove Hyperlink')
timevalue = Time.new(2019).strftime('%a, %d %b %Y %H:%M')
allow(submission_record).to receive(:updated_at).and_return(Time.new(2019))
expect(StudentTask.get_submission_data(1,1,timeline_list)).to eq([{:label=>"Remove hyperlink", :updated_at=>timevalue, :link=>"www.wolfware.edu"}])
end
end
end

# Verifies retrieval of timeline data
describe '#get_timeline_data' do
context 'when no timeline data mapped' do
it 'returns nil' do
expect(StudentTask.get_timeline_data(assignment, participant, team)).to eq([])
end
end
end
end

== Line Coverage achieved ==
*94 relevant lines
*86 lines covered
*8 lines missed
*Coverage = 91.49%

== Issues ==
Some of the tests were rather shallow, get_timeline_data specifically needs depth added.

== Video of Tests running ==
[https://youtu.be/N6H1HtQ4eds]

== Team Members ==
John Bumgardner, Pedro Benitez, Luke McConnaughey

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T01:17:02Z

Jwbumga2:

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T01:00:31Z

Jwbumga2:

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T00:58:56Z

Jwbumga2: /* Tests Written */

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-20T00:57:17Z

Jwbumga2:

CSC/ECE 517 Fall 2020 - E2055 write unit tests for student task.rb

2020-10-13T01:12:08Z

Jwbumga2: Created page with "This page provides a description of the Expertiza based OSS project. == About Expertiza == [https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https..."