Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:30:50Z

Ndviado: /* Results */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

== Our Implementation ==
=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

 
=== Results ===
We were able to display key information from the generated graph as an additional column to the answer tagging report.

[[File:ECE517-EndResult.png]]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

File:ECE517-EndResult.png

2020-11-18T00:30:27Z

Ndviado:

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:28:07Z

Ndviado: /* File Involved */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

== Our Implementation ==
=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

 
=== Results ===
We were able to display key information from the generated graph as an additional column to the answer tagging report.

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:26:51Z

Ndviado:

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

== Our Implementation ==
=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:25:06Z

Ndviado: /* Background */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:24:55Z

Ndviado: /* Previous Work */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:24:39Z

Ndviado: /* Other Information */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:24:25Z

Ndviado: /* Team */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:24:14Z

Ndviado: /* Video URL */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===
https://youtu.be/vw6zJLMDXh4

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:23:07Z

Ndviado: /* File Involved */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
'''helpers/review_mapping_helper.rb''' 
The method calculate_key_chart_information(intervals) was added to calculate the average, min, max, variance and standard deviation from the tagging intervals recorded. These key analytics were then returned as a hash.
[[File:ECE517-Project4-review mapping helper.png]]

 

'''views/reports/_answer_tagging_report.html.erb''' 
This view was modified to print an additional column for the answer tagging report. The column added was "Key Graph Info" which prints the hash that is returned from the method display_key_chart_information(). The hash is printed as a bulleted list.
[[File:ECE517-Project4-answer tagging report.png]]

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===

File:ECE517-Project4-review mapping helper.png

2020-11-18T00:18:12Z

Ndviado:

File:ECE517-Project4-answer tagging report.png

2020-11-18T00:17:33Z

Ndviado:

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-18T00:13:48Z

Ndviado: /* Other possible changes to be made */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== File Involved ===
* helpers/report_formatter_helper.rb
* helpers/review_mapping_helper.rb
* models/tag_prompt_deployment.rb
* models/vm_user_answer_tagging.rb
* views/reports/_answer_tagging_report.html.erb

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

== Other Information ==
=== Pull Request ===
https://github.com/expertiza/expertiza/pull/1848

=== Video URL ===

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-22T22:05:25Z

Ndviado: /* Objective */

File:ECE517Project4 ForLoops.png

2020-10-22T22:01:23Z

Ndviado: Possibly refactor this code

Possibly refactor this code

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-22T21:57:48Z

Ndviado: /* Background */

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-22T21:57:32Z

Ndviado: /* Project Overview */

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-22T21:56:57Z

Ndviado: /* Objective */

File:ECE517Project4 Mockup.png

2020-10-22T21:55:24Z

Ndviado: Add an extra column that takes information from the graph

Add an extra column that takes information from the graph

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-22T21:44:54Z

Ndviado: /* Objective */

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-20T01:19:45Z

Ndviado: /* Changes made to code */

This wiki page describes the changes made under E2054, in order to auto-generate submission directory names based on assignment names for Fall 2020, CSC/ECE 517.

__TOC__

== About Expertiza ==
Expertiza is an open source project based on Ruby on Rails framework, created and maintained by the joint efforts of students and faculty at North Carolina State University.

It allows the instructors to create new assignments and customize new or existing assignments. Expertiza also allows an instructor to create a list of topics the students can sign up for. Students can form teams on the web application to work on various projects and assignments together. Additionally, students can peer review each other's submissions allowing them to improve upon their work. Expertiza supports submission across various document types, including the URLs and wiki pages.

= Need for the current project =

== Goal ==
Each assignment should have its own unique auto-generated submission directory, which is named based on the assignment name entered by the teacher.

== Issues to be fixed ==
In the current implementation of Expertiza, there are following issues need to be addressed: 
Issue #1: The directory name should be auto-generated from the assignment name. 
Issue #2: It should be done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
Issue #3: A check should be added to prevent two assignments in the same course from having the same name. 
Issue #4: Verify or add if not present - a check to stop two assignments from sharing the same directory. 
Issue #5: On changing name of an assignment while creating it, the code shouldn't throw a NoMethodError.

== Issues that have been fixed ==
Fix #1: Submission directory is successfully being generated after the assignment name is typed in. If needed, the submission directory can be changed, however any modifications to the assignment name will just auto-generate it to match. 
Fix #2: A check was added to ensure that assignments in the same course do not share the same name. When creating a course, if the assignment name is a duplicate, it will reset the entire form. 
Fix #3: A check was added to ensure that assignments in the same course do not share the same submission directory. When creating a course, if the submission directory is a duplicate, it will reset the entire form. 
Fix #4: These checks were also put in place when modifying an existent assignment.

= Project implementation =

== Submitted work and demonstration of project ==
* [http://152.7.99.132:8080/ Link to deployed code on NCSU VCL]
* [https://github.com/ndviado/expertiza Link to our Github repository]

== Files involved ==
The controller, helper and spec were modified for this project: 
1. Assignments Controller - assignments_controller.rb 
2. Assignments View - _general.html.erb 
3. Assignemnts Controller Spec - assignments_controller_spec.rb 
4. Assignments Model - assignment.rb

=== Assignments Controller ===
This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== Assignments View ===
This the view for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

=== Assignemnts Controller Spec ===
Tests and bug fixes pertaining to assignments controller.

=== Assignments Model ===
The ruby code which defines how the assignment model functions.

== Description of current project ==
The project primarily deals with the AssignmentsController and AssignmentsView, and changes made are as follows:

The directory name is auto-generated from the assignment name typed in by the instructor.

This is achieved by replacing all spaces in the names with underscores, and removing all special characters like '/','\','$', etc from the auto-generated submission directory name.

If any two assignments of the same name under the same course are attempted to be created, it is prevented and an error message is displayed to the user stating the the submission directory name already exists.

The odd case of a teacher editing the name of an already existing assignment to one that already exists is also handled. Expertiza will display a similar error message stating that the assignment couldn't be saved.

== Changes made to code ==
Most changes were made in the assignments_controller.rb file. Checks were added to ensure that an existing assignment name or submission directory did not exist when creating a new assignment. If the assignment was not created due to an error, the code would ''render new'' which would cause the assignment to be created even though it did not pass all of the checks. Instead of using ''render new'', ''redirect_to "/assignments/new?private=1"'' was used to ensure the form would be reset upon any errors.

The following function was added to app/views/assignments/edit/_general.html.erb, to generate submission directory names with underscores replacing spaces:

<pre>
// E2054 Javascript function to generate the submission directory
$(function() {
$("#assignment_form_assignment_name").change(function() {
filename = $( "#assignment_form_assignment_name" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#assignment_form_assignment_directory_path').val(filename);
});
});
</pre>

Changes were made to the create function in assignments_controller.rb, such that it only creates the assignment directory if the one with the same name doesn't already exist:

'''Before'''
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
if @assignment_form.save
@assignment_form.create_assignment_node
exist_assignment = Assignment.find_by(id: @assignment_form.assignment.id)
assignment_form_params[:assignment][:id] = exist_assignment.id.to_s
if assignment_form_params[:assignment][:directory_path].blank?
assignment_form_params[:assignment][:directory_path] = "assignment_#{assignment_form_params[:assignment][:id]}"
end
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = exist_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = exist_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(id: @assignment_form.assignment.id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

'''After'''
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# E2054 Query for existing directory name and assignment name
find_existing_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
dir_path = assignment_form_params[:assignment][:directory_path]
find_existing_directory = Assignment.find_by(directory_path: dir_path, course_id: @assignment_form.assignment.course_id)
if !find_existing_assignment and !find_existing_directory and @assignment_form.save #No existing names/directories
@assignment_form.create_assignment_node
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else # E2054 Existing Directory or Assignment Name was Found
if find_existing_assignment
flash[:error] = @assignment_form.assignment.name + " already exists as an assignment name"
end
if find_existing_directory
flash[:error] = dir_path + " already exists as a submission directory name"
end
redirect_to "/assignments/new?private=1"
# E2054 Rendering to this page instead of render new, this prevents it from creating a new assignment upon error
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

Changes were made to the '''update_feedback_assignment_form_attributes''' function in the same file to flash an error if an edited file has the same name:

'''Before'''
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.errors.get(:message)}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

'''After'''
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.assignment.name}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

The following validations were added to app/models/assignment.rb, without these validations the user was allowed to change the assignment name or submission directory to one that already exists.
<pre>
validates :directory_path, presence: true # E2054 Needs Validation for unique submission directory
validates :directory_path, uniqueness: {scope: :course_id} # E2054 Needs Validation for unique submission directory
</pre>

= Test Plan =

== Manual UI Testing ==
The following steps must be performed to test the project UI: 
'''Step 1:''' Log in as an Instructor, with Username - instructor6, Password - password 
[[File:logging_in_2054.JPG]] 
'''Step 2:''' Create a new assignment. In this case our assignment is called "E2054 Test Assignment", under course CSC 216 Fall 2009 
[[File:creating_assign_2054.JPG]] 
'''Step 3:''' To save the assignment, the Review and Author Feedback rubrics need to be filled in 
[[File:saving_rubric_2054.JPG]] 
'''Step 4:''' On completion, the assignment will be saved 
[[File:successful_save_2054.JPG]] 
'''Step 5:''' If another assignment of the same name under the same course is created, the following error is displayed 
[[File:already_exists_2054.JPG]] 
'''Step 6:''' On editing an already made assignment to match the same details as "E2054 Test Assignment" 
[[File:editing_2054.JPG]] 
We get the following error: 
[[File:edit_fail_2054.JPG]] 

== RSpec Testing ==
The following RSpec tests were added to the assignments_contoller_spec.rb file
<pre>
# E2054 Ensure Assignment Names Cannot Match
context 'when assignment_form is not saved successfully due to same assignment name already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 1', course_id: 1,
directory_path: 'Assignment2')}.to raise_error(ActiveRecord::RecordInvalid)
end
end

# E2054 Ensure Submission Directory Cannot Match
context 'when assignment_form is not saved successfully due to same submission directory already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 2', course_id: 1,
directory_path: 'Assignment1')}.to raise_error(ActiveRecord::RecordInvalid)
end
end
</pre>

[https://youtu.be/497e8XQ0Jds '''Manual Rspec Testing Video Link''']

= Team Information =
1) Nicholas Viado (ndviado)

2) Akshay Podila (apodila)

Mentor: Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-20T01:13:31Z

Ndviado: /* Changes made to code */

This wiki page describes the changes made under E2054, in order to auto-generate submission directory names based on assignment names for Fall 2020, CSC/ECE 517.

__TOC__

== About Expertiza ==
Expertiza is an open source project based on Ruby on Rails framework, created and maintained by the joint efforts of students and faculty at North Carolina State University.

It allows the instructors to create new assignments and customize new or existing assignments. Expertiza also allows an instructor to create a list of topics the students can sign up for. Students can form teams on the web application to work on various projects and assignments together. Additionally, students can peer review each other's submissions allowing them to improve upon their work. Expertiza supports submission across various document types, including the URLs and wiki pages.

= Need for the current project =

== Goal ==
Each assignment should have its own unique auto-generated submission directory, which is named based on the assignment name entered by the teacher.

== Issues to be fixed ==
In the current implementation of Expertiza, there are following issues need to be addressed: 
Issue #1: The directory name should be auto-generated from the assignment name. 
Issue #2: It should be done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
Issue #3: A check should be added to prevent two assignments in the same course from having the same name. 
Issue #4: Verify or add if not present - a check to stop two assignments from sharing the same directory. 
Issue #5: On changing name of an assignment while creating it, the code shouldn't throw a NoMethodError.

== Issues that have been fixed ==
Fix #1: Submission directory is successfully being generated after the assignment name is typed in. If needed, the submission directory can be changed, however any modifications to the assignment name will just auto-generate it to match. 
Fix #2: A check was added to ensure that assignments in the same course do not share the same name. When creating a course, if the assignment name is a duplicate, it will reset the entire form. 
Fix #3: A check was added to ensure that assignments in the same course do not share the same submission directory. When creating a course, if the submission directory is a duplicate, it will reset the entire form. 
Fix #4: These checks were also put in place when modifying an existent assignment.

= Project implementation =

== Submitted work and demonstration of project ==
* [http://152.7.99.132:8080/ Link to deployed code on NCSU VCL]
* [https://github.com/ndviado/expertiza Link to our Github repository]

== Files involved ==
The controller, helper and spec were modified for this project: 
1. Assignments Controller - assignments_controller.rb 
2. Assignments View - _general.html.erb 
3. Assignemnts Controller Spec - assignments_controller_spec.rb 
4. Assignments Model - assignment.rb

=== Assignments Controller ===
This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== Assignments View ===
This the view for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

=== Assignemnts Controller Spec ===
Tests and bug fixes pertaining to assignments controller.

=== Assignments Model ===
The ruby code which defines how the assignment model functions.

== Description of current project ==
The project primarily deals with the AssignmentsController and AssignmentsView, and changes made are as follows:

The directory name is auto-generated from the assignment name typed in by the instructor.

This is achieved by replacing all spaces in the names with underscores, and removing all special characters like '/','\','$', etc from the auto-generated submission directory name.

If any two assignments of the same name under the same course are attempted to be created, it is prevented and an error message is displayed to the user stating the the submission directory name already exists.

The odd case of a teacher editing the name of an already existing assignment to one that already exists is also handled. Expertiza will display a similar error message stating that the assignment couldn't be saved.

== Changes made to code ==

The following function was added to app/views/assignments/edit/_general.html.erb, to generate submission directory names with underscores replacing spaces:

<pre>
// E2054 Javascript function to generate the submission directory
$(function() {
$("#assignment_form_assignment_name").change(function() {
filename = $( "#assignment_form_assignment_name" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#assignment_form_assignment_directory_path').val(filename);
});
});
</pre>

Changes were made to the create function in assignments_controller.rb, such that it only creates the assignment directory if the one with the same name doesn't already exist:

'''Before'''
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
if @assignment_form.save
@assignment_form.create_assignment_node
exist_assignment = Assignment.find_by(id: @assignment_form.assignment.id)
assignment_form_params[:assignment][:id] = exist_assignment.id.to_s
if assignment_form_params[:assignment][:directory_path].blank?
assignment_form_params[:assignment][:directory_path] = "assignment_#{assignment_form_params[:assignment][:id]}"
end
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = exist_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = exist_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(id: @assignment_form.assignment.id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

'''After'''
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# E2054 Query for existing directory name and assignment name
find_existing_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
dir_path = assignment_form_params[:assignment][:directory_path]
find_existing_directory = Assignment.find_by(directory_path: dir_path, course_id: @assignment_form.assignment.course_id)
if !find_existing_assignment and !find_existing_directory and @assignment_form.save #No existing names/directories
@assignment_form.create_assignment_node
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else # E2054 Existing Directory or Assignment Name was Found
if find_existing_assignment
flash[:error] = @assignment_form.assignment.name + " already exists as an assignment name"
end
if find_existing_directory
flash[:error] = dir_path + " already exists as a submission directory name"
end
redirect_to "/assignments/new?private=1"
# E2054 Rendering to this page instead of render new, this prevents it from creating a new assignment upon error
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

Changes were made to the '''update_feedback_assignment_form_attributes''' function in the same file to flash an error if an edited file has the same name:

'''Before'''
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.errors.get(:message)}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

'''After'''
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.assignment.name}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

The following validations were added to app/models/assignment.rb, without these validations the user was allowed to change the assignment name or submission directory to one that already exists.
<pre>
validates :directory_path, presence: true # E2054 Needs Validation for unique submission directory
validates :directory_path, uniqueness: {scope: :course_id} # E2054 Needs Validation for unique submission directory
</pre>

= Test Plan =

== Manual UI Testing ==
The following steps must be performed to test the project UI: 
'''Step 1:''' Log in as an Instructor, with Username - instructor6, Password - password 
[[File:logging_in_2054.JPG]] 
'''Step 2:''' Create a new assignment. In this case our assignment is called "E2054 Test Assignment", under course CSC 216 Fall 2009 
[[File:creating_assign_2054.JPG]] 
'''Step 3:''' To save the assignment, the Review and Author Feedback rubrics need to be filled in 
[[File:saving_rubric_2054.JPG]] 
'''Step 4:''' On completion, the assignment will be saved 
[[File:successful_save_2054.JPG]] 
'''Step 5:''' If another assignment of the same name under the same course is created, the following error is displayed 
[[File:already_exists_2054.JPG]] 
'''Step 6:''' On editing an already made assignment to match the same details as "E2054 Test Assignment" 
[[File:editing_2054.JPG]] 
We get the following error: 
[[File:edit_fail_2054.JPG]] 

== RSpec Testing ==
The following RSpec tests were added to the assignments_contoller_spec.rb file
<pre>
# E2054 Ensure Assignment Names Cannot Match
context 'when assignment_form is not saved successfully due to same assignment name already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 1', course_id: 1,
directory_path: 'Assignment2')}.to raise_error(ActiveRecord::RecordInvalid)
end
end

# E2054 Ensure Submission Directory Cannot Match
context 'when assignment_form is not saved successfully due to same submission directory already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 2', course_id: 1,
directory_path: 'Assignment1')}.to raise_error(ActiveRecord::RecordInvalid)
end
end
</pre>

[https://youtu.be/497e8XQ0Jds '''Manual Rspec Testing Video Link''']

= Team Information =
1) Nicholas Viado (ndviado)

2) Akshay Podila (apodila)

Mentor: Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-20T01:05:25Z

Ndviado: /* RSpec Testing */

This wiki page describes the changes made under E2054, in order to auto-generate submission directory names based on assignment names for Fall 2020, CSC/ECE 517.

__TOC__

== About Expertiza ==
Expertiza is an open source project based on Ruby on Rails framework, created and maintained by the joint efforts of students and faculty at North Carolina State University.

It allows the instructors to create new assignments and customize new or existing assignments. Expertiza also allows an instructor to create a list of topics the students can sign up for. Students can form teams on the web application to work on various projects and assignments together. Additionally, students can peer review each other's submissions allowing them to improve upon their work. Expertiza supports submission across various document types, including the URLs and wiki pages.

= Need for the current project =

== Goal ==
Each assignment should have its own unique auto-generated submission directory, which is named based on the assignment name entered by the teacher.

== Issues to be fixed ==
In the current implementation of Expertiza, there are following issues need to be addressed: 
Issue #1: The directory name should be auto-generated from the assignment name. 
Issue #2: It should be done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
Issue #3: A check should be added to prevent two assignments in the same course from having the same name. 
Issue #4: Verify or add if not present - a check to stop two assignments from sharing the same directory. 
Issue #5: On changing name of an assignment while creating it, the code shouldn't throw a NoMethodError.

== Issues that have been fixed ==
Fix #1: Submission directory is successfully being generated after the assignment name is typed in. If needed, the submission directory can be changed, however any modifications to the assignment name will just auto-generate it to match. 
Fix #2: A check was added to ensure that assignments in the same course do not share the same name. When creating a course, if the assignment name is a duplicate, it will reset the entire form. 
Fix #3: A check was added to ensure that assignments in the same course do not share the same submission directory. When creating a course, if the submission directory is a duplicate, it will reset the entire form. 
Fix #4: These checks were also put in place when modifying an existent assignment.

= Project implementation =

== Submitted work and demonstration of project ==
* [http://152.7.99.132:8080/ Link to deployed code on NCSU VCL]
* [https://github.com/ndviado/expertiza Link to our Github repository]

== Files involved ==
The controller, helper and spec were modified for this project: 
1. Assignments Controller - assignments_controller.rb 
2. Assignments View - _general.html.erb 
3. Assignemnts Controller Spec - assignments_controller_spec.rb 
4. Assignments Model - assignment.rb

=== Assignments Controller ===
This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== Assignments View ===
This the view for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

=== Assignemnts Controller Spec ===
Tests and bug fixes pertaining to assignments controller.

=== Assignments Model ===
The ruby code which defines how the assignment model functions.

== Description of current project ==
The project primarily deals with the AssignmentsController and AssignmentsView, and changes made are as follows:

The directory name is auto-generated from the assignment name typed in by the instructor.

This is achieved by replacing all spaces in the names with underscores, and removing all special characters like '/','\','$', etc from the auto-generated submission directory name.

If any two assignments of the same name under the same course are attempted to be created, it is prevented and an error message is displayed to the user stating the the submission directory name already exists.

The odd case of a teacher editing the name of an already existing assignment to one that already exists is also handled. Expertiza will display a similar error message stating that the assignment couldn't be saved.

== Changes made to code ==

The following function was added to app/views/assignments/edit/_general.html.erb, to generate submission directory names with underscores replacing spaces:

<pre>
// E2054 Javascript function to generate the submission directory
$(function() {
$("#assignment_form_assignment_name").change(function() {
filename = $( "#assignment_form_assignment_name" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#assignment_form_assignment_directory_path').val(filename);
});
});
</pre>

Changes were made to the create function in assignments_controller.rb, such that it only creates the assignment directory if the one with the same name doesn't already exist:
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# E2054 Query for existing directory name and assignment name
find_existing_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
dir_path = assignment_form_params[:assignment][:directory_path]
find_existing_directory = Assignment.find_by(directory_path: dir_path, course_id: @assignment_form.assignment.course_id)
if !find_existing_assignment and !find_existing_directory and @assignment_form.save #No existing names/directories
@assignment_form.create_assignment_node
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else # E2054 Existing Directory or Assignment Name was Found
if find_existing_assignment
flash[:error] = @assignment_form.assignment.name + " already exists as an assignment name"
end
if find_existing_directory
flash[:error] = dir_path + " already exists as a submission directory name"
end
redirect_to "/assignments/new?private=1"
# E2054 Rendering to this page instead of render new, this prevents it from creating a new assignment upon error
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

Changes were made to the update_feedback_assignment_form_attributes function in the same file to flash an error if an edited file has the same name:
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.assignment.name}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

The following validations were added to app/models/assignment.rb:
<pre>
validates :directory_path, presence: true # E2054 Needs Validation for unique submission directory
validates :directory_path, uniqueness: {scope: :course_id} # E2054 Needs Validation for unique submission directory
</pre>

= Test Plan =

== Manual UI Testing ==
The following steps must be performed to test the project UI: 
'''Step 1:''' Log in as an Instructor, with Username - instructor6, Password - password 
[[File:logging_in_2054.JPG]] 
'''Step 2:''' Create a new assignment. In this case our assignment is called "E2054 Test Assignment", under course CSC 216 Fall 2009 
[[File:creating_assign_2054.JPG]] 
'''Step 3:''' To save the assignment, the Review and Author Feedback rubrics need to be filled in 
[[File:saving_rubric_2054.JPG]] 
'''Step 4:''' On completion, the assignment will be saved 
[[File:successful_save_2054.JPG]] 
'''Step 5:''' If another assignment of the same name under the same course is created, the following error is displayed 
[[File:already_exists_2054.JPG]] 
'''Step 6:''' On editing an already made assignment to match the same details as "E2054 Test Assignment" 
[[File:editing_2054.JPG]] 
We get the following error: 
[[File:edit_fail_2054.JPG]] 

== RSpec Testing ==
The following RSpec tests were added to the assignments_contoller_spec.rb file
<pre>
# E2054 Ensure Assignment Names Cannot Match
context 'when assignment_form is not saved successfully due to same assignment name already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 1', course_id: 1,
directory_path: 'Assignment2')}.to raise_error(ActiveRecord::RecordInvalid)
end
end

# E2054 Ensure Submission Directory Cannot Match
context 'when assignment_form is not saved successfully due to same submission directory already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 2', course_id: 1,
directory_path: 'Assignment1')}.to raise_error(ActiveRecord::RecordInvalid)
end
end
</pre>

[https://youtu.be/497e8XQ0Jds '''Manual Rspec Testing Video Link''']

= Team Information =
1) Nicholas Viado (ndviado)

2) Akshay Podila (apodila)

Mentor: Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-20T01:04:54Z

Ndviado: /* RSpec Testing */

This wiki page describes the changes made under E2054, in order to auto-generate submission directory names based on assignment names for Fall 2020, CSC/ECE 517.

__TOC__

== About Expertiza ==
Expertiza is an open source project based on Ruby on Rails framework, created and maintained by the joint efforts of students and faculty at North Carolina State University.

It allows the instructors to create new assignments and customize new or existing assignments. Expertiza also allows an instructor to create a list of topics the students can sign up for. Students can form teams on the web application to work on various projects and assignments together. Additionally, students can peer review each other's submissions allowing them to improve upon their work. Expertiza supports submission across various document types, including the URLs and wiki pages.

= Need for the current project =

== Goal ==
Each assignment should have its own unique auto-generated submission directory, which is named based on the assignment name entered by the teacher.

== Issues to be fixed ==
In the current implementation of Expertiza, there are following issues need to be addressed: 
Issue #1: The directory name should be auto-generated from the assignment name. 
Issue #2: It should be done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
Issue #3: A check should be added to prevent two assignments in the same course from having the same name. 
Issue #4: Verify or add if not present - a check to stop two assignments from sharing the same directory. 
Issue #5: On changing name of an assignment while creating it, the code shouldn't throw a NoMethodError.

== Issues that have been fixed ==
Fix #1: Submission directory is successfully being generated after the assignment name is typed in. If needed, the submission directory can be changed, however any modifications to the assignment name will just auto-generate it to match. 
Fix #2: A check was added to ensure that assignments in the same course do not share the same name. When creating a course, if the assignment name is a duplicate, it will reset the entire form. 
Fix #3: A check was added to ensure that assignments in the same course do not share the same submission directory. When creating a course, if the submission directory is a duplicate, it will reset the entire form. 
Fix #4: These checks were also put in place when modifying an existent assignment.

= Project implementation =

== Submitted work and demonstration of project ==
* [http://152.7.99.132:8080/ Link to deployed code on NCSU VCL]
* [https://github.com/ndviado/expertiza Link to our Github repository]

== Files involved ==
The controller, helper and spec were modified for this project: 
1. Assignments Controller - assignments_controller.rb 
2. Assignments View - _general.html.erb 
3. Assignemnts Controller Spec - assignments_controller_spec.rb 
4. Assignments Model - assignment.rb

=== Assignments Controller ===
This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== Assignments View ===
This the view for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

=== Assignemnts Controller Spec ===
Tests and bug fixes pertaining to assignments controller.

=== Assignments Model ===
The ruby code which defines how the assignment model functions.

== Description of current project ==
The project primarily deals with the AssignmentsController and AssignmentsView, and changes made are as follows:

The directory name is auto-generated from the assignment name typed in by the instructor.

This is achieved by replacing all spaces in the names with underscores, and removing all special characters like '/','\','$', etc from the auto-generated submission directory name.

If any two assignments of the same name under the same course are attempted to be created, it is prevented and an error message is displayed to the user stating the the submission directory name already exists.

The odd case of a teacher editing the name of an already existing assignment to one that already exists is also handled. Expertiza will display a similar error message stating that the assignment couldn't be saved.

== Changes made to code ==

The following function was added to app/views/assignments/edit/_general.html.erb, to generate submission directory names with underscores replacing spaces:

<pre>
// E2054 Javascript function to generate the submission directory
$(function() {
$("#assignment_form_assignment_name").change(function() {
filename = $( "#assignment_form_assignment_name" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#assignment_form_assignment_directory_path').val(filename);
});
});
</pre>

Changes were made to the create function in assignments_controller.rb, such that it only creates the assignment directory if the one with the same name doesn't already exist:
<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# E2054 Query for existing directory name and assignment name
find_existing_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
dir_path = assignment_form_params[:assignment][:directory_path]
find_existing_directory = Assignment.find_by(directory_path: dir_path, course_id: @assignment_form.assignment.course_id)
if !find_existing_assignment and !find_existing_directory and @assignment_form.save #No existing names/directories
@assignment_form.create_assignment_node
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else # E2054 Existing Directory or Assignment Name was Found
if find_existing_assignment
flash[:error] = @assignment_form.assignment.name + " already exists as an assignment name"
end
if find_existing_directory
flash[:error] = dir_path + " already exists as a submission directory name"
end
redirect_to "/assignments/new?private=1"
# E2054 Rendering to this page instead of render new, this prevents it from creating a new assignment upon error
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

Changes were made to the update_feedback_assignment_form_attributes function in the same file to flash an error if an edited file has the same name:
<pre>
def update_feedback_assignment_form_attributes
if params[:set_pressed][:bool] == 'false'
flash[:error] = "There has been some submissions for the rounds of reviews that you're trying to reduce. You can only increase the round of review."
else
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.assignment.name}"
end
end
ExpertizaLogger.info LoggerMessage.new("", session[:user].name, "The assignment was saved: #{@assignment_form.as_json}", request)
end
</pre>

The following validations were added to app/models/assignment.rb:
<pre>
validates :directory_path, presence: true # E2054 Needs Validation for unique submission directory
validates :directory_path, uniqueness: {scope: :course_id} # E2054 Needs Validation for unique submission directory
</pre>

= Test Plan =

== Manual UI Testing ==
The following steps must be performed to test the project UI: 
'''Step 1:''' Log in as an Instructor, with Username - instructor6, Password - password 
[[File:logging_in_2054.JPG]] 
'''Step 2:''' Create a new assignment. In this case our assignment is called "E2054 Test Assignment", under course CSC 216 Fall 2009 
[[File:creating_assign_2054.JPG]] 
'''Step 3:''' To save the assignment, the Review and Author Feedback rubrics need to be filled in 
[[File:saving_rubric_2054.JPG]] 
'''Step 4:''' On completion, the assignment will be saved 
[[File:successful_save_2054.JPG]] 
'''Step 5:''' If another assignment of the same name under the same course is created, the following error is displayed 
[[File:already_exists_2054.JPG]] 
'''Step 6:''' On editing an already made assignment to match the same details as "E2054 Test Assignment" 
[[File:editing_2054.JPG]] 
We get the following error: 
[[File:edit_fail_2054.JPG]] 

== RSpec Testing ==
The following RSpec tests were added to the assignments_contoller_spec.rb file
<pre>
# E2054 Ensure Assignment Names Cannot Match
context 'when assignment_form is not saved successfully due to same assignment name already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 1', course_id: 1,
directory_path: 'Assignment2')}.to raise_error(ActiveRecord::RecordInvalid)
end
end

# E2054 Ensure Submission Directory Cannot Match
context 'when assignment_form is not saved successfully due to same submission directory already existing' do
it 'raises validation error' do
assignment1 = create(:assignment, name: 'Assignment 1', course_id: 1, directory_path: 'Assignment1')
expect {create(:assignment, name: 'Assignment 2', course_id: 1,
directory_path: 'Assignment1')}.to raise_error(ActiveRecord::RecordInvalid)
end
end
</pre>

[https://youtu.be/497e8XQ0Jds Manual Rspec Testing Run]

= Team Information =
1) Nicholas Viado (ndviado)

2) Akshay Podila (apodila)

Mentor: Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-14T05:35:48Z

Ndviado: /* Background Links */

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-14T05:35:40Z

Ndviado: /* Background */

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-14T05:35:05Z

Ndviado: /* Background */

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-14T05:33:45Z

Ndviado: /* Issues to be fixed */

CSC/ECE 517 Fall 2020 - E2054. Auto generate submission directory names based on assignment names

2020-10-14T05:28:11Z

Ndviado: /* Background */