Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-07T04:07:01Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

[[File: assessment_360_class_diagram.png|700px]]

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

====Solution====

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_current_all_students_all_reviews.png|700px]]

* When the meta reviews checkbox is unchecked:

[[File: assessment_360_hidden_all_students_all_reviews.png|700px]]

====Code changes====

GitHub Commit: https://github.com/expertiza/expertiza/pull/2490/commits/dc9a3ea8b88809c1c3bcb4a3e4b900d1a1eced53

'''Controller code updates'''

[[File:assessment_360_all_students_all_reviews_controller_code.png|700px]]

* In the controller we introduced the hashmaps meta_review_exists, teammate_review_exists, which store boolean values for particular assignments indicating if at least one data point exists for that particular column or not. These values are utilized in the UI, to determine whether or not these columns should be displayed or not.

'''UI code updates'''

[[File: assessment_360_all_students_all_reviews_html_code.png|700px]]

* Checkboxes have been introduced here to allow users to hide/unhide the columns.

* Here, the variables from controller are used to conditionally check whether or not a particular column must be displayed or not.

[[File: assessment_360_all_students_all_reviews_js_code.png|700px]]

* The javascript is used to listen to checkbox change events and dynamically modify the view.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

[[File: assessment_360_course_student_grade_current.png|700px]]

* Missing average peer review column
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

====Solution====

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_course_student_grade_expected.png|700px]]

* When the peer reviews checkbox is unchecked:

[[File: assessment_360_course_student_grade_hidden.png|700px]]

====Code changes====

GitHub Commit: https://github.com/expertiza/expertiza/pull/2490/commits/884c5a3eb9323b9a1b5744755dbbc064f7fcb00d

'''Controller code updates'''

[[File: assessment_360_course_student_grade_controller_code.png|700px]]

* In the controller we introduced the hashmaps topic_exists, assignment_grade_exists and peer_review_score_exists, which store boolean values for particular assignments indicating if at least one data point exists for that particular column or not. These values are utilized in the UI, to determine whether or not these columns should be displayed or not.

* To calculate the average peer score, the objects total_peer_score and total_peer_reviews are being utilized.

'''UI code updates'''

[[File: assessment_360_course_student_grade_html_code.png|700px]]

* Checkboxes have been introduced here to allow users to hide/unhide the columns.

* Here, the variables from controller are used to conditionally check whether or not a particular column must be displayed or not.

[[File: assessment_360_course_student_grade_js_code.png|700px]]

* The javascript is used to listen to checkbox change events and dynamically modify the view.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @team_members_count
* Include appropriate comments wherever applicable

The above changes have been implemented as part of the project.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that only those columns are visible with at least one data point.

4. Verify empty data is shown as '--'

5. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

6. Go to course_student_grade_summary

7. Verify that unattempted scores show up as '--'

8. Verify that average peer score column is visible and has correct values.

7. Verify that unattempted scores aren't counted toward average.

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/OODD-OSS/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://yoururl.tech/expertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/pull/2490 PR Link]
#[https://youtu.be/iOz4lAbyWnQ Demo Video]

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-07T04:05:54Z

Dmmehta2: Add code changes for all_students_all_reviews

File:Assessment 360 all students all reviews js code.png

2022-12-07T04:05:06Z

Dmmehta2:

File:Assessment 360 all students all reviews html code.png

2022-12-07T04:03:58Z

Dmmehta2:

File:Assessment 360 all students all reviews controller code.png

2022-12-07T04:03:06Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-07T03:46:22Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

[[File: assessment_360_class_diagram.png|700px]]

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_current_all_students_all_reviews.png|700px]]

* When the meta reviews checkbox is unchecked:

[[File: assessment_360_hidden_all_students_all_reviews.png|700px]]

===assessment controller > course_student_grade_summary===

The current implementation of this view:

[[File: assessment_360_course_student_grade_current.png|700px]]

* Missing average peer review column
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

====Solution====

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_course_student_grade_expected.png|700px]]

* When the peer reviews checkbox is unchecked:

[[File: assessment_360_course_student_grade_hidden.png|700px]]

====Code changes====

GitHub Commit: https://github.com/expertiza/expertiza/pull/2490/commits/884c5a3eb9323b9a1b5744755dbbc064f7fcb00d

'''Controller code updates'''

[[File: assessment_360_course_student_grade_controller_code.png|700px]]

* In the controller we introduced the hashmaps topic_exists, assignment_grade_exists and peer_review_score_exists, which store boolean values for particular assignments indicating if at least one data point exists for that particular column or not. These values are utilized in the UI, to determine whether or not these columns should be displayed or not.

* To calculate the average peer score, the objects total_peer_score and total_peer_reviews are being utilized.

'''UI code updates'''

[[File: assessment_360_course_student_grade_html_code.png|700px]]

* Checkboxes have been introduced here to allow users to hide/unhide the columns.

* Here, the variables from controller are used to conditionally check whether or not a particular column must be displayed or not.

[[File: assessment_360_course_student_grade_js_code.png|700px]]

* The javascript is used to listen to checkbox change events and dynamically modify the view.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @team_members_count
* Include appropriate comments wherever applicable

The above changes have been implemented as part of the project.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that only those columns are visible with at least one data point.

4. Verify empty data is shown as '--'

5. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

6. Go to course_student_grade_summary

7. Verify that unattempted scores show up as '--'

8. Verify that average peer score column is visible and has correct values.

7. Verify that unattempted scores aren't counted toward average.

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/OODD-OSS/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://yoururl.tech/expertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/pull/2490 PR Link]
#[https://youtu.be/iOz4lAbyWnQ Demo Video]

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-07T03:44:47Z

Dmmehta2: Add code changes for course_student_grade_summary

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

[[File: assessment_360_class_diagram.png|700px]]

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_current_all_students_all_reviews.png|700px]]

* When the meta reviews checkbox is unchecked:

[[File: assessment_360_hidden_all_students_all_reviews.png|700px]]

===assessment controller > course_student_grade_summary===

The current implementation of this view:

[[File: assessment_360_course_student_grade_current.png|700px]]

* Missing average peer review column
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_course_student_grade_expected.png|700px]]

* When the peer reviews checkbox is unchecked:

[[File: assessment_360_course_student_grade_hidden.png|700px]]

====Code Changes====

GitHub Commit: https://github.com/expertiza/expertiza/pull/2490/commits/884c5a3eb9323b9a1b5744755dbbc064f7fcb00d

'''Controller code updates'''

[[File: assessment_360_course_student_grade_controller_code.png|700px]]

* In the controller we introduced the hashmaps topic_exists, assignment_grade_exists and peer_review_score_exists, which store boolean values for particular assignments indicating if at least one data point exists for that particular column or not. These values are utilized in the UI, to determine whether or not these columns should be displayed or not.

* To calculate the average peer score, the objects total_peer_score and total_peer_reviews are being utilized.

'''UI code updates'''

[[File: assessment_360_course_student_grade_html_code.png|700px]]

* Checkboxes have been introduced here to allow users to hide/unhide the columns.

* Here, the variables from controller are used to conditionally check whether or not a particular column must be displayed or not.

[[File: assessment_360_course_student_grade_js_code.png|700px]]

* The javascript is used to listen to checkbox change events and dynamically modify the view.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @team_members_count
* Include appropriate comments wherever applicable

The above changes have been implemented as part of the project.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that only those columns are visible with at least one data point.

4. Verify empty data is shown as '--'

5. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

6. Go to course_student_grade_summary

7. Verify that unattempted scores show up as '--'

8. Verify that average peer score column is visible and has correct values.

7. Verify that unattempted scores aren't counted toward average.

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/OODD-OSS/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://yoururl.tech/expertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/pull/2490 PR Link]
#[https://youtu.be/iOz4lAbyWnQ Demo Video]

File:Assessment 360 course student grade js code.png

2022-12-07T03:43:31Z

Dmmehta2:

File:Assessment 360 course student grade html code.png

2022-12-07T03:40:51Z

Dmmehta2:

File:Assessment 360 course student grade controller code.png

2022-12-07T03:35:50Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-06T03:21:32Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:27:28Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:27:13Z

Dmmehta2: Add references

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:20:56Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:20:01Z

Dmmehta2:

File:Assessment 360 course student grade hidden.png

2022-12-05T22:16:26Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:14:47Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

[[File: assessment_360_course_student_grade_current.png|700px]]

* Missing average peer review column
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

[[File: assessment_360_course_student_grade_expected.png|700px]]

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:14:22Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Missing average peer review column
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

File:Assessment 360 course student grade expected.png

2022-12-05T22:13:27Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 course student grade expected.png

File:Assessment 360 course student grade current.png

2022-12-05T22:11:55Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 course student grade current.png

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:10:34Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

[[File: assessment_360_all_student_all_reviews.png|700px]]

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:10:10Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:09:47Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

File:Assessment 360 current all students all reviews.png

2022-12-05T22:09:34Z

Dmmehta2:

File:Assessment 360 predicted all students all reviews.png

2022-12-05T22:08:22Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 predicted all students all reviews.png

File:Assessment 360 predicted all students all reviews.png

2022-12-05T22:07:57Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 predicted all students all reviews.png

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T22:06:42Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the existing implementation of the assessment360 controller and the updates made to it as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester. Additionally it provides an aggregate of these review scores as well.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its topic, peer score and instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows columns even if all the data in those columns is nil. Additionally, the empty data is just shown as blank and thus leads to confusion.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score. Additionally, the same issue of columns being shown even if all data is empty also exists.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see the updates made to the view to fix the above identified problems:

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

* When the meta reviews checkbox is unchecked:

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

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

File:Assessment 360 hidden all students all reviews.png

2022-12-05T22:06:21Z

Dmmehta2:

File:Assessment 360 predicted all students all reviews.png

2022-12-05T22:05:15Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 predicted all students all reviews.png

File:Assessment 360 all student all reviews.png

2022-12-05T22:03:38Z

Dmmehta2: Dmmehta2 uploaded a new version of File:Assessment 360 all student all reviews.png

This is the screenshot of current implementation of assessment_360 all_student_all_reviews view

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-12-05T15:00:52Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its peer score and its instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Problems & Solutions==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

Following problems were identified in this view:

* Empty rows just show as blank
* Column is visible even if no data is present
* No option to filter columns to allow users to only see particular columns

Below, you can see updates made to the view to fix the above identified problems:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-19T00:04:02Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its peer score and its instructor grade. This includes the total and average of these scores as well.

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

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

File:Assessment 360 class diagram.png

2022-11-19T00:03:07Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-18T18:51:00Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its peer score and its instructor grade. This includes the total and average of these scores as well.

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller - Ensure design principles & patterns===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-17T00:48:51Z

Dmmehta2: /* Introduction */

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester.

2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its peer score and its instructor grade. This includes the total and average of these scores as well.

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-17T00:48:19Z

Dmmehta2: Updates based on reviews received

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

The assessment360 controller is mainly responsible for the following two views:

1) all_students_all_reviews: This view displays all the meta reviews and the teammate reviews of students for all the programs they have worked on in that semester.
2) course_student_grade_summary: This view displays the summary of all the programs that students have worked on, its peer score and its instructor grade. This includes the total and average of these scores as well.

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. In addition to this, the plan is to ensure the SOLID design principles are followed and code will be refactored accordingly.

Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file - Ensuring Single Responsibility design principle

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-16T03:37:54Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problem statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T22:08:50Z

Dmmehta2: /* Manual Testing */

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course

2. Go to the all_students_all_reviews page

3. Verify that either teammate or meta-reviews are visible on the screen

4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

5. Go to course_student_grade_summary

6. Verify that unattempted scores show as 0

7. Verify that unattempted scores aren't counted toward average

8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T22:07:42Z

Dmmehta2: /* Test Plan */

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions that are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases, etc.

2. Since most of the work in this module is computations in the back and rendering data in the front end, tests should be in place to ensure that the computations happen in their specific order and that enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student getting 0 because he/she failed to attempt vs a student getting 0 because he/she hasn't attempted yet. In the first case, we include it while calculating the average while in the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course
2. Go to the all_students_all_reviews page
3. Verify that either teammate or meta-reviews are visible on the screen
4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes
5. Go to course_student_grade_summary
6. Verify that unattempted scores show as 0
7. Verify that unattempted scores aren't counted toward average
8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T22:06:35Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

The following test plan has been identified to ensure that the above changes don't break the existing system and the new code being introduced is thoroughly tested.

=== Automated Testing using RSPEC ===
The primary goal of automated testing would be to increase code coverage by including new test cases and removing redundant and unnecessary tests.

1. Focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Since most of the work in this module is computations in the back and rendering data in the frontend, tests should be in place to ensure that the computations happen in their specific order and enough test cases are present.

3. Below edge cases are currently identified that will be tested:

* Differentiate between a student gettin 0 because he/she failed to attempt vs student getting 0 because he/she hasn't attempted yet. The first case we include while calculating average while the second case we don't.
* If an unauthorized user tries to access the page, they should be redirected to the home page.

=== Manual Testing ===
The following tests have been identified to ensure that the changes made work as anticipated:

1. Open any course
2. Go to all_students_all_reviews page
3. Verify that either of teammate or meta reviews are visible on the screen
4. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes
5. Go to course_student_grade_summary
6. Verify that unattempted scores show as 0
7. Verify that unattempted scores aren't counted towards average
8. Use checkboxes at the top of the screen and ensure columns are hidden or visible based on the selected checkboxes

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:33:24Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI-focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on the [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides functionality that allows instructors to get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

The current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta-reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta-reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

The current implementation of this view:

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

* Replace '-' with '0' for the easier average calculation

* Include columns for average peer review scores and average instructor-assigned scores.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above-mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead, they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Manual Testing ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:31:15Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

Current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

Current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding of appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Manual Testing ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:30:27Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

===assessment controller > all_students_all_reviews view===

Current implementation of this view

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

===assessment controller > course_student_grade_summary===

Current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

===Include checkboxes===

Users should be able to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

===Improve Performance===

Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

===Refactor assessment360_controller===

Adding of appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:26:03Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

1) assessment controller > all_students_all_reviews view, below you can find the screenshot of current implementation of this view:

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

2) assessment controller > course_student_grade_summary, below you can find the screenshot of current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

3) Include checkboxes for users to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

4) Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

5) Refactor assessment360_controller, by adding appropriate comments and updating method/variable names wherever applicable. Currently following changes are identified:

* Update the variable name @teamed_count to @teammate_count
* Include comments for uncommented methods including assignment_grade_summary, insure_existence_of, format_topic, format_score
* Move helper methods format_topic, format_score out of the controller file to the controller_helper file

While the above work has been identified and planned, more scope could be included as and when the team starts implementing the above changes.

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:18:56Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

1) assessment controller > all_students_all_reviews view, below you can find the screenshot of current implementation of this view:

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

2) assessment controller > course_student_grade_summary, below you can find the screenshot of current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

3) Include checkboxes for users to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

4) Implement [https://github.com/flyerhzm/bullet bullet gem] to reduce database queries and increase the application performance.

5) Refactor assessment360_controller, by adding appropriate comments and updating method/variable names wherever applicable.

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:13:22Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

1) assessment controller > all_students_all_reviews view, below you can find the screenshot of current implementation of this view:

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

2) assessment controller > course_student_grade_summary, below you can find the screenshot of current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

3) Include checkboxes for users to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized,
instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:12:36Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

1) assessment controller > all_students_all_reviews view, below you can find the screenshot of current implementation of this view:

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

2) assessment controller > course_student_grade_summary, below you can find the screenshot of current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

3) Include checkboxes for users to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages.

Find an example view of how the page is expected to look after implementing the checkbox filter:

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

<pre>
NOTE:
Please note that the above expected UI views aren't finalized, instead they are just a prediction of how the pages might look after the changes are implemented.
</pre>

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

File:Assessment 360 course student grade expected 1.png

2022-11-15T21:11:53Z

Dmmehta2:

CSC/ECE 517 Fall 2022 - E2278. Improve assessment360 controller

2022-11-15T21:03:24Z

Dmmehta2:

This is the design document for Expertiza project E2278 Improve assessment360_controller.rb. This document describes the current implementation of the assessment360 controller and the expected design changes as part of this project which is primarily UI focused.

== Introduction ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework.
Expertiza provides a functionality that allows instructors get a full or 360-degree overview of a course they teach that includes all students in the course, all assignments, and the scores of every student in each assignment, averages, and final scores as well. This feature is supported by the assessment360 controller.

==Problems statement==

* In the assessment controller > all_students_all_reviews view, it shows a summary including both meta-reviews and teammate reviews and this makes the UI a bit complicated. Thus, this needs to be updated in a way that, the user has the option to select a filter, to either see meta-reviews or teammate reviews but not both at the same time. This will eventually simplify the UI and make it easier to read through.

* Currently on the summary page, if the student hasn't attempted a quiz or they are yet to receive a grade, the view shows that row as '-'. Instead, it is preferable to depict it as '0', this will aid in the better calculation of total scores. One thing to ensure here is, while calculating the average such values must not be considered since the student hasn't attempted it yet, and it would be inaccurate to consider that value while calculating the average for the same.

* Currently the assessment controller > course_student_grade_summary view is missing the columns for average peer review score and average instructor assigned score. Thus, the view should be updated to reflect these scores as well.

* Currently both the pages all_students_all_reviews & course_student_grade_summary show all columns by default and the user has no control to hide/unhide these columns as per their needs. Thus, a checkbox list of columns must be provided for users to select/unselect from and allow users to only see the columns of their interest.

* DB access must be minimized, and this should be implemented with the use of bullet gem.

* Basic refactoring changes need to be implemented, like updating the variable name @teamed_count and using a more appropriate variable name.

==Planned work==

1) assessment controller > all_students_all_reviews view, below you can find the screenshot of current implementation of this view:

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

The plan is to update this view, to take in a parameter in the controller function and based on that parameter, show either the meta reviews or teammate reviews column.

Below, you can see the expected UI after the changes:

* Only Teammate Reviews:

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

* Similarly the above view will be visible if the parameter mentioned meta reviews, the only difference will be the data.

2) assessment controller > course_student_grade_summary, below you can find the screenshot of current implementation of this view:

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

* Replace '-' with '0' for easier average calculation

* Include columns for average peer review scores and average instructor assigned score.

Find below the expected UI after the above changes are implemented:

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

3) Include checkboxes for users to hide/unhide any columns as per their interest. This will be included in both the above mentioned pages

== Test Plan==

=== Automated Testing using RSPEC ===
Please note that we have removed several older tests which tested functions that are now private and inaccessible outside the controller class itself. However, the methods that call these private functions are still tested and tests are passing successfully.

1. After refactoring, most of our new test cases focus on functions which are the core of the controller - covering important aspects like who accesses the page, checking permissions for the page, how the page behaves on edge cases etc.

2. Using RSpec, the test cases cover various scenarios and tests each scenario in depth.
Eg, for access control, we check the access for all roles for a user comprehensively to ensure that only people with permissions can view the page.

3. Since most of the work in this module is computations in the back and rendering data in the frontend, we've ensured that the computations happen in their specific order and enough test cases are present for edge cases.

4. For backend computations, we've covered lot of edge cases like no participants to a course, when there are no reviews made by a participant, when assignment doesn't exists, insure existence_of being called before executing index page etc.

5. For frontend, we've covered cases like formatting of the data in the page, null dataset, score being int, float, null, displaying percentages when data is int, float, null etc.

Even though we've moved most of the code into private functions, the core functionalities of the controller are refactored and appropriate test cases are written to ensure high coverage.

Please run the following command to execute the tests:

rspec spec/controllers/assessment360_controller_spec.rb

=== Testing from UI ===
The following steps needs to be performed to test this code from UI:

1. Log in as instructor(username: instructor6 , password: password). Please either do step 2 or 3, as both are not required.

2. Select Courses, and the page will show a list of courses. Please select the rightmost icons for any course (we recommend CSC517 Fall 2017, CSC517 Fall 2011 so there’s more data, but it can take some time for it load since there’s a lot of pre-loaded data in the VCL)

3. Alternatively, you can log in and go to this URL: http://152.7.99.75:8080/assessment360/index?course_id=184

4. You should be able to see a webpage with a table and checkboxes at the top. This table is an instructor’s 360-degree view of a course, containing the scores of each students in the course for every assignment the instructor has added to Expertiza.

5. Unchecking some or all of the checkboxes removes and brings back various columns from/to the page. Please feel free to test this out.

=== Code Coverage ===

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

File:Assessment 360 course student grade expected.png

2022-11-15T21:01:50Z

Dmmehta2: