Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T02:15:57Z

Zwang236: /* Relevant Links */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

[[File:Grade_controller.png|800px]]

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

[[File:Rmapping_controller.png|800px]]

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

[https://youtu.be/uQtvkIba3DY/ Screencast]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T02:15:35Z

Zwang236: /* Relevant Links */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T01:25:52Z

Zwang236: /* Testing Plan */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T01:25:40Z

Zwang236: /* Files Modified */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

[[File:Grade_controller.png|800px]]

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T01:25:28Z

Zwang236: /* Testing Plan */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

[[File:Grade_controller.png|800px]]

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''
[[File:Rmapping_controller.png|800px]]

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T01:25:17Z

Zwang236: /* Files Modified */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''
[[File:Rmapping_controller.png|800px]]

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T01:24:40Z

Zwang236: /* Files Modified */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''
[[File:Grade_controller.png|800px]]

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''
[[File:Rmapping_controller.png|800px]]

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

File:Rmapping controller.png

2022-12-05T01:23:07Z

Zwang236:

File:Grade controller.png

2022-12-05T01:22:37Z

Zwang236:

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:51:10Z

Zwang236: /* Grade History */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Submission Page With Grade History Option ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:50:24Z

Zwang236: /* grade history */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== Grade History ====
[[File:Audit_Trail_1.png|800px]]

==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:50:11Z

Zwang236: /* report */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== grade history ====
[[File:Audit_Trail_1.png|800px]]
==== Summary Report ====
[[File:Audit_Trail_2.png|800px]]

==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:49:52Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

==== grade history ====
[[File:Audit_Trail_1.png|800px]]
==== report ====
[[File:Audit_Trail_2.png|800px]]
==== Grade history ====
[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:48:30Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===
'''grade history'''
[[File:Audit_Trail_1.png|800px]]

[[File:Audit_Trail_2.png|800px]]

[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:48:01Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

[[File:Audit_Trail_1.png|800px]]

[[File:Audit_Trail_2.png|800px]]

[[File:Audit_Trail_3.png|800px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:47:44Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

[[File:Audit_Trail_1.png|500px]]

[[File:Audit_Trail_2.png|500px]]

[[File:Audit_Trail_3.png|500px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:47:05Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

[[File:Audit_Trail_1.png]]

[[File:Audit_Trail_2.png]]

[[File:Audit_Trail_3.png]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:46:37Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

[[Audit_Trail_1.png]]

[[Audit_Trail_2.png]]
[[Audit_Trail_3.png]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-05T00:45:15Z

Zwang236: /* Expected View */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

[[Audit_Trail_1.png|500px]]

[[Audit_Trail_2.png|500px]]
[[Audit_Trail_3.png|500px]]

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

File:Audit Trail 3.png

2022-12-05T00:43:37Z

Zwang236:

File:Audit Trail 2.png

2022-12-05T00:43:11Z

Zwang236:

File:Audit Trail 1.png

2022-12-05T00:42:42Z

Zwang236:

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:43:28Z

Zwang236: /* Files Added */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:42:40Z

Zwang236:

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

*spec/features/grade_histories_spec.rb

'''
Feature test to check if the grades appear in chronological order
'''

*spec/features/helpers/grade_histories_helper.rb

'''
Helper file to facilitate the above mentioned feature test.
'''

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:41:52Z

Zwang236: /* Files Modified */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:41:37Z

Zwang236:

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

Not Assigned

== Problem Description ==
A grading audit trail must be created and the following information needs to be stored:

*When an instructor assigns a grade, there needs to be an indication of who did it and when it was done.
*Comments previously provided by other instructors must also be preserved.

This information must be stored every time an instructor edits a grade/comment and clicks the save button.

The grading audit trail can probably pattern off the submission records history (shown below) on expertiza.

The below page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

== Prior Work ==
The team created a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

They used the MVC design to create a model, a controller, and a view for both '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes containing instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

They also modified the grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

https://www.youtube.com/watch?v=yyxX_kRYxLc

== General Design Plan ==
Preliminary: The previous iterations of the project fulfilled all the functional requirements of the "grading audit trail" feature, but it is four years old and the pull requests never merged. Thus, the changes are outdated and cause build issues with the latest Expertiza.

1. Cherry pick and manually fixup the changes from previous iterations to fix build issues.

2. Cleanup GUI so it meshes cleanly with latest Expertiza.

3. Add comments and test cases.

=== Expected View ===

== Flow Chart ==

[[File:flow_Diagram.png|500px]]

== Testing Plan ==

Functional testing:

1. Test SubmissionGradeHistory.create: call a submission grade when changed.
spec/controllers/grades_controller_spec.rb

2. Test ReviewGradeHistory.create: call a submission grade when changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test GradeHistory.where: called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

Feature Testing:

1. Test the grading history: visible and shown in chronological order?
spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

== Files Modified ==
==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record

== Relevant Links ==
[https://github.com/expertiza/expertiza/pull/1441/ Github 1934]

[https://github.com/expertiza/expertiza/pull/2407/ Github 2237]

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:37:51Z

Zwang236: /* Relevant Links */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:37:31Z

Zwang236: /* Relevant Links */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:35:39Z

Zwang236:

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:30:26Z

Zwang236: /* General Design Plan */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:28:45Z

Zwang236: /* Flow Chart */

CSC/ECE 517 Fall 2022 - E2285. Grading audit trail

2022-12-04T23:28:32Z

Zwang236:

File:Flow Diagram.png

2022-12-04T23:26:42Z

Zwang236:

CSC/ECE 517 Fall 2022

2022-11-15T16:32:31Z

Zwang236:

== OSS Projects ==

* [[CSC/ECE 517 Fall 2022 - E2250. Refactor suggestion controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2252. Refactor auth controller.rb & password retrieval controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2253.Refactor delayed mailer.rb and scheduled task.rb]]
* [[CSC/ECE 517 Fall 2022 - E2254: Refactor teams_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2255. Refactor student_quizzes_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2256: Refactor late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2257: Refactor questionnaires_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2258. Refactor submitted_content_controller]]
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]
* [[CSC/ECE 517 Fall 2022 - E2260. Refactor review_mapping_controller]]
* [[CSC/ECE 517 Fall 2022 - E2255. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2022 - E2262: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2022 - E2263.Refactor student teams functionality]]

== Final Projects ==
* [[CSC/ECE 517 Fall 2022 - E2275. Further refactoring and improvement of student_quizzes controller]]
* [[CSC/ECE 517 Fall 2022 - E2276. Fix "Back" link on “New Late Policy” page]]
* [[CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller]]
* [[CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments]]
* [[CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup_sheet controller]]
* [[CSC/ECE 517 Fall 2022 - E2285. Grading audit trail]]

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:25:30Z

Zwang236: /* Mentor */

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:24:52Z

Zwang236: /* Team Member */

== Team Introduction ==

=== Team Member ===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

=== Mentor ===

== Problem Description ==

== Prior Work ==

== General Design Plan ==

== Relevant Links ==

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:22:09Z

Zwang236: /* Team Member */

== Team Introduction ==

=== Team Member ===

=== Mentor ===

== Problem Description ==

== Prior Work ==

== General Design Plan ==

== Relevant Links ==

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:21:13Z

Zwang236: /* Team Member */

== Team Introduction ==

=== Team Member ===

111

=== Mentor ===

== Problem Description ==

== Prior Work ==

== General Design Plan ==

== Relevant Links ==

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:20:38Z

Zwang236:

== Team Introduction ==

=== Team Member ===

=== Mentor ===

== Problem Description ==

== Prior Work ==

== General Design Plan ==

== Relevant Links ==

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:16:10Z

Zwang236: /* Introduction */

== Team Introduction ==

=== Team Member ===

=== Mentor ===

== Problem Description ==

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:13:29Z

Zwang236: /* Introduction */

== Introduction ==

=== Problem Description===

=== Team Member ===

=== Mentor ===

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:13:04Z

Zwang236: /* Introduction */

== Introduction ==
=== Problem Description===

=== Mentor ===

=== Team Member ===

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:12:29Z

Zwang236: /* Introduction */

== Introduction ==

=== Team ===

=== Mentor ===

=== Team Member ===

CSC/ECE 517 Fall 2022 - E2279. Grading audit trail

2022-11-15T03:10:31Z

Zwang236: Created page with "== Introduction =="

== Introduction ==

CSC/ECE 517 Fall 2022

2022-11-15T03:06:38Z

Zwang236: /* Final Projects */

CSC/ECE 517 Fall 2022 - E2255. Refactor review mapping helper.rb

2022-10-27T01:00:46Z

Zwang236: /* RSPEC Testing */

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://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 of Expertise to work on various projects and assignments. Students can also peer review other students' submissions. Expertise supports submission across various document types, including URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
* Write test cases of any new code written. Test the existing functionality after refactoring

===Problems and Solutions===
====Problem 1====
* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
::'''Example:'''
[[File:codec_1.png|900px]]
[[File:codec.png]]
====Problem 2====
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
::'''Example One:''' Cyclomatic complexity Error, check_submission_state has Cyclomatic complexity 10 Maximum 5
<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

::'''Solution''': The problem is caused by nesting loops so we break it up

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
return
end

link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # Can be extended for github links in future
color.push 'green'
return
end

link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
</pre>

::'''Example Two:''' Inconsistent Capitalization on comments

<pre>
# loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Solution''': Since many comments have inconsistent capitalization, our group went over the code line by line and manually fixed all inconsistent capitalizations.

<pre>
# Loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Example Three:''' Inconsistent Spacing

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)
if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end
!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Solution''': Many functions within the file are clustered like the example above, we have to go through the code line by line and add spacing before lines to make the code more readable

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])

submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)

if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end

!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Example Four:''' Add comments for some functions.

<pre>
#
# for calibration report
#
def get_css_style_for_calibration_report(diff)

dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

::'''Solution''': many of the functions inside the code have an inconsistent format and lack comments, our team went through the code line by line to edit and add comments.

<pre>
# Gets CSS style for calibration report
def get_css_style_for_calibration_report(diff)
# Diff - the difference between stu's answer and instructor's answer
dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

====Problem 3====
* Write test cases of any new code written. Test the existing functionality after refactoring
:Note: Due to the majority of the code already being refactored, Thus our team did not make any major changes to the review_mapping_helper.rb file. We did however use RSPEC to test all existing functions.

<pre>
$ rspec spec/helpers/review_mapping_helper_spec.rb
$ rspec spec/features/review_mapping_helper_spec.rb
</pre>

===Work Flow Diagram===
[[File:codec_2.png|300px]]

===Travis-CI===
[[File:codec_6.png|500px]]

[[File:codec_7.png|500px]]

===RSPEC Testing===

:'''NOTE:''' there are existing errors already inside the code before we started refactoring. And after refactoring, Our changes did not regress any functionality. Since our responsibility is only refactoring the code and not fixing the functionalities, the RSPEC Testing result showed that we have done our due diligence.

: Result RSPEC testing Before Refactoring
: Command Used:
: '''rspec spec/helpers/review_mapping_helper_spec.rb'''
: result:
: 61 examples, 0 failures - spec
[[File:codec_3.png|500px]]
: Command Used:
: '''rspec spec/features/review_mapping_helper_spec.rb'''
: 21 examples, 20 failures - features
[[File:codec_4.png|500px]]

[[File:codec_5.png|500px]]

: Result Rspec testing After Refactoring:
: Our change did not regress any functionality

===Admin Account Information===
Username: instructor6

Password: password

===Project Mentor===

Edward Gehringer (efg@ncsu.edu)

Jialin Cui (jcui9@ncsu.edu)

===Team Member===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

===Reference===
#[http://152.7.177.159:8080/ VCL link]
#[https://github.com/b4443/expertiza Github Repo]
#[https://github.com/expertiza/expertiza/pull/2470 Github Pull Request]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vyasrc/expertiza/tree/refactor_suggestion_controller GitHub Project Repository Fork]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Project Documentation Wiki]
#[https://docs.codeclimate.com/docs/cognitive-complexity CodeClimate Documentation]

CSC/ECE 517 Fall 2022 - E2255. Refactor review mapping helper.rb

2022-10-27T00:58:49Z

Zwang236: /* Reference */

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://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 of Expertise to work on various projects and assignments. Students can also peer review other students' submissions. Expertise supports submission across various document types, including URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
* Write test cases of any new code written. Test the existing functionality after refactoring

===Problems and Solutions===
====Problem 1====
* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
::'''Example:'''
[[File:codec_1.png|900px]]
[[File:codec.png]]
====Problem 2====
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
::'''Example One:''' Cyclomatic complexity Error, check_submission_state has Cyclomatic complexity 10 Maximum 5
<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

::'''Solution''': The problem is caused by nesting loops so we break it up

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
return
end

link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # Can be extended for github links in future
color.push 'green'
return
end

link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
</pre>

::'''Example Two:''' Inconsistent Capitalization on comments

<pre>
# loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Solution''': Since many comments have inconsistent capitalization, our group went over the code line by line and manually fixed all inconsistent capitalizations.

<pre>
# Loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Example Three:''' Inconsistent Spacing

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)
if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end
!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Solution''': Many functions within the file are clustered like the example above, we have to go through the code line by line and add spacing before lines to make the code more readable

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])

submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)

if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end

!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Example Four:''' Add comments for some functions.

<pre>
#
# for calibration report
#
def get_css_style_for_calibration_report(diff)

dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

::'''Solution''': many of the functions inside the code have an inconsistent format and lack comments, our team went through the code line by line to edit and add comments.

<pre>
# Gets CSS style for calibration report
def get_css_style_for_calibration_report(diff)
# Diff - the difference between stu's answer and instructor's answer
dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

====Problem 3====
* Write test cases of any new code written. Test the existing functionality after refactoring
:Note: Due to the majority of the code already being refactored, Thus our team did not make any major changes to the review_mapping_helper.rb file. We did however use RSPEC to test all existing functions.

<pre>
$ rspec spec/helpers/review_mapping_helper_spec.rb
$ rspec spec/features/review_mapping_helper_spec.rb
</pre>

===Work Flow Diagram===
[[File:codec_2.png|300px]]

===Travis-CI===
[[File:codec_6.png|500px]]

[[File:codec_7.png|500px]]

===RSPEC Testing===

:'''NOTE:''' there are existing errors already inside the code before we started refactoring. And after refactoring, Our changes did not regress any functionality. Since our responsibility is only refactoring the code and not fixing the functionalities, the RSPEC Testing result showed that we have done our due diligence.

: Result RSPEC testing Before Refactoring
: Command Used:
: '''rspec spec/helpers/review_mapping_helper_spec.rb'''
: result:
: 61 examples, 0 failures - spec
[[File:codec_3.png|500px]]
: Command Used:
: '''rspec spec/features/review_mapping_helper_spec.rb'''
: 21 examples, 20 failures - features
[[File:codec_4.png|500px]]

[[File:codec_5.png|500px]]

: Result Rspec testing After Refactoring:
: Our change did not regress any functionality

===Project Mentor===

Edward Gehringer (efg@ncsu.edu)

Jialin Cui (jcui9@ncsu.edu)

===Team Member===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

===Reference===
#[http://152.7.177.159:8080/ VCL link]
#[https://github.com/b4443/expertiza Github Repo]
#[https://github.com/expertiza/expertiza/pull/2470 Github Pull Request]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vyasrc/expertiza/tree/refactor_suggestion_controller GitHub Project Repository Fork]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Project Documentation Wiki]
#[https://docs.codeclimate.com/docs/cognitive-complexity CodeClimate Documentation]

CSC/ECE 517 Fall 2022 - E2255. Refactor review mapping helper.rb

2022-10-26T16:05:46Z

Zwang236: /* RSPEC Testing */

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://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 of Expertise to work on various projects and assignments. Students can also peer review other students' submissions. Expertise supports submission across various document types, including URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
* Write test cases of any new code written. Test the existing functionality after refactoring

===Problems and Solutions===
====Problem 1====
* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
::'''Example:'''
[[File:codec_1.png|900px]]
[[File:codec.png]]
====Problem 2====
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
::'''Example One:''' Cyclomatic complexity Error, check_submission_state has Cyclomatic complexity 10 Maximum 5
<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

::'''Solution''': The problem is caused by nesting loops so we break it up

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
return
end

link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # Can be extended for github links in future
color.push 'green'
return
end

link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
</pre>

::'''Example Two:''' Inconsistent Capitalization on comments

<pre>
# loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Solution''': Since many comments have inconsistent capitalization, our group went over the code line by line and manually fixed all inconsistent capitalizations.

<pre>
# Loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Example Three:''' Inconsistent Spacing

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)
if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end
!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Solution''': Many functions within the file are clustered like the example above, we have to go through the code line by line and add spacing before lines to make the code more readable

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])

submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)

if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end

!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Example Four:''' Add comments for some functions.

<pre>
#
# for calibration report
#
def get_css_style_for_calibration_report(diff)

dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

::'''Solution''': many of the functions inside the code have an inconsistent format and lack comments, our team went through the code line by line to edit and add comments.

<pre>
# Gets CSS style for calibration report
def get_css_style_for_calibration_report(diff)
# Diff - the difference between stu's answer and instructor's answer
dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

====Problem 3====
* Write test cases of any new code written. Test the existing functionality after refactoring
:Note: Due to the majority of the code already being refactored, Thus our team did not make any major changes to the review_mapping_helper.rb file. We did however use RSPEC to test all existing functions.

<pre>
$ rspec spec/helpers/review_mapping_helper_spec.rb
$ rspec spec/features/review_mapping_helper_spec.rb
</pre>

===Work Flow Diagram===
[[File:codec_2.png|300px]]

===Travis-CI===
[[File:codec_6.png|500px]]

[[File:codec_7.png|500px]]

===RSPEC Testing===

:'''NOTE:''' there are existing errors already inside the code before we started refactoring. And after refactoring, Our changes did not regress any functionality. Since our responsibility is only refactoring the code and not fixing the functionalities, the RSPEC Testing result showed that we have done our due diligence.

: Result RSPEC testing Before Refactoring
: Command Used:
: '''rspec spec/helpers/review_mapping_helper_spec.rb'''
: result:
: 61 examples, 0 failures - spec
[[File:codec_3.png|500px]]
: Command Used:
: '''rspec spec/features/review_mapping_helper_spec.rb'''
: 21 examples, 20 failures - features
[[File:codec_4.png|500px]]

[[File:codec_5.png|500px]]

: Result Rspec testing After Refactoring:
: Our change did not regress any functionality

===Project Mentor===

Edward Gehringer (efg@ncsu.edu)

Jialin Cui (jcui9@ncsu.edu)

===Team Member===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

===Reference===
#[http://152.7.177.127:3000/ VCL link]
#[https://github.com/b4443/expertiza Github Repo]
#[https://github.com/expertiza/expertiza/pull/2470 Github Pull Request]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vyasrc/expertiza/tree/refactor_suggestion_controller GitHub Project Repository Fork]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Project Documentation Wiki]
#[https://docs.codeclimate.com/docs/cognitive-complexity CodeClimate Documentation]

CSC/ECE 517 Fall 2022 - E2255. Refactor review mapping helper.rb

2022-10-26T16:05:07Z

Zwang236: /* RSPEC Testing */

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://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 of Expertise to work on various projects and assignments. Students can also peer review other students' submissions. Expertise supports submission across various document types, including URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
* Write test cases of any new code written. Test the existing functionality after refactoring

===Problems and Solutions===
====Problem 1====
* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
::'''Example:'''
[[File:codec_1.png|900px]]
[[File:codec.png]]
====Problem 2====
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
::'''Example One:''' Cyclomatic complexity Error, check_submission_state has Cyclomatic complexity 10 Maximum 5
<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

::'''Solution''': The problem is caused by nesting loops so we break it up

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
return
end

link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # Can be extended for github links in future
color.push 'green'
return
end

link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
</pre>

::'''Example Two:''' Inconsistent Capitalization on comments

<pre>
# loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Solution''': Since many comments have inconsistent capitalization, our group went over the code line by line and manually fixed all inconsistent capitalizations.

<pre>
# Loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Example Three:''' Inconsistent Spacing

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)
if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end
!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Solution''': Many functions within the file are clustered like the example above, we have to go through the code line by line and add spacing before lines to make the code more readable

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])

submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)

if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end

!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Example Four:''' Add comments for some functions.

<pre>
#
# for calibration report
#
def get_css_style_for_calibration_report(diff)

dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

::'''Solution''': many of the functions inside the code have an inconsistent format and lack comments, our team went through the code line by line to edit and add comments.

<pre>
# Gets CSS style for calibration report
def get_css_style_for_calibration_report(diff)
# Diff - the difference between stu's answer and instructor's answer
dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

====Problem 3====
* Write test cases of any new code written. Test the existing functionality after refactoring
:Note: Due to the majority of the code already being refactored, Thus our team did not make any major changes to the review_mapping_helper.rb file. We did however use RSPEC to test all existing functions.

<pre>
$ rspec spec/helpers/review_mapping_helper_spec.rb
$ rspec spec/features/review_mapping_helper_spec.rb
</pre>

===Work Flow Diagram===
[[File:codec_2.png|300px]]

===Travis-CI===
[[File:codec_6.png|500px]]

[[File:codec_7.png|500px]]

===RSPEC Testing===

:'''NOTE:''' there are existing errors already inside the code before we started refactoring. And after refactoring, Our changes did not regress any functionality. Since our responsibility is only refactoring the code and not fixing the functionalities, the RSPEC Testing result showed that we have done our due diligence.

: Result RSPEC testing Before Refactoring
: Command Used:
:: '''rspec spec/helpers/review_mapping_helper_spec.rb'''
:: result
:: 61 examples, 0 failures - spec
[[File:codec_3.png|500px]]
: Command Used:
:: '''rspec spec/features/review_mapping_helper_spec.rb'''
:: 21 examples, 20 failures - features
[[File:codec_4.png|500px]]

[[File:codec_5.png|500px]]

: Result Rspec testing After Refactoring:
: Our change did not regress any functionality

===Project Mentor===

Edward Gehringer (efg@ncsu.edu)

Jialin Cui (jcui9@ncsu.edu)

===Team Member===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

===Reference===
#[http://152.7.177.127:3000/ VCL link]
#[https://github.com/b4443/expertiza Github Repo]
#[https://github.com/expertiza/expertiza/pull/2470 Github Pull Request]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vyasrc/expertiza/tree/refactor_suggestion_controller GitHub Project Repository Fork]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Project Documentation Wiki]
#[https://docs.codeclimate.com/docs/cognitive-complexity CodeClimate Documentation]

CSC/ECE 517 Fall 2022 - E2255. Refactor review mapping helper.rb

2022-10-26T16:03:44Z

Zwang236: /* Travis-CI */

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://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 of Expertise to work on various projects and assignments. Students can also peer review other students' submissions. Expertise supports submission across various document types, including URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
* Write test cases of any new code written. Test the existing functionality after refactoring

===Problems and Solutions===
====Problem 1====
* Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
::'''Example:'''
[[File:codec_1.png|900px]]
[[File:codec.png]]
====Problem 2====
* Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas, space or lack of it, and assigning branching condition.
::'''Example One:''' Cyclomatic complexity Error, check_submission_state has Cyclomatic complexity 10 Maximum 5
<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

::'''Solution''': The problem is caused by nesting loops so we break it up

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
return
end

link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # Can be extended for github links in future
color.push 'green'
return
end

link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
</pre>

::'''Example Two:''' Inconsistent Capitalization on comments

<pre>
# loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Solution''': Since many comments have inconsistent capitalization, our group went over the code line by line and manually fixed all inconsistent capitalizations.

<pre>
# Loops through the number of assignment review rounds and obtains the team colour
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []

(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end

color[-1]
end
</pre>

::'''Example Three:''' Inconsistent Spacing

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)
if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end
!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Solution''': Many functions within the file are clustered like the example above, we have to go through the code line by line and add spacing before lines to make the code more readable

<pre>
def submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
submission = SubmissionRecord.where(team_id: response_map.reviewee_id, operation: ['Submit File', 'Submit Hyperlink'])

submission_due_date = assignment_due_dates.where(round: round, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: assignment_created..submission_due_date)

if round > 1
submission_due_last_round = assignment_due_dates.where(round: round - 1, deadline_type_id: 1).try(:first).try(:due_at)
subm_created_at = submission.where(created_at: submission_due_last_round..submission_due_date)
end

!subm_created_at.try(:first).try(:created_at).nil?
end
</pre>

::'''Example Four:''' Add comments for some functions.

<pre>
#
# for calibration report
#
def get_css_style_for_calibration_report(diff)

dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

::'''Solution''': many of the functions inside the code have an inconsistent format and lack comments, our team went through the code line by line to edit and add comments.

<pre>
# Gets CSS style for calibration report
def get_css_style_for_calibration_report(diff)
# Diff - the difference between stu's answer and instructor's answer
dict = { 0 => 'c5', 1 => 'c4', 2 => 'c3', 3 => 'c2' }

if dict.key?(diff.abs)
dict[diff.abs]
else
'c1'
end
end
</pre>

====Problem 3====
* Write test cases of any new code written. Test the existing functionality after refactoring
:Note: Due to the majority of the code already being refactored, Thus our team did not make any major changes to the review_mapping_helper.rb file. We did however use RSPEC to test all existing functions.

<pre>
$ rspec spec/helpers/review_mapping_helper_spec.rb
$ rspec spec/features/review_mapping_helper_spec.rb
</pre>

===Work Flow Diagram===
[[File:codec_2.png|300px]]

===Travis-CI===
[[File:codec_6.png|500px]]

[[File:codec_7.png|500px]]

===RSPEC Testing===

:'''NOTE:''' there are existing errors already inside the code before we started refactoring. And after refactoring, Our changes did not regress any functionality. Since our responsibility is only refactoring the code and not fixing the functionalities, the RSPEC Testing result showed that we have done our due diligence.

: Result RSPEC testing Before Refactoring
:: Command Used:
:: '''rspec spec/helpers/review_mapping_helper_spec.rb'''
:: result
:: 61 examples, 0 failures - spec
[[File:codec_3.png|500px]]
:: Command Used:
:: '''rspec spec/features/review_mapping_helper_spec.rb'''
:: 21 examples, 20 failures - features
[[File:codec_4.png|500px]]

[[File:codec_5.png|500px]]

: Result Rspec testing After Refactoring
:: Our change did not regress any functionality

===Project Mentor===

Edward Gehringer (efg@ncsu.edu)

Jialin Cui (jcui9@ncsu.edu)

===Team Member===

Zanxiang Wang (zwang236@ncsu.edu)

Nikhil Mehra (nmehra2@ncsu.edu)

Brian Davis (bbdavis4@ncsu.edu)

===Reference===
#[http://152.7.177.127:3000/ VCL link]
#[https://github.com/b4443/expertiza Github Repo]
#[https://github.com/expertiza/expertiza/pull/2470 Github Pull Request]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vyasrc/expertiza/tree/refactor_suggestion_controller GitHub Project Repository Fork]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Project Documentation Wiki]
#[https://docs.codeclimate.com/docs/cognitive-complexity CodeClimate Documentation]