Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-30T04:40:33Z

Kyao: /* Important Links */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===
 
[[File:E2158_Proposed_Solution_1.png|1100px]]
 
 
[[File:E2158_Proposed_Solution_2.png|1100px]]
 
 
[[File:E2158_Proposed_Solution_3.png|1100px]]
 

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]
==== Review History Flow====
[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

==== Team History Flow====
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

For the feature part, test if the grading history and instructor can be shown in chronological order:

spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

=== Manual UI Tests ===
To start the test, we need to log in as instructor or TA first. These accounts should have access to the assignment. For example: we can use '''intructor6/password''' or '''teaching_assistant8631/password''';

==== Scenario 1: Grading histories of submissions ====
Step 1. Log in as instructor/TA -> Manage -> Assignments -> View submissions
 
[[File:E2158_view_submisson.png|1100px]]
 
 
Step 2. The instructor/TA can assign grades to a team by clicking 'Assign Grade' in the 'Team name' column:
 
[[File:E2158_grading_history_submisson1.png|1100px]]
 
 
Step 3. The instructor/TA can view the grading audit trail by clicking 'Grading History' in the 'History' column, here is the record page:
 
[[File:E2158_grading_history_submisson2.png|1100px]]
 
 
==== Scenario 2: Grading histories of reviews ====
Step 1. Log in as instructor/TA -> Manage -> Assignments -> View Reports
 
[[File:E2158_view_report.png|1100px]]
 
 
Step 2. Select 'Review Report' then click 'View', here is the Review Report page. The instructor/TA can assign grades to a review by inputing 'Grade' and 'Comment' then clicking 'Save' button:
 
[[File:E2158_grading_history_report1.png|1100px]]
 
 
Step 3. The instructor/TA can view the grading audit trail by clicking 'Grading History' as Step 2 figure shows, here is the record page:
 
[[File:E2158_grading_history_report2.png|1100px]]
 
 

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git Repo]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]
#[https://www.youtube.com/watch?v=ad4wF6--5dQ Test1]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T05:00:49Z

Kyao: /* History of Comment and Grade for Reviews */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]
==== Review History Flow====
[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

==== Team History Flow====
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T05:00:22Z

Kyao: /* History of Comment and Grade for Submissions */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]

[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

==== Team History Flow====
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T04:57:46Z

Kyao: /* History of Comment and Grade for Submissions */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]

[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T04:57:33Z

Kyao: /* History of Comment and Grade for Submissions */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]

[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T04:57:05Z

Kyao: /* History of Comment and Grade for Reviews */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

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

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required 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'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

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

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]

[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

File:Teamhistory.png

2021-11-09T04:55:30Z

Kyao:

File:Reviewhistory.png

2021-11-09T04:55:06Z

Kyao:

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:59:56Z

Kyao: /* Task3 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

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

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:Origin1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:Origin2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:Origin3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-1.png]]

====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task3-1.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:52:54Z

Kyao: /* Task1 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

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

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:Origin1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:Origin2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:Origin3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-1.png]]

====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:51:55Z

Kyao: /* Problem Statement */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

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

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:Origin1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:Origin2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:Origin3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

File:Task3-1.png

2021-10-20T18:48:06Z

Kyao:

File:Task1-1.png

2021-10-20T18:47:55Z

Kyao:

File:Origin3.png

2021-10-20T18:46:47Z

Kyao:

File:Origin2.png

2021-10-20T18:46:27Z

Kyao:

File:Origin1.png

2021-10-20T18:46:13Z

Kyao: