Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-22T04:28:14Z

Dmehta4:

==Introduction==
The Ruby on Rails framework serves as the foundation for the open-source project [https://expertiza.ncsu.edu/ Expertiza]. Expertiza offers features that let instructors see a comprehensive, 360-degree overview of the course they teach, including all of the assignments, all of the students enrolled in the course, all of their individual assignment scores, averages, and final scores. The assessment360 controller facilitates this feature.

Here is the class diagram of this controller -
[[File:Class2.png|700px|center|]]

The following two views are mostly under the control of the assessment360 controller:

1) all_students_all_reviews: This view shows all of the student teammate and meta reviews for every program they worked on that semester. It also offers a summary of these review scores collectively.

2) course_student_grade_summary: This view shows the topic, instructor grade, peer score, and summary of each assignment that students have completed. This also applies to the sum and mean of these scores.

==Problem Statement==
The current implementation of the assessment360_controller.rb suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores. The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application.

Following are the issues to be addressed in this project:

===Issues===
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.
* '''Issue #9:''' Replace hyphen '-' with an en-dash '–'.

==Implementation==
The changes made to the assessment360_controller.rb and related files were necessary to improve the code's readability, maintainability, and adherence to best practices. Let's discuss each change and its significance:

===Files modified===

==== 1. Changes to <code>app/views/assessment360/all_student_all_reviews.html.erb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and renamed<code>@teamed_count</code> variable
|Checked the usage of variable through IDE whether the variable is used. The variable was used to display the total number of teams each student has collaborated with. Thus, it was renamed from <code>@teamed_count</code> to <code>@student_team_counts</code> in both <code>app/controller/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> files for better readability and understandability of the code.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Added check boxes to select columns to display
|Added 2 check boxes (meta reviews and teammate reviews) to select/deselect columns to be displayed.
|[https://github.com/expertiza/expertiza/pull/2792/commits/9190886b4e4825bdf426500de37e08614c48e19a Commit]
|-
|3
|style="width: 30%"| Hide empty columns
|Added checks to ensure column is displayed only when at least one of the rows has a corresponding value to that column in the database.
|[https://github.com/expertiza/expertiza/pull/2792/commits/8dc145ab7541f590ce811c66ce44455ad635769c Commit]
|}

==== 2. Changes to <code>Gemfile</code> and <code>config/environments/development.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Added and initialized the bullet gem
|To identify and reduce unnecessary database queries, the bullet gem was added and activated to increase the performance of the application.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 3. Changes to <code>app/views/assessment360/course_student_grade_summary.html.erb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Separated student name and student ID into different columns
|In order to achieve better understanding of the data being displayed, student name and student ID were separated into different columns.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 4. Changes to <code>app/controllers/assessment360_controller.rb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Replaced hyphen '-' with an en-dash '–'
|Since hyphen was used to represent empty values, it was replaced with an en-dash for enhancing the UI.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Refactored <code>calc_overall_review_info()</code>
|Ensured that if a student has not received a grade for an assignment that row is not considered for calculating the average.
|[https://github.com/expertiza/expertiza/pull/2792/commits/0846538180ac5139301aba824ab847b2ba9ba58a Commit]
|}

== UI Changes made ==

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 

== Code Snippets ==

[[File:Hashes.png|600px]] 
We created 2 hashes <code>meta_review_exists</code> and <code>teammate_review_exists</code> which track if the respective values exist for each assignment. We use these hashes in our view to decide whether to display columns or not. 
[[File:Boolean.png|600px]] 
Here we are assigning values to those hashes based on whether the review exists or not for that particular assignment. 
[[File:Logic.png|600px]] 
This is the new logic for calculating grade averages ensuring that only those grades are considered which have been reviewed for the average calculation so that the calculation is accurate. 
[[File:Script.png|600px]] 
This is the JavaScript code we wrote to ensure that our view changes dynamically based on selection/deselection of the checkboxes. 

== Design Principles and Patterns ==
We have tried to apply the techniques we have learned in the class wherever it was possible. This included DRYing out the code and adding proper comments enhancing its readability and maintainability.
* We created a method called <code>handleCheckboxChange</code> which was responsible for listening to various checkbox events, thus helping us to DRY out our code since we did not have to write the same code again for another checkbox. 
== Test Plan==

The following test plan has been identified to ensure that the our 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. Select any course
[[File:Expertiza-3.png|1000px|center|]]

2. Go to the all_students_all_reviews page by clicking on the icon next to the globe icon.
[[File:Expertiza-2.PNG|1000px|center|]]

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

4. Add 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 by clicking on the the globe icon.
[[File:Expertiza-1.PNG|1000px|center|]]

6. Verify that empty data that is shown as '-' (a hyphen) is replaced by an '–' (en-dash).

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

8. Verify that unattempted assignments or assignments that are not graded are assigned '0' value instead of leaving it blank.

9. Verify that unattempted assignments or assignments that are not graded aren't counted towards the average score.

10. Verify that student name and student ID are in different columns

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

==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
1) Daksh Mehta (unityID: dmehta4, GitHub: [https://github.com/ dakshmehta23]) 
2) Soham Patil (unityID: sspatil6, GitHub: [https://github.com/ ThErOCk07]) 
3) Unnati Bukhariya (unityID: ubukhar2, GitHub: [https://github.com/ unnzzz]) 

== Relevant Links==

'''1. Youtube Video:'''

'''2. Github forked repository:''' https://github.com/ThErOCk07/expertiza

'''3. Github Pull request:''' https://github.com/expertiza/expertiza/pull/2792

File:Class2.png

2024-04-22T04:26:49Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-22T04:07:28Z

Dmehta4: /* Relevant Links */

==Introduction==
The Ruby on Rails framework serves as the foundation for the open-source project [https://expertiza.ncsu.edu/ Expertiza]. Expertiza offers features that let instructors see a comprehensive, 360-degree overview of the course they teach, including all of the assignments, all of the students enrolled in the course, all of their individual assignment scores, averages, and final scores. The assessment360 controller facilitates this feature.

The following two views are mostly under the control of the assessment360 controller:

1) all_students_all_reviews: This view shows all of the student teammate and meta reviews for every program they worked on that semester. It also offers a summary of these review scores collectively.

2) course_student_grade_summary: This view shows the topic, instructor grade, peer score, and summary of each assignment that students have completed. This also applies to the sum and mean of these scores.

==Problem Statement==
The current implementation of the assessment360_controller.rb suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores. The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application.

Following are the issues to be addressed in this project:

===Issues===
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.
* '''Issue #9:''' Replace hyphen '-' with an en-dash '–'.

==Implementation==
The changes made to the assessment360_controller.rb and related files were necessary to improve the code's readability, maintainability, and adherence to best practices. Let's discuss each change and its significance:

===Files modified===

==== 1. Changes to <code>app/views/assessment360/all_student_all_reviews.html.erb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and renamed<code>@teamed_count</code> variable
|Checked the usage of variable through IDE whether the variable is used. The variable was used to display the total number of teams each student has collaborated with. Thus, it was renamed from <code>@teamed_count</code> to <code>@student_team_counts</code> in both <code>app/controller/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> files for better readability and understandability of the code.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Added check boxes to select columns to display
|Added 2 check boxes (meta reviews and teammate reviews) to select/deselect columns to be displayed.
|[https://github.com/expertiza/expertiza/pull/2792/commits/9190886b4e4825bdf426500de37e08614c48e19a Commit]
|-
|3
|style="width: 30%"| Hide empty columns
|Added checks to ensure column is displayed only when at least one of the rows has a corresponding value to that column in the database.
|[https://github.com/expertiza/expertiza/pull/2792/commits/8dc145ab7541f590ce811c66ce44455ad635769c Commit]
|}

==== 2. Changes to <code>Gemfile</code> and <code>config/environments/development.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Added and initialized the bullet gem
|To identify and reduce unnecessary database queries, the bullet gem was added and activated to increase the performance of the application.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 3. Changes to <code>app/views/assessment360/course_student_grade_summary.html.erb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Separated student name and student ID into different columns
|In order to achieve better understanding of the data being displayed, student name and student ID were separated into different columns.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 4. Changes to <code>app/controllers/assessment360_controller.rb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Replaced hyphen '-' with an en-dash '–'
|Since hyphen was used to represent empty values, it was replaced with an en-dash for enhancing the UI.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Refactored <code>calc_overall_review_info()</code>
|Ensured that if a student has not received a grade for an assignment that row is not considered for calculating the average.
|[https://github.com/expertiza/expertiza/pull/2792/commits/0846538180ac5139301aba824ab847b2ba9ba58a Commit]
|}

== UI Changes made ==

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 

== Code Snippets ==

[[File:Hashes.png|600px]] 
We created 2 hashes <code>meta_review_exists</code> and <code>teammate_review_exists</code> which track if the respective values exist for each assignment. We use these hashes in our view to decide whether to display columns or not. 
[[File:Boolean.png|600px]] 
Here we are assigning values to those hashes based on whether the review exists or not for that particular assignment. 
[[File:Logic.png|600px]] 
This is the new logic for calculating grade averages ensuring that only those grades are considered which have been reviewed for the average calculation so that the calculation is accurate. 
[[File:Script.png|600px]] 
This is the JavaScript code we wrote to ensure that our view changes dynamically based on selection/deselection of the checkboxes. 

== Design Principles and Patterns ==
We have tried to apply the techniques we have learned in the class wherever it was possible. This included DRYing out the code and adding proper comments enhancing its readability and maintainability.
* We created a method called <code>handleCheckboxChange</code> which was responsible for listening to various checkbox events, thus helping us to DRY out our code since we did not have to write the same code again for another checkbox. 
== Test Plan==

The following test plan has been identified to ensure that the our 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. Select any course
[[File:Expertiza-3.png|1000px|center|]]

2. Go to the all_students_all_reviews page by clicking on the icon next to the globe icon.
[[File:Expertiza-2.PNG|1000px|center|]]

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

4. Add 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 by clicking on the the globe icon.
[[File:Expertiza-1.PNG|1000px|center|]]

6. Verify that empty data that is shown as '-' (a hyphen) is replaced by an '–' (en-dash).

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

8. Verify that unattempted assignments or assignments that are not graded are assigned '0' value instead of leaving it blank.

9. Verify that unattempted assignments or assignments that are not graded aren't counted towards the average score.

10. Verify that student name and student ID are in different columns

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

==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
1) Daksh Mehta (unityID: dmehta4, GitHub: [https://github.com/ dakshmehta23]) 
2) Soham Patil (unityID: sspatil6, GitHub: [https://github.com/ ThErOCk07]) 
3) Unnati Bukhariya (unityID: ubukhar2, GitHub: [https://github.com/ unnzzz]) 

== Relevant Links==

'''1. Youtube Video:'''

'''2. Github forked repository:''' https://github.com/ThErOCk07/expertiza

'''3. Github Pull request:''' https://github.com/expertiza/expertiza/pull/2792

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-22T04:05:28Z

Dmehta4:

==Introduction==
The Ruby on Rails framework serves as the foundation for the open-source project [https://expertiza.ncsu.edu/ Expertiza]. Expertiza offers features that let instructors see a comprehensive, 360-degree overview of the course they teach, including all of the assignments, all of the students enrolled in the course, all of their individual assignment scores, averages, and final scores. The assessment360 controller facilitates this feature.

The following two views are mostly under the control of the assessment360 controller:

1) all_students_all_reviews: This view shows all of the student teammate and meta reviews for every program they worked on that semester. It also offers a summary of these review scores collectively.

2) course_student_grade_summary: This view shows the topic, instructor grade, peer score, and summary of each assignment that students have completed. This also applies to the sum and mean of these scores.

==Problem Statement==
The current implementation of the assessment360_controller.rb suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores. The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application.

Following are the issues to be addressed in this project:

===Issues===
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.
* '''Issue #9:''' Replace hyphen '-' with an en-dash '–'.

==Implementation==
The changes made to the assessment360_controller.rb and related files were necessary to improve the code's readability, maintainability, and adherence to best practices. Let's discuss each change and its significance:

===Files modified===

==== 1. Changes to <code>app/views/assessment360/all_student_all_reviews.html.erb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and renamed<code>@teamed_count</code> variable
|Checked the usage of variable through IDE whether the variable is used. The variable was used to display the total number of teams each student has collaborated with. Thus, it was renamed from <code>@teamed_count</code> to <code>@student_team_counts</code> in both <code>app/controller/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> files for better readability and understandability of the code.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Added check boxes to select columns to display
|Added 2 check boxes (meta reviews and teammate reviews) to select/deselect columns to be displayed.
|[https://github.com/expertiza/expertiza/pull/2792/commits/9190886b4e4825bdf426500de37e08614c48e19a Commit]
|-
|3
|style="width: 30%"| Hide empty columns
|Added checks to ensure column is displayed only when at least one of the rows has a corresponding value to that column in the database.
|[https://github.com/expertiza/expertiza/pull/2792/commits/8dc145ab7541f590ce811c66ce44455ad635769c Commit]
|}

==== 2. Changes to <code>Gemfile</code> and <code>config/environments/development.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Added and initialized the bullet gem
|To identify and reduce unnecessary database queries, the bullet gem was added and activated to increase the performance of the application.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 3. Changes to <code>app/views/assessment360/course_student_grade_summary.html.erb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Separated student name and student ID into different columns
|In order to achieve better understanding of the data being displayed, student name and student ID were separated into different columns.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 4. Changes to <code>app/controllers/assessment360_controller.rb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Replaced hyphen '-' with an en-dash '–'
|Since hyphen was used to represent empty values, it was replaced with an en-dash for enhancing the UI.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Refactored <code>calc_overall_review_info()</code>
|Ensured that if a student has not received a grade for an assignment that row is not considered for calculating the average.
|[https://github.com/expertiza/expertiza/pull/2792/commits/0846538180ac5139301aba824ab847b2ba9ba58a Commit]
|}

== UI Changes made ==

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 

== Code Snippets ==

[[File:Hashes.png|600px]] 
We created 2 hashes <code>meta_review_exists</code> and <code>teammate_review_exists</code> which track if the respective values exist for each assignment. We use these hashes in our view to decide whether to display columns or not. 
[[File:Boolean.png|600px]] 
Here we are assigning values to those hashes based on whether the review exists or not for that particular assignment. 
[[File:Logic.png|600px]] 
This is the new logic for calculating grade averages ensuring that only those grades are considered which have been reviewed for the average calculation so that the calculation is accurate. 
[[File:Script.png|600px]] 
This is the JavaScript code we wrote to ensure that our view changes dynamically based on selection/deselection of the checkboxes. 

== Design Principles and Patterns ==
We have tried to apply the techniques we have learned in the class wherever it was possible. This included DRYing out the code and adding proper comments enhancing its readability and maintainability.
* We created a method called <code>handleCheckboxChange</code> which was responsible for listening to various checkbox events, thus helping us to DRY out our code since we did not have to write the same code again for another checkbox. 
== Test Plan==

The following test plan has been identified to ensure that the our 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. Select any course
[[File:Expertiza-3.png|1000px|center|]]

2. Go to the all_students_all_reviews page by clicking on the icon next to the globe icon.
[[File:Expertiza-2.PNG|1000px|center|]]

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

4. Add 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 by clicking on the the globe icon.
[[File:Expertiza-1.PNG|1000px|center|]]

6. Verify that empty data that is shown as '-' (a hyphen) is replaced by an '–' (en-dash).

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

8. Verify that unattempted assignments or assignments that are not graded are assigned '0' value instead of leaving it blank.

9. Verify that unattempted assignments or assignments that are not graded aren't counted towards the average score.

10. Verify that student name and student ID are in different columns

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

==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
1) Daksh Mehta (unityID: dmehta4, GitHub: [https://github.com/ dakshmehta23]) 
2) Soham Patil (unityID: sspatil6, GitHub: [https://github.com/ ThErOCk07]) 
3) Unnati Bukhariya (unityID: ubukhar2, GitHub: [https://github.com/ unnzzz]) 

== Relevant Links==

'''1. Github repository:''' https://github.com/expertiza/expertiza

'''2. Github forked repository:''' https://github.com/ThErOCk07/expertiza

'''3. Github Pull request:'''

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-22T04:00:15Z

Dmehta4:

==Introduction==
The Ruby on Rails framework serves as the foundation for the open-source project [https://expertiza.ncsu.edu/ Expertiza]. Expertiza offers features that let instructors see a comprehensive, 360-degree overview of the course they teach, including all of the assignments, all of the students enrolled in the course, all of their individual assignment scores, averages, and final scores. The assessment360 controller facilitates this feature.

The following two views are mostly under the control of the assessment360 controller:

1) all_students_all_reviews: This view shows all of the student teammate and meta reviews for every program they worked on that semester. It also offers a summary of these review scores collectively.

2) course_student_grade_summary: This view shows the topic, instructor grade, peer score, and summary of each assignment that students have completed. This also applies to the sum and mean of these scores.

==Problem Statement==
The current implementation of the assessment360_controller.rb suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores. The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application.

Following are the issues to be addressed in this project:

===Issues===
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.
* '''Issue #9:''' Replace hyphen '-' with an en-dash '–'.

==Implementation==
The changes made to the assessment360_controller.rb and related files were necessary to improve the code's readability, maintainability, and adherence to best practices. Let's discuss each change and its significance:

===Files modified===

==== 1. Changes to <code>app/views/assessment360/all_student_all_reviews.html.erb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and renamed<code>@teamed_count</code> variable
|Checked the usage of variable through IDE whether the variable is used. The variable was used to display the total number of teams each student has collaborated with. Thus, it was renamed from <code>@teamed_count</code> to <code>@student_team_counts</code> in both <code>app/controller/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> files for better readability and understandability of the code.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Added check boxes to select columns to display
|Added 2 check boxes (meta reviews and teammate reviews) to select/deselect columns to be displayed.
|[https://github.com/expertiza/expertiza/pull/2792/commits/9190886b4e4825bdf426500de37e08614c48e19a Commit]
|-
|3
|style="width: 30%"| Hide empty columns
|Added checks to ensure column is displayed only when at least one of the rows has a corresponding value to that column in the database.
|[https://github.com/expertiza/expertiza/pull/2792/commits/8dc145ab7541f590ce811c66ce44455ad635769c Commit]
|}

==== 2. Changes to <code>Gemfile</code> and <code>config/environments/development.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Added and initialized the bullet gem
|To identify and reduce unnecessary database queries, the bullet gem was added and activated to increase the performance of the application.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 3. Changes to <code>app/views/assessment360/course_student_grade_summary.html.erb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Separated student name and student ID into different columns
|In order to achieve better understanding of the data being displayed, student name and student ID were separated into different columns.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 4. Changes to <code>app/controllers/assessment360_controller.rb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Replaced hyphen '-' with an en-dash '–'
|Since hyphen was used to represent empty values, it was replaced with an en-dash for enhancing the UI.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Refactored <code>calc_overall_review_info()</code>
|Ensured that if a student has not received a grade for an assignment that row is not considered for calculating the average.
|[https://github.com/expertiza/expertiza/pull/2792/commits/0846538180ac5139301aba824ab847b2ba9ba58a Commit]
|}

== UI Changes made ==

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 

== Code Snippets ==

[[File:Hashes.png|600px]] 
We created 2 hashes <code>meta_review_exists</code> and <code>teammate_review_exists</code> which track if the respective values exist for each assignment. We use these hashes in our view to decide whether to display columns or not. 
[[File:Boolean.png|600px]] 
Here we are assigning values to those hashes based on whether the review exists or not for that particular assignment. 
[[File:Logic.png|600px]] 
This is the new logic for calculating grade averages ensuring that only those grades are considered which have been reviewed for the average calculation so that the calculation is accurate. 
[[File:Script.png|600px]] 
This is the JavaScript code we wrote to ensure that our view changes dynamically based on selection/deselection of the checkboxes. 

== Test Plan==

The following test plan has been identified to ensure that the our 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. Select any course
[[File:Expertiza-3.png|1000px|center|]]

2. Go to the all_students_all_reviews page by clicking on the icon next to the globe icon.
[[File:Expertiza-2.PNG|1000px|center|]]

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

4. Add 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 by clicking on the the globe icon.
[[File:Expertiza-1.PNG|1000px|center|]]

6. Verify that empty data that is shown as '-' (a hyphen) is replaced by an '–' (en-dash).

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

8. Verify that unattempted assignments or assignments that are not graded are assigned '0' value instead of leaving it blank.

9. Verify that unattempted assignments or assignments that are not graded aren't counted towards the average score.

10. Verify that student name and student ID are in different columns

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

==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
1) Daksh Mehta (unityID: dmehta4, GitHub: [https://github.com/ dakshmehta23]) 
2) Soham Patil (unityID: sspatil6, GitHub: [https://github.com/ ThErOCk07]) 
3) Unnati Bukhariya (unityID: ubukhar2, GitHub: [https://github.com/ unnzzz]) 

== Relevant Links==

'''1. Github repository:''' https://github.com/expertiza/expertiza

'''2. Github forked repository:''' https://github.com/ThErOCk07/expertiza

'''3. Github Pull request:'''

File:Script.png

2024-04-22T03:49:46Z

Dmehta4:

File:Logic.png

2024-04-22T03:49:21Z

Dmehta4:

File:Hashes.png

2024-04-22T03:49:03Z

Dmehta4:

File:Boolean.png

2024-04-22T03:48:28Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-22T03:28:27Z

Dmehta4:

==Introduction==
The Ruby on Rails framework serves as the foundation for the open-source project [https://expertiza.ncsu.edu/ Expertiza]. Expertiza offers features that let instructors see a comprehensive, 360-degree overview of the course they teach, including all of the assignments, all of the students enrolled in the course, all of their individual assignment scores, averages, and final scores. The assessment360 controller facilitates this feature.

The following two views are mostly under the control of the assessment360 controller:

1) all_students_all_reviews: This view shows all of the student teammate and meta reviews for every program they worked on that semester. It also offers a summary of these review scores collectively.

2) course_student_grade_summary: This view shows the topic, instructor grade, peer score, and summary of each assignment that students have completed. This also applies to the sum and mean of these scores.

==Problem Statement==
The current implementation of the assessment360_controller.rb suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores. The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application.

Following are the issues to be addressed in this project:

===Issues===
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.
* '''Issue #9:''' Replace hyphen '-' with an en-dash '–'.

==Implementation==
The changes made to the assessment360_controller.rb and related files were necessary to improve the code's readability, maintainability, and adherence to best practices. Let's discuss each change and its significance:

===Files modified===

==== 1. Changes to <code>app/controllers/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and renamed<code>@teamed_count</code> variable
|Checked the usage of variable through IDE whether the variable is used. The variable was used to display the total number of teams each student has collaborated with. Thus, it was renamed from <code>@teamed_count</code> to <code>@student_team_counts</code> in both <code>app/controller/assessment360_controller.rb</code> and <code>app/views/assessment360/all_student_all_reviews.html.erb</code> files for better readability and understandability of the code.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Added check boxes to select columns to display
|Added 2 check boxes (meta reviews and teammate reviews) to select/deselect columns to be displayed.
|[https://github.com/expertiza/expertiza/pull/2792/commits/9190886b4e4825bdf426500de37e08614c48e19a Commit]
|-
|3
|style="width: 30%"| Hide empty columns
|Added checks to ensure column is displayed only when at least one of the rows has a corresponding value to that column in the database.
|[https://github.com/expertiza/expertiza/pull/2792/commits/8dc145ab7541f590ce811c66ce44455ad635769c Commit]
|-
|4
|style="width: 30%"| Refactored <code>calc_overall_review_info()</code>
|Ensured that if a student has not received a grade for an assignment that row is not considered for calculating the average.
|[https://github.com/expertiza/expertiza/pull/2792/commits/0846538180ac5139301aba824ab847b2ba9ba58a Commit]
|}

==== 2. Changes to <code>Gemfile</code> and <code>config/environments/development.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Added and initialized the bullet gem
|To identify and reduce unnecessary database queries, the bullet gem was added and activated to increase the performance of the application.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 3. Changes to <code>app/views/assessment360/course_student_grade_summary.html.erb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Separated student name and student ID into different columns
|In order to achieve better understanding of the data being displayed, student name and student ID were separated into different columns.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==== 4. Changes to <code>app/controllers/assessment360_controller.rb</code> ====

{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|style="width: 30%"|Replaced hyphen '-' with an en-dash '–'
|Since hyphen was used to represent empty values, it was replaced with an en-dash for enhancing the UI.
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|}

==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
1) Daksh Mehta (unityID: dmehta4, GitHub: [https://github.com/ dakshmehta23]) 
2) Soham Patil (unityID: sspatil6, GitHub: [https://github.com/ ThErOCk07]) 
3) Unnati Bukhariya (unityID: ubukhar2, GitHub: [https://github.com/ unnzzz]) 

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 

== Test Plan==

The following test plan has been identified to ensure that the our 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. Select any course
[[File:Expertiza-3.png|1000px|center|]]

2. Go to the all_students_all_reviews page by clicking on the icon next to the globe icon.
[[File:Expertiza-2.PNG|1000px|center|]]

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

4. Add 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 by clicking on the the globe icon.
[[File:Expertiza-1.PNG|1000px|center|]]

6. Verify that empty data that is shown as '-' (a hyphen) is replaced by an '–' (en-dash).

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

8. Verify that unattempted assignments or assignments that are not graded are assigned '0' value instead of leaving it blank.

9. Verify that unattempted assignments or assignments that are not graded aren't counted towards the average score.

10. Verify that student name and student ID are in different columns

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

== Relevant Links==

'''1. Github repository:''' https://github.com/expertiza/expertiza

'''2. Github forked repository:''' https://github.com/ThErOCk07/expertiza

'''3. Github Pull request:'''

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T02:03:59Z

Dmehta4:

==Problem Statement==
The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application. This controller is responsible for displaying course-level data, including review averages, project details for each student, and their corresponding grades. The current implementation suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores.
==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
Daksh Mehta (unityID:dmehta4, GitHub:dakshmehta23) 
Soham Patil (unityID:sspatil6, GitHub:ThErOCk07) 
Unnati Bukhariya (unityID:ubukhar2, GitHub:unnzzz) 

==Issues to be addressed==
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T02:02:56Z

Dmehta4:

==Problem Statement==
The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application. This controller is responsible for displaying course-level data, including review averages, project details for each student, and their corresponding grades. The current implementation suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores.
==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
Daksh Mehta (unityID:dmehta4, GitHub:dakshmehta23) 
Soham Patil (unityID:sspatil6, GitHub:ThErOCk07) 
Unnati Bukhariya (unityID:ubukhar2, GitHub:unnzzz) 

==Issues to be addressed==
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.

The assessment360 controller is responsible for the following two views -

'''1) all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]
'''Problems''' - 
1) The column is displayed even though all the rows are blank. 
2) The empty blanks can also lead to confusion and thus must be replaced. 
3) Allow user to choose the columns they wish to be displayed. 
4) Separate columns for student name and student ID 
'''2) course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
'''Problems''' - 
1) A new column for average peer review score needs to be added. 
2) Allow user to choose the columns they wish to be displayed. 
2) Separate columns for student name and student ID 
[[File:Grade summary.png|1000px|center|]]

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T01:53:04Z

Dmehta4:

==Problem Statement==
The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application. This controller is responsible for displaying course-level data, including review averages, project details for each student, and their corresponding grades. The current implementation suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores.
==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
Daksh Mehta (unityID:dmehta4, GitHub:dakshmehta23) 
Soham Patil (unityID:sspatil6, GitHub:ThErOCk07) 
Unnati Bukhariya (unityID:ubukhar2, GitHub:unnzzz) 

==Issues to be addressed==
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.

The assessment360 controller is responsible for the following two views -

1) '''all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.
[[File:Review dm.png|1000px|center|]]

2) '''course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.
[[File:Grade summary.png|1000px|center|]]

File:Review dm.png

2024-04-08T01:52:48Z

Dmehta4:

File:Grade summary.png

2024-04-08T01:50:21Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T01:50:04Z

Dmehta4:

==Problem Statement==
The objective of this project is to enhance the user interface and functionality of the assessment360_controller.rb in the application. This controller is responsible for displaying course-level data, including review averages, project details for each student, and their corresponding grades. The current implementation suffers from several issues such as repetitive elements, cryptic variable names, inaccurate grade calculations, and lack of flexibility in displaying different types of review scores.
==Team==
===Mentor===
Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)

===Team Members===
Daksh Mehta (unityID:dmehta4, GitHub:dakshmehta23) 
Soham Patil (unityID:sspatil6, GitHub:ThErOCk07) 
Unnati Bukhariya (unityID:ubukhar2, GitHub:unnzzz) 

==Issues to be addressed==
The main goals of this project are as follows:
* '''Issue #1:''' Refactor the all_students_all_reviews method to accept parameters specifying the type(s) of review scores to be displayed, and suppress columns for scores not selected.
* '''Issue #2:''' Rename the @teamed_count variable to a more descriptive name or remove it if not used.
* '''Issue #3:''' Ensure accuracy in grade calculations by including only the assignments that were attempted by the student in average grade calculation.
* '''Issue #4:''' Enhance the course_student_grade_summary method to include average peer-review scores and instructor-assigned scores.
* '''Issue #5:''' Columns for various types of review scores should be displayed based on user selection.
* '''Issue #6:''' Utilize the Bullet gem to minimize database accesses and optimize performance.
* '''Issue #7:''' Identify and address edge cases from the UI perspective to ensure consistent and clean behavior across different scenarios.
* '''Issue #8:''' Implement separate columns for student name and student ID to improve readability in the UI.

The assessment360 controller is responsible for the following two views -

1) '''all_students_all_reviews.html.erb''' - This view displays a table of students, their teammate count, and their performance on various assignments. For each assignment, it shows the metareview and teammate review scores. At the end of each row, it displays the aggregate score for metareviews and teammate reviews for each student. The last row of the table provides the class average for each assignment and the overall class average for metareviews and teammate reviews.

2) '''course_student_grade_summary.html.erb''' - This view displays a sortable table of students, their assignments, and their grades. For each assignment, it shows the topic, the peer review score, and the instructor's grade. At the end of each row, it displays the total instructor grade for each student. The table can be sorted by student name or total instructor grade.

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T01:18:34Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2438 Improve assessment360 controller

2024-04-08T01:07:51Z

Dmehta4: Created page with "init"

init

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T22:57:48Z

Dmehta4:

==E2408. Refactor course.rb and course_team.rb models==

__TOC__
== Team ==
=== Members ===

* Daksh Mehta, (unityID:dmehta4, GitHub:dakshmehta23)
* Soham Patil, (unityID:sspatil6@ncsu.edu, GitHub:ThErOCk07)
* Unnati Bukhariya, (unityID:ubukhar2@ncsu.edu, GitHub:unnzzz)

=== Mentor ===
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
== Expertiza Overview ==

===Background===

Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. It is used in select courses at NC State and by professors at several other colleges and universities.

course.rb and course_team.rb models are objects containing information about the course and their associated teams respectively. CourseTeams are used when an instructor wants to use the same teams for the entire semester. CourseTeam is one subclass of Team ; AssignmentTeam is the other. An AssignmentTeam is a team that is created for students to do a single assignment. It is possible to copy CourseTeams to an assignment, where they become AssignmentTeams, or vice versa.

The Course and CourseTeam models had some code smells/issues that were fixed. There were a few methods in these models that shouldn’t be in those models, and a few methods that are no longer used. Certain method names were refactored in order to better understand their functionality.

== Requirements ==

The following changes were made to the models course.rb and course_team.rb
=== Changes in course.rb ===
* '''Removal of get_participant Method'''
The method get_participant was removed.
A global search revealed it was unused throughout the app.
Consequently, the method and its respective RSpec test were removed.

* '''Rename copy_participants Method'''
Renamed the method to copy_assignment_participants.
This new name accurately reflects the method's purpose, which is specific to assignments, enhancing clarity and understanding.

* '''Error Handling Enhancement'''
Refactored add_participant and copy_assignment_participants methods for improved error handling and readability.
Introduced a new method, handle_errors, to centralize error handling and separate it from main function logic.

* '''Other Changes'''
Utilized find_by instead of where.first for SQL queries to the model.
Employed errors.any? instead of unless errors.empty? for better readability.
Added comments throughout the code for improved documentation and understanding.

=== Changes in course_team.rb ===

* '''Removal of add_member method'''
The method add_member was removed.
As Course_team is a subclass of Team, it inherited the add_member functionality from the superclass. Hence, it was removed for better coherence and modularity.

* '''Removal of assignment_id method'''
The method assignment_id was removed.
The assignment_id method wasn't utilized anywhere in the code and therefore had to be removed to reduce redundancy.

* '''Refactoring Course.find(id) to Course.find(course_id)'''
Any instances of Course.find(course_id) were replaced with Course.find(course_id) for better understandability of the code.

* '''Refactoring copy method to copy_to_assignment_team'''
The copy method copied a Course team to an assignment team and thus refactored to copy_to_assigment_team making the code easy to understand.

* '''Refactoring the course_team.rb for importing and exporting csv files'''
Refactored the course_team.rb file to adhere more closely to the Single Responsibility Principle (SRP).
Removed the export and import methods from the model to create a more structured and uniform class.

* '''Creating "team_csv_handler" as a common mechanism for handling csv files'''
We extracted the import and export functions into a new class named TeamCsvHandler.
This new class is responsible solely for handling CSV operations related to teams, so that each class has a distinct reponsibility.
Eliminated the need to duplicate code for exporting , importing and displaying the csv files in the model.

=== Other Changes ===

* The test corresponding to get_participant Method was removed from course_spec.rb
* The test corresponding to copy_participants Method was renamed to copy_assignment_participants.

== Testing ==

To validate the refactored models, we conducted UI testing. We mapped UI buttons and functionalities to their corresponding models and executed relevant tasks to verify the expected outcomes.
*'''Adding team members to a team'''
[[File:E2408 1.png|1000px|center|]]

[[File:E2408 2.png|1000px|center|]]

*'''Running RSpec Tests'''

[[File:E2408 3.png|1000px|center|]]

== Links ==
* '''GitHub Repo:''' https://github.com/dakshmehta23/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2752
* '''VCL URL:'''

File:E2408 3.png

2024-03-24T22:55:53Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T22:50:07Z

Dmehta4: /* Testing */

==E2408. Refactor course.rb and course_team.rb models==

__TOC__
== Team ==
=== Members ===

* Daksh Mehta, (unityID:dmehta4, GitHub:dakshmehta23)
* Soham Patil, (unityID:sspatil6@ncsu.edu, GitHub:ThErOCk07)
* Unnati Bukhariya, (unityID:ubukhar2@ncsu.edu, GitHub:unnzzz)

=== Mentor ===
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
== Expertiza Overview ==

===Background===

Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. It is used in select courses at NC State and by professors at several other colleges and universities.

course.rb and course_team.rb models are objects containing information about the course and their associated teams respectively. CourseTeams are used when an instructor wants to use the same teams for the entire semester. CourseTeam is one subclass of Team ; AssignmentTeam is the other. An AssignmentTeam is a team that is created for students to do a single assignment. It is possible to copy CourseTeams to an assignment, where they become AssignmentTeams, or vice versa.

The Course and CourseTeam models had some code smells/issues that were fixed. There were a few methods in these models that shouldn’t be in those models, and a few methods that are no longer used. Certain method names were refactored in order to better understand their functionality.

== Requirements ==

The following changes were made to the models course.rb and course_team.rb
=== Changes in course.rb ===
* '''Removal of get_participant Method'''
The method get_participant was removed.
A global search revealed it was unused throughout the app.
Consequently, the method and its respective RSpec test were removed.

* '''Rename copy_participants Method'''
Renamed the method to copy_assignment_participants.
This new name accurately reflects the method's purpose, which is specific to assignments, enhancing clarity and understanding.

* '''Error Handling Enhancement'''
Refactored add_participant and copy_assignment_participants methods for improved error handling and readability.
Introduced a new method, handle_errors, to centralize error handling and separate it from main function logic.

* '''Other Changes'''
Utilized find_by instead of where.first for SQL queries to the model.
Employed errors.any? instead of unless errors.empty? for better readability.
Added comments throughout the code for improved documentation and understanding.

=== Changes in course_team.rb ===

* '''Removal of add_member method'''
The method add_member was removed.
As Course_team is a subclass of Team, it inherited the add_member functionality from the superclass. Hence, it was removed for better coherence and modularity.

* '''Removal of assignment_id method'''
The method assignment_id was removed.
The assignment_id method wasn't utilized anywhere in the code and therefore had to be removed to reduce redundancy.

* '''Refactoring Course.find(id) to Course.find(course_id)'''
Any instances of Course.find(course_id) were replaced with Course.find(course_id) for better understandability of the code.

* '''Refactoring copy method to copy_to_assignment_team'''
The copy method copied a Course team to an assignment team and thus refactored to copy_to_assigment_team making the code easy to understand.

=== Other Changes ===

* The test corresponding to get_participant Method was removed from course_spec.rb
* The test corresponding to copy_participants Method was renamed to copy_assignment_participants.

== Testing ==

To validate the refactored models, we conducted UI testing. We mapped UI buttons and functionalities to their corresponding models and executed relevant tasks to verify the expected outcomes.
*Adding team members to a team
[[File:E2408 1.png|1000px|left|]]
[[File:E2408 2.png|1000px|left|]]

== Links ==
* '''GitHub Repo:''' https://github.com/dakshmehta23/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2752
* '''VCL URL:'''

File:E2408 2.png

2024-03-24T22:49:37Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T22:46:42Z

Dmehta4: /* Testing */

==E2408. Refactor course.rb and course_team.rb models==

__TOC__
== Team ==
=== Members ===

* Daksh Mehta, (unityID:dmehta4, GitHub:dakshmehta23)
* Soham Patil, (unityID:sspatil6@ncsu.edu, GitHub:ThErOCk07)
* Unnati Bukhariya, (unityID:ubukhar2@ncsu.edu, GitHub:unnzzz)

=== Mentor ===
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
== Expertiza Overview ==

===Background===

Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. It is used in select courses at NC State and by professors at several other colleges and universities.

course.rb and course_team.rb models are objects containing information about the course and their associated teams respectively. CourseTeams are used when an instructor wants to use the same teams for the entire semester. CourseTeam is one subclass of Team ; AssignmentTeam is the other. An AssignmentTeam is a team that is created for students to do a single assignment. It is possible to copy CourseTeams to an assignment, where they become AssignmentTeams, or vice versa.

The Course and CourseTeam models had some code smells/issues that were fixed. There were a few methods in these models that shouldn’t be in those models, and a few methods that are no longer used. Certain method names were refactored in order to better understand their functionality.

== Requirements ==

The following changes were made to the models course.rb and course_team.rb
=== Changes in course.rb ===
* '''Removal of get_participant Method'''
The method get_participant was removed.
A global search revealed it was unused throughout the app.
Consequently, the method and its respective RSpec test were removed.

* '''Rename copy_participants Method'''
Renamed the method to copy_assignment_participants.
This new name accurately reflects the method's purpose, which is specific to assignments, enhancing clarity and understanding.

* '''Error Handling Enhancement'''
Refactored add_participant and copy_assignment_participants methods for improved error handling and readability.
Introduced a new method, handle_errors, to centralize error handling and separate it from main function logic.

* '''Other Changes'''
Utilized find_by instead of where.first for SQL queries to the model.
Employed errors.any? instead of unless errors.empty? for better readability.
Added comments throughout the code for improved documentation and understanding.

=== Changes in course_team.rb ===

* '''Removal of add_member method'''
The method add_member was removed.
As Course_team is a subclass of Team, it inherited the add_member functionality from the superclass. Hence, it was removed for better coherence and modularity.

* '''Removal of assignment_id method'''
The method assignment_id was removed.
The assignment_id method wasn't utilized anywhere in the code and therefore had to be removed to reduce redundancy.

* '''Refactoring Course.find(id) to Course.find(course_id)'''
Any instances of Course.find(course_id) were replaced with Course.find(course_id) for better understandability of the code.

* '''Refactoring copy method to copy_to_assignment_team'''
The copy method copied a Course team to an assignment team and thus refactored to copy_to_assigment_team making the code easy to understand.

=== Other Changes ===

* The test corresponding to get_participant Method was removed from course_spec.rb
* The test corresponding to copy_participants Method was renamed to copy_assignment_participants.

== Testing ==

To validate the refactored models, we conducted UI testing. We mapped UI buttons and functionalities to their corresponding models and executed relevant tasks to verify the expected outcomes.
[[File:e2408_1.jpg]]

== Links ==
* '''GitHub Repo:''' https://github.com/dakshmehta23/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2752
* '''VCL URL:'''

File:E2408 1.png

2024-03-24T22:45:36Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T22:24:08Z

Dmehta4:

==E2408. Refactor course.rb and course_team.rb models==

__TOC__
== Team ==
=== Members ===

* Daksh Mehta, (unityID:dmehta4, GitHub:dakshmehta23)
* Soham Patil, (unityID:sspatil6@ncsu.edu, GitHub:ThErOCk07)
* Unnati Bukhariya, (unityID:ubukhar2@ncsu.edu, GitHub:unnzzz)

=== Mentor ===
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
== Expertiza Overview ==

===Background===

Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. It is used in select courses at NC State and by professors at several other colleges and universities.

course.rb and course_team.rb models are objects containing information about the course and their associated teams respectively. CourseTeams are used when an instructor wants to use the same teams for the entire semester. CourseTeam is one subclass of Team ; AssignmentTeam is the other. An AssignmentTeam is a team that is created for students to do a single assignment. It is possible to copy CourseTeams to an assignment, where they become AssignmentTeams, or vice versa.

The Course and CourseTeam models had some code smells/issues that were fixed. There were a few methods in these models that shouldn’t be in those models, and a few methods that are no longer used. Certain method names were refactored in order to better understand their functionality.

== Requirements ==

The following changes were made to the models course.rb and course_team.rb
=== Changes in course.rb ===
* '''Removal of get_participant Method'''
The method get_participant was removed.
A global search revealed it was unused throughout the app.
Consequently, the method and its respective RSpec test were removed.

* '''Rename copy_participants Method'''
Renamed the method to copy_assignment_participants.
This new name accurately reflects the method's purpose, which is specific to assignments, enhancing clarity and understanding.

* '''Error Handling Enhancement'''
Refactored add_participant and copy_assignment_participants methods for improved error handling and readability.
Introduced a new method, handle_errors, to centralize error handling and separate it from main function logic.

* '''Other Changes'''
Utilized find_by instead of where.first for SQL queries to the model.
Employed errors.any? instead of unless errors.empty? for better readability.
Added comments throughout the code for improved documentation and understanding.

=== Changes in course_team.rb ===

* '''Removal of add_member Method'''
The method add_member was removed.
As Course_team is a subclass of Team, it inherited the add_member functionality from the superclass. Hence, it was removed for better coherence and modularity.

* Delete assignment_id method in CourseTeam class since it is no longer required.
* Refactor Course.find(id) to Course.find(course_id) for better understandability of the code.
* Refactor the copy method in CourseTeam class to something that better describes its functionality.

=== Other Changes ===

* The test corresponding to get_participant Method was removed from course_spec.rb
* The test corresponding to copy_participants Method was renamed to copy_assignment_participants.

== Testing ==

To validate the refactored models, we conducted UI testing. We mapped UI buttons and functionalities to their corresponding models and executed relevant tasks to verify the expected outcomes.

== Links ==
* '''GitHub Repo:''' https://github.com/dakshmehta23/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2752
* '''VCL URL:'''

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T20:59:04Z

Dmehta4:

==E2408. Refactor course.rb and course_team.rb models==

__TOC__
== Team ==
=== Members ===

* Daksh Mehta, (unityID:dmehta4, GitHub:dakshmehta23)
* Soham Patil, (unityID:sspatil6@ncsu.edu, GitHub:ThErOCk07)
* Unnati Bukhariya, (unityID:ubukhar2@ncsu.edu, GitHub:unnzzz)

=== Mentor ===
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
== Expertiza Overview ==

===Background===

Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. It is used in select courses at NC State and by professors at several other colleges and universities.

course.rb and course_team.rb models are objects containing information about the course and their associated teams respectively. CourseTeams are used when an instructor wants to use the same teams for the entire semester. CourseTeam is one subclass of Team ; AssignmentTeam is the other. An AssignmentTeam is a team that is created for students to do a single assignment. It is possible to copy CourseTeams to an assignment, where they become AssignmentTeams, or vice versa.

The Course and CourseTeam models had some code smells/issues that were fixed. There were a few methods in these models that shouldn’t be in those models, and a few methods that are no longer used. Certain method names were refactored in order to better understand their functionality.

== Requirements ==

The following changes were made to the models course.rb and course_team.rb
=== Changes in course.rb ===
* '''Removal of get_participant Method'''
The method get_participant was removed.
A global search revealed it was unused throughout the app.
Consequently, the method and its respective RSpec test were removed.

* '''Rename copy_participants Method'''
Renamed the method to copy_assignment_participants.
This new name accurately reflects the method's purpose, which is specific to assignments, enhancing clarity and understanding.

* '''Error Handling Enhancement'''
Refactored add_participant and copy_assignment_participants methods for improved error handling and readability.
Introduced a new method, handle_errors, to centralize error handling and separate it from main function logic.

* '''Other Changes'''
Utilized find_by instead of where.first for SQL queries to the model.
Employed errors.any? instead of unless errors.empty? for better readability.
Added comments throughout the code for improved documentation and understanding.

=== Changes in course_team.rb ===

* '''Removal of add_member Method'''
The method add_member was removed.
As Course_team is a subclass of Team, it inherited the add_member functionality from the superclass. Hence, it was removed for better coherence and modularity.

* Delete assignment_id method in CourseTeam class since it is no longer required.
* Refactor Course.find(id) to Course.find(course_id) for better understandability of the code.
* Refactor the copy method in CourseTeam class to something that better describes its functionality.

=== Other Changes ===

* The test corresponding to get_participant Method was removed from course_spec.rb
* The test corresponding to copy_participants Method was renamed to copy_assignment_participants.

== Testing ==

== Links ==
* '''GitHub Repo:''' https://github.com/dakshmehta23/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2752
* '''VCL URL:'''

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T20:56:00Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T20:43:15Z

Dmehta4:

CSC/ECE 517 Spring 2024 - E2408. Refactor course.rb and course team.rb models

2024-03-24T20:12:08Z

Dmehta4: