Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality

2021-11-10T20:15:36Z

Nkotche:

== About Expertiza ==
The [http://expertiza.ncsu.edu/ Expertiza] platform employs a divide-and-conquer strategy for creating reusable learning objects via active-learning exercises built entirely on [http://rubyonrails.org/ Ruby on Rails] framework. Students get to choose from a list of tasks to complete either individually or in teams. It also allows the instructor to create a list of topics the students can sign up for. They then prepare their work and submit it to a peer-review mechanism. On submission, other students can assess their peers work and provide feedback. Expertiza encourages students to collaborate in order to improve the learning experiences from one another. It aids their learning by making them translate what is taught in the lectures and apply those concepts to a real-world issue.

== Problem Statement ==
When a team requests a topic which is not available, the team is waitlisted for the topic, given that bidding is not in use for the assignment. When another team drops a topic, then a waitlisted team will be assigned the topic, if there are any teams waitlisted for it. Implement a waitlist object associated with each topic, and a team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉
Currently, the functionality relevant to waitlisting is scattered across the multiple files. These functions need to be consolidated and placed in a single class.

== Control Flow ==
In the current implementation, multiple models and controllers perform actions that indirectly affect the teams in the waitlist and require to be added or removed from the waitlist. Due to this the same redundant operations of modifying the waitlist is being performed by multiple models and controllers. In order to improve the functionality all the redundant operations being performed on the waitlist need to be moved to the 'waitlist.rb' file and all the other controllers and models will be utilising these methods to manipulate the waitlists.

'''Planned implementation:''' The Context object in our case the waitlist object delegates an algorithm to different Strategy objects to execute waitlist functions as shown below. The Context calls algorithm() on a Strategy1 object, which performs the algorithm and returns the result to Context.

'''Existing Control Flow'''
<br>
[[File:Block diagram waitlist current.png|850px]]

'''Modified Control Flow'''
<br>
[[File:Block diagram waitlist modified.png|850px]]

== Solution Approach ==

===Refactoring===
Goal of the project is to simplify waitlist functionality by moving all the functions manipulating waitlists to waitlist.rb, along with a WaitingTeam class that would consist of a 〈team_id, topic_id〉pair to store information regarding teams on waitlist for a particular topic. Classes should just invoke methods of waitlist.rb for the following functionality:
# Add themselves to waitlists
# Add another team to a waitlist
# Take a team off a waitlist
# Purge all waitlists of a specific team
# Clear a specific waitlist of all waiting teams

Introduce a waitlist object associated with each topic so that any team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉

===Design Pattern===
As we are decoupling the functionality manipulating waitlists that is scattered across various files and putting it all under a single class the design pattern opted for is Strategy Design Pattern. It is a behavioural design pattern that lets you define a family of algorithms, put each of them into a separate class, and make their objects interchangeable. The plan is to isolate the code, internal data, and dependencies of various algorithms related to waitlist from the rest of the code. Various clients now get a simple class to execute the algorithms and switch them at runtime.

'''Tentative list of files to be modified'''
# sign_up_topic.rb
# invitation.rb
# waitlist.rb
# lottery_controller.rb
# suggestion_controller.rb
# signed_up_team.rb
# student_teams_controller.rb

== UI Test Steps ==
* Step 1: Signup as an instructor and click on Manage Assignments

[[File:Manage assignments.png|550px]]
[[File:Add assignment.png|550px]]

* Step 2: Create an assignment with the required configurations and click on create.

[[File:Create assignment.png|550px]]

* Step 3: Post assignment creation, go to manage assignments, and edit the newly created assignment

[[File:Edit new assignment.png|550px]]

* Step 4: Selected the 'has topics' options and create new topics for the students to sign up using the topics tab.

[[File:Has_topics_assignment_option.png|550px]]
[[File:Create topics.png|550px]]

* Step 5: Add participants to the assignment using the participant tab and then assign the participants to teams using the teams tab and save the changes.

[[File:Add participants and teams.png|550px]]
[[File:Add teams.png|550px]]
[[File:Add participants.png|550px]]

* Step 6: Impersonate one student that you had added to one team in the previous step.

[[File:Impersonate user.png|550px]]

* Step 7: In the assignment tabs, choose the assignment that you had created in the previous step and click on sign-up sheet to sign up for a topic.

[[File:Signup_sheet.png|550px]]

* Step 8: Sign up for any topic of your choice. If it is available then you will be assigned the slot and the number of available slots will be updated.

[[File:Student7488 signup.png|550px]]
[[File:Student7488 signedup.png|550px]]

* Step 9: Impersonate as another student from another team that you had created for the same assignment in the previous steps and follow the same steps as mentioned above to sign up for a topic. Sign up for the same topic as the previously impersonated student.

[[File:Student431 signup.png|550px]]

* Step 10: You will now notice that since there was only one available slot and the previous team already signed up for it, the current team will be added to the waitlist for that topic.

[[File:Student 431 waitlisted.png|550px]]

* Step 11: You can also check the student currently assigned to a topic and the waitlisted students in the manage assignments tab on logging in as an instructor(As done in the previous steps)

[[File:Teams signedup waitlisted.png|550px]]

* Step 12: Following the above mentioned steps various scenarios can be tested via the UI like:
# Adding more topics
# Multiple teams signing up for the same topic
# Teams dropping topics etc.

'''In the current implemention the following issue exists which will be fixed:'''

'''Scenario 1:''' Assigned teams dropping topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist.

'''Current Issue :'''
The available slot after one team drops the topic does not update due to which the first team in the waitlist is not automatically assigned the topic.
[[File:Topic dropped.png|550px]]

'''Proposed Solution :'''
Implement a new waitlist object to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist.

'''Scenario 2:''' Instructor intervention when assigned teams drops topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist also we know that the manage topics tab while the instructor edits the assignment also contains the team that is currently assigned the topic and the list of waitlisted teams it should be updated when a change occurs.

'''Current Issue :'''
The instructor does not see in the manage assignments topics tab that the topic is not assigned to the first team once it chooses to drop it.
[[File:Teams signedup waitlisted.png|550px]]

'''Proposed Solution :'''
Since the same functionality of maintaining the waitlist is being done at multiple places, the code does not update for the manage assignments topic tab for the instructor. In order to fix this, implementation of a new waitlist object is done to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist and the same object will be consumed everywhere. Hence, the manage assignments topic will be updated automatically.

== Test Plan ==
This project entails code refactoring such that all functionality relevant to waitlist is easily available under one class. Focus is on ensuring existing tests work as expected as the newly added code will not impact functionality per se. However, new unit tests will be written for testing waitlist.rb independently. Furthermore, test cases for suggestion_controller.rb & signed_up_team.rb are missing in the current implementation. Hence, we will be adding spec files for the aforementioned files as well. Certain edge cases will also be tested which have not been covered by the current tests.

'''Test Files'''
# sign_up_topic_spec.rb
# invitation_spec.rb
# waitlist_spec.rb
# lottery_controller_spec.rb
# suggestion_controller_spec.rb
# signed_up_team_spec.rb
# student_teams_controller_spec.rb

'''Cases To Be Tested'''
# Add team to waitlist if topic isn't available.
# Push the first waitlisted member (if exists) in case a confirmed slot is deleted.
# Remove waitlists for team if a topic is confirmed.
# Clean waitlists & assign topic if the user has a team but not a topic.
# Remove old team from waitlists.

'''Automated Tests'''

Automated testing can be done using Capybara. Since a major part of the scenario can be tested using the UI, an automated test to create teams and sign up for topics can be created using Capybara with Cucumber. These tests can be written using the TDD approach prior to defining the code.

'''Code Coverage:''' Code coverage for the test cases can be obtained using the Code Coverage plugin and SimpleCov gem. The lines in the functions for which test cases are written in the corresponding spec file are highlighted in green and the rest of the lines are highlighted in red.

== References ==
# [https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.r80b3xxz9peq Problem Statement]
# [https://github.com/nehajaideep/expertiza Forked Repository]

== Team ==
* Ankit Singh (asingh072318)

* Asrita Kuchibhotla (kAsrita)

* Neha Kotcherlakota (nehajaideep)

* Vinit Desai (VinitDesai1998)

CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality

2021-11-10T05:44:22Z

Nkotche:

== About Expertiza ==
The [http://expertiza.ncsu.edu/ Expertiza] platform employs a divide-and-conquer strategy for creating reusable learning objects via active-learning exercises built entirely on [http://rubyonrails.org/ Ruby on Rails] framework. Students get to choose from a list of tasks to complete either individually or in teams. It also allows the instructor to create a list of topics the students can sign up for. They then prepare their work and submit it to a peer-review mechanism. On submission, other students can assess their peers work and provide feedback. Expertiza encourages students to collaborate in order to improve the learning experiences from one another. It aids their learning by making them translate what is taught in the lectures and apply those concepts to a real-world issue.

== Problem Statement ==
When a team requests a topic which is not available, the team is waitlisted for the topic, given that bidding is not in use for the assignment. When another team drops a topic, then a waitlisted team will be assigned the topic, if there are any teams waitlisted for it. Implement a waitlist object associated with each topic, and a team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉
Currently, the functionality relevant to waitlisting is scattered across the multiple files. These functions need to be consolidated and placed in a single class.

== Control Flow ==
In the current implementation, multiple models and controllers perform actions that indirectly affect the teams in the waitlist and require to be added or removed from the waitlist. Due to this the same redundant operations of modifying the waitlist is being performed by multiple models and controllers. In order to improve the functionality all the redundant operations being performed on the waitlist need to be moved to the 'waitlist.rb' file and all the other controllers and models will be utilising these methods to manipulate the waitlists.
Planned implementation: The Context object in our case the waitlist object delegates an algorithm to different Strategy objects to execute waitlist functions as shown below. The Context calls algorithm() on a Strategy1 object, which performs the algorithm and returns the result to Context.

'''Existing Control Flow'''
<br>
[[File:Block diagram waitlist current.png|850px]]

'''Modified Control Flow'''
<br>
[[File:Block diagram waitlist modified.png|850px]]

== Solution Approach ==

===Refactoring===
Goal of the project is to simplify waitlist functionality by moving all the functions manipulating waitlists to waitlist.rb, along with a WaitingTeam class that would consist of a 〈team_id, topic_id〉pair to store information regarding teams on waitlist for a particular topic. Classes should just invoke methods of waitlist.rb for the following functionality:
# Add themselves to waitlists
# Add another team to a waitlist
# Take a team off a waitlist
# Purge all waitlists of a specific team
# Clear a specific waitlist of all waiting teams

Introduce a waitlist object associated with each topic so that any team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉

===Design Pattern===
As we are decoupling the functionality manipulating waitlists that is scattered across various files and putting it all under a single class the design pattern opted for is Strategy Design Pattern. It is a behavioral design pattern that lets you define a family of algorithms, put each of them into a separate class, and make their objects interchangeable. The plan is to isolate the code, internal data, and dependencies of various algorithms related to waitlist from the rest of the code. Various clients now get a simple class to execute the algorithms and switch them at runtime.

'''Tentative list of files to be modified'''
# sign_up_topic.rb
# invitation.rb
# waitlist.rb
# lottery_controller.rb
# suggestion_controller.rb
# signed_up_team.rb
# student_teams_controller.rb

== UI Test Steps ==
* Step 1: Signup as an instructor and click on Manage Assignments

[[File:Manage assignments.png|550px]]
[[File:Add assignment.png|550px]]

* Step 2: Create an assignment with the required configurations and click on create.

[[File:Create assignment.png|550px]]

* Step 3: Post assignment creation, go to manage assignments, and edit the newly created assignment

[[File:Edit new assignment.png|550px]]

* Step 4: Selected the 'has topics' options and create new topics for the students to sign up using the topics tab.

[[File:Has_topics_assignment_option.png|550px]]
[[File:Create topics.png|550px]]

* Step 5: Add participants to the assignment using the participant tab and then assign the participants to teams using the teams tab and save the changes.

[[File:Add participants and teams.png|550px]]
[[File:Add teams.png|550px]]
[[File:Add participants.png|550px]]

* Step 6: Impersonate one student that you had added to one team in the previous step.

[[File:Impersonate user.png|550px]]

* Step 7: In the assignment tabs, choose the assignment that you had created in the previous step and click on sign-up sheet to sign up for a topic.

[[File:Signup_sheet.png|550px]]

* Step 8: Sign up for any topic of your choice. If it is available then you will be assigned the slot and the number of available slots will be updated.

[[File:Student7488 signup.png|550px]]
[[File:Student7488 signedup.png|550px]]

* Step 9: Impersonate as another student from another team that you had created for the same assignment in the previous steps and follow the same steps as mentioned above to sign up for a topic. Sign up for the same topic as the previously impersonated student.

[[File:Student431 signup.png|550px]]

* Step 10: You will now notice that since there was only one available slot and the previous team already signed up for it, the current team will be added to the waitlist for that topic.

[[File:Student 431 waitlisted.png|550px]]

* Step 11: You can also check the student currently assigned to a topic and the waitlisted students in the manage assignments tab on logging in as an instructor(As done in the previous steps)

[[File:Teams signedup waitlisted.png|550px]]

* Step 12: Following the above mentioned steps various scenarios can be tested via the UI like:
# Adding more topics
# Multiple teams signing up for the same topic
# Teams dropping topics etc.

'''In the current implemention the following issue exists which will be fixed:'''

'''Scenario 1:''' Assigned teams dropping topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist.

'''Current Issue :'''
The available slot after one team drops the topic does not update due to which the first team in the waitlist is not automatically assigned the topic.
[[File:Topic dropped.png|550px]]

'''Proposed Solution :'''
Implement a new waitlist object to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist.

'''Scenario 2:''' Instructor intervention when assigned teams drops topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist also we know that the manage topics tab while the instructor edits the assignment also contains the team that is currently assigned the topic and the list of waitlisted teams it should be updated when a change occurs.

'''Current Issue :'''
The instructor does not see in the manage assignments topics tab that the topic is not assigned to the first team once it chooses to drop it.
[[File:Teams signedup waitlisted.png|550px]]

'''Proposed Solution :'''
Since the same functionality of maintaining the waitlist is being done at multiple places, the code does not update for the manage assignments topic tab for the instructor. In order to fix this, implementation of a new waitlist object is done to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist and the same object will be consumed everywhere. Hence, the manage assignments topic will be updated automatically.

== Test Plan ==
This project entails code refactoring such that all functionality relevant to waitlist is easily available under one class. Focus is on ensuring existing tests work as expected as the newly added code will not impact functionality per se. However, new unit tests will be written for testing waitlist.rb independently. Furthermore, test cases for suggestion_controller.rb & signed_up_team.rb are missing in the current implementation. Hence, we will be adding spec files for the aforementioned files as well. Certain edge cases will also be tested which have not been covered by the current tests.

'''Test Files'''
# sign_up_topic_spec.rb
# invitation_spec.rb
# waitlist_spec.rb
# lottery_controller_spec.rb
# suggestion_controller_spec.rb
# signed_up_team_spec.rb
# student_teams_controller_spec.rb

'''Cases To Be Tested'''
# Add team to waitlist if topic isn't available.
# Push the first waitlisted member (if exists) in case a confirmed slot is deleted.
# Remove waitlists for team if a topic is confirmed.
# Clean waitlists & assign topic if the user has a team but not a topic.
# Remove old team from waitlists.

'''Automated Test Plan'''

Automated testing can be done using Capybara. Since a major part of the scenario can be tested using the UI, an automated test to create teams and sign up for topics can be created using Capybara with Cucumber. These tests can be written using the TDD approach prior to defining the code.

'''Code Coverage:''' Code coverage for the test cases can be obtained using the Code Coverage plugin and SimpleCov gem. The lines in the functions for which test cases are written in the corresponding spec file are highlighted in green and the rest of the lines are highlighted in red.

== References ==
# [https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.r80b3xxz9peq Problem Statement]
# [https://github.com/nehajaideep/expertiza Forked Repository]

== Team ==
* Ankit Singh (asingh072318)

* Asrita Kuchibhotla (kAsrita)

* Neha Kotcherlakota (nehajaideep)

* Vinit Desai (VinitDesai1998)

CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality

2021-11-09T21:48:02Z

Nkotche:

== About Expertiza ==
The [http://expertiza.ncsu.edu/ Expertiza] platform employs a divide-and-conquer strategy for creating reusable learning objects via active-learning exercises built entirely on [http://rubyonrails.org/ Ruby on Rails] framework. Students get to choose from a list of tasks to complete either individually or in teams. It also allows the instructor to create a list of topics the students can sign up for. They then prepare their work and submit it to a peer-review mechanism. On submission, other students can assess their peers work and provide feedback. Expertiza encourages students to collaborate in order to improve the learning experiences from one another. It aids their learning by making them translate what is taught in the lectures and apply those concepts to a real-world issue.

== Problem Statement ==
When a team requests a topic which is not available, the team is waitlisted for the topic, given that bidding is not in use for the assignment. When another team drops a topic, then a waitlisted team will be assigned the topic, if there are any teams waitlisted for it. Implement a waitlist object associated with each topic, and a team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉
Currently, the functionality relevant to waitlisting is scattered across the multiple files. These functions need to be consolidated and placed in a single class.

== Control Flow ==
In the current implementation, multiple models and controllers perform actions that indirectly affect the teams in the waitlist and require to be added or removed from the waitlist. Due to this the same redundant operations of modifying the waitlist is being performed by multiple models and controllers. In order to improve the functionality all the redundant operations being performed on the waitlist need to be moved to the 'waitlist.rb' file and all the other controllers and models will be utilising these methods to manipulate the waitlists.
Planned implementation: The Context object in our case the waitlist object delegates an algorithm to different Strategy objects to execute waitlist functions as shown below. The Context calls algorithm() on a Strategy1 object, which performs the algorithm and returns the result to Context.

'''Existing Control Flow'''
<br>
[[File:Block diagram waitlist current.png|850px]]

'''Modified Control Flow'''
<br>
[[File:Block diagram waitlist modified.png|850px]]

== Solution Approach ==

===Refactoring===
Goal of the project is to simplify waitlist functionality by moving all the functions manipulating waitlists to waitlist.rb, along with a WaitingTeam class that would consist of a 〈team_id, topic_id〉pair to store information regarding teams on waitlist for a particular topic. Classes should just invoke methods of waitlist.rb for the following functionality:
# Add themselves to waitlists
# Add another team to a waitlist
# Take a team off a waitlist
# Purge all waitlists of a specific team
# Clear a specific waitlist of all waiting teams

Introduce a waitlist object associated with each topic so that any team that requested it when it was not available would just be queued on the waitlist. The waitlist would just enqueue ordered pairs〈team_id, topic_id〉

===Design Pattern===
As we are decoupling the functionality manipulating waitlists that is scattered across various files and putting it all under a single class the design pattern opted for is Strategy Design Pattern. It is a behavioral design pattern that lets you define a family of algorithms, put each of them into a separate class, and make their objects interchangeable. The plan is to isolate the code, internal data, and dependencies of various algorithms related to waitlist from the rest of the code. Various clients now get a simple class to execute the algorithms and switch them at runtime.

'''Tentative list of files to be modified'''
# sign_up_topic.rb
# invitation.rb
# waitlist.rb
# lottery_controller.rb
# suggestion_controller.rb
# signed_up_team.rb
# student_teams_controller.rb

== UI Test Steps ==
* Step 1: Signup as an instructor and click on Manage Assignments

[[File:Manage assignments.png|550px]]
[[File:Add assignment.png|550px]]

* Step 2: Create an assignment with the required configurations and click on create.

[[File:Create assignment.png|550px]]

* Step 3: Post assignment creation, go to manage assignments, and edit the newly created assignment

[[File:Edit new assignment.png|550px]]

* Step 4: Selected the 'has topics' options and create new topics for the students to sign up using the topics tab.

[[File:Has_topics_assignment_option.png|550px]]
[[File:Create topics.png|550px]]

* Step 5: Add participants to the assignment using the participant tab and then assign the participants to teams using the teams tab and save the changes.

[[File:Add participants and teams.png|550px]]
[[File:Add teams.png|550px]]
[[File:Add participants.png|550px]]

* Step 6: Impersonate one student that you had added to one team in the previous step.

[[File:Impersonate user.png|550px]]

* Step 7: In the assignment tabs, choose the assignment that you had created in the previous step and click on sign-up sheet to sign up for a topic.

[[File:Signup_sheet.png|550px]]

* Step 8: Sign up for any topic of your choice. If it is available then you will be assigned the slot and the number of available slots will be updated.

[[File:Student7488 signup.png|550px]]
[[File:Student7488 signedup.png|550px]]

* Step 9: Impersonate as another student from another team that you had created for the same assignment in the previous steps and follow the same steps as mentioned above to sign up for a topic. Sign up for the same topic as the previously impersonated student.

[[File:Student431 signup.png|550px]]

* Step 10: You will now notice that since there was only one available slot and the previous team already signed up for it, the current team will be added to the waitlist for that topic.

[[File:Student 431 waitlisted.png|550px]]

* Step 11: You can also check the student currently assigned to a topic and the waitlisted students in the manage assignments tab on logging in as an instructor(As done in the previous steps)

[[File:Teams signedup waitlisted.png|550px]]

* Step 12: Following the above mentioned steps various scenarios can be tested via the UI like:
# Adding more topics
# Multiple teams signing up for the same topic
# Teams dropping topics etc.

'''In the current implemention the following issue exists which will be fixed:'''

'''Scenario 1:''' Assigned teams dropping topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist.

'''Current Issue :'''
The available slot after one team drops the topic does not update due to which the first team in the waitlist is not automatically assigned the topic.
[[File:Topic dropped.png|550px]]

'''Proposed Solution :'''
Implement a new waitlist object to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist.

'''Scenario 2:''' Instructor intervention when assigned teams drops topics

'''Expected Behaviour :'''
After one team signs up for a topic and the second team that signs up for the same topic is added to the waitlist, if the first team drops the topic, ideally the available slots should be updated and the second team should be assigned the topic since it is the first on the waitlist also we know that the manage topics tab while the instructor edits the assignment also contains the team that is currently assigned the topic and the list of waitlisted teams it should be updated when a change occurs.

'''Current Issue :'''
The instructor does not see in the manage assignments topics tab that the topic is not assigned to the first team once it chooses to drop it.
[[File:Teams signedup waitlisted.png|550px]]

'''Proposed Solution :'''
Since the same functionality of maintaining the waitlist is being done at multiple places, the code does not update for the manage assignments topic tab for the instructor. In order to fix this, implementation of a new waitlist object is done to maintain the list of topics and the teams in the waitlist as ordered pairs: 〈team_id, topic_id〉as soon as the first team drops the topic the team_id field will be updated to the second team since it is the first on the waitlist and the same object will be consumed everywhere. Hence, the manage assignments topic will be updated automatically.

== Test Plan ==
This project entails code refactoring such that all functionality relevant to waitlist is easily available under one class. Focus is on ensuring existing tests work as expected as the newly added code will not impact functionality per se. However, new unit tests will be written for testing waitlist.rb independently. Furthermore, test cases for suggestion_controller.rb & signed_up_team.rb are missing in the current implementation. Hence, we will be adding spec files for the aforementioned files as well. Certain edge cases will also be tested which have not been covered by the current tests.

'''Test Files'''
# sign_up_topic_spec.rb
# invitation_spec.rb
# waitlist_spec.rb
# lottery_controller_spec.rb
# suggestion_controller_spec.rb
# signed_up_team_spec.rb
# student_teams_controller_spec.rb

'''Cases To Be Tested'''
# Add team to waitlist if topic isn't available.
# Push the first waitlisted member (if exists) in case a confirmed slot is deleted.
# Remove waitlists for team if a topic is confirmed.
# Clean waitlists & assign topic if the user has a team but not a topic.
# Remove old team from waitlists.

== References ==
# [https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.r80b3xxz9peq Problem Statement]
# [https://github.com/nehajaideep/expertiza Forked Repository]

== Team ==
* Ankit Singh (asingh072318)

* Asrita Kuchibhotla (kAsrita)

* Neha Kotcherlakota (nehajaideep)

* Vinit Desai (VinitDesai1998)

File:Topic dropped.png

2021-11-09T21:36:11Z

Nkotche:

CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality

2021-11-09T08:26:28Z

Nkotche:

File:Teams signedup waitlisted.png

2021-11-09T08:20:30Z

Nkotche:

File:Add participants.png

2021-11-09T08:18:37Z

Nkotche: Nkotche uploaded a new version of File:Add participants.png

File:Add teams.png

2021-11-09T08:17:59Z

Nkotche:

File:Student 431 waitlisted.png

2021-11-09T07:56:45Z

Nkotche:

File:Student431 signup.png

2021-11-09T07:55:01Z

Nkotche: Nkotche uploaded a new version of File:Student431 signup.png

File:Student431 signup.png

2021-11-09T07:52:08Z

Nkotche: Nkotche uploaded a new version of File:Student431 signup.png

File:Student7488 signedup.png

2021-11-09T07:48:38Z

Nkotche:

File:Student7488 signup.png

2021-11-09T07:47:47Z

Nkotche:

File:Student431 signup.png

2021-11-09T07:43:46Z

Nkotche: Nkotche uploaded a new version of File:Student431 signup.png

File:Student431 signup.png

2021-11-09T07:38:44Z

Nkotche:

File:Signup sheet.png

2021-11-09T07:27:01Z

Nkotche:

File:Impersonate user.png

2021-11-09T07:23:33Z

Nkotche:

File:Add participants and teams.png

2021-11-09T06:35:42Z

Nkotche:

File:Create topics.png

2021-11-09T06:26:03Z

Nkotche: Nkotche uploaded a new version of File:Create topics.png

File:Create topics.png

2021-11-09T06:21:07Z

Nkotche:

File:Has topics assignment option.png

2021-11-09T06:13:35Z

Nkotche: Nkotche uploaded a new version of File:Has topics assignment option.png

File:Has topics assignment option.png

2021-11-09T06:13:30Z

Nkotche: Nkotche uploaded a new version of File:Has topics assignment option.png

File:Has topics assignment option.png

2021-11-09T06:11:55Z

Nkotche:

File:Has topics options assignment.png

2021-11-09T06:10:20Z

Nkotche:

File:Has topics options.png

2021-11-09T06:08:48Z

Nkotche:

File:Edit new assignment.png

2021-11-09T05:55:46Z

Nkotche:

File:Create assignment.png

2021-11-09T05:49:11Z

Nkotche: Nkotche uploaded a new version of File:Create assignment.png

File:Manage assignments.png

2021-11-09T04:30:19Z

Nkotche:

File:Add assignment.png

2021-11-09T04:29:30Z

Nkotche: Nkotche uploaded a new version of File:Add assignment.png

File:Add assignment.png

2021-11-09T04:27:23Z

Nkotche: Nkotche uploaded a new version of File:Add assignment.png

File:Add assignment.png

2021-11-09T04:22:05Z

Nkotche:

File:Block diagram waitlist current.png

2021-11-04T04:23:44Z

Nkotche: Nkotche uploaded a new version of File:Block diagram waitlist current.png

File:Block diagram waitlist current.png

2021-11-04T04:22:57Z

Nkotche: Nkotche uploaded a new version of File:Block diagram waitlist current.png

CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality

2021-11-04T04:16:06Z

Nkotche:

File:Block diagram waitlist current.png

2021-11-04T04:03:38Z

Nkotche:

File:Block diagram waitlist modified.png

2021-11-04T03:58:45Z

Nkotche: Nkotche uploaded a new version of File:Block diagram waitlist modified.png

File:Block diagram waitlist modified.png

2021-11-04T03:45:35Z

Nkotche:

CSC/ECE 517 Fall 2021 - E2131. Improve assessment360 controller.rb

2021-10-24T23:19:41Z

Nkotche: /* Code Improvement */

==E2131. Improving the Assessment 360 Controller==

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

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

* Improved the clarity of code by improving the variable and parameter names.
* Long character strings were taken and given appropriate names.
* Combined two views: Grade summary by student & Aggregate teammate and Meta Review to 1 page : All Students All Reviews.
* Added a new functionality for the user to customise the table to view relevant columns.
* Added RSPEC test cases for testing changes made in the Assessment360 Controller

===About Assessment 360 Controller===
This controller provides functionality for displaying course-level data, specifically, review averages, and for each student who is a course participant, a list of the projects they worked on and the grades that they received. The reason it is called “assessment 360” is because that’s a term that relates to evaluating performance by combining a lot of different perspectives into a single view. Its externally callable methods are all_students_all_reviews and course_student_grade_summary. I believe that all other methods are simply helper methods for these methods, but please check, because I’m not sure of it.

===Current Implementation===

=====Functionality=====
* Every course instructor that logs in to Expertiza should be able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course
* The instructor can navigate to 2 different views: all_students_all_review and course_student_grade_summary to view the scores.
* all_students_all_review view - Allows the instructor to view the teammate review and the meta review scores corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:
* course_student_grade_summary - Allows the instructor to view the peer review score, instructor grade corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:

====Drawbacks and Solutions=====
* '''Problem 1''': The instructor has to navigate to two different views to view the data regarding the scores of all the students enrolled in a particular course. The following are the issues caused due to 2 views:
* 1. Difficult to view consolidated data regarding student scores at one place.
* 2. Redundant columns
* all_students_all_review view
[[File:All students all reviews view.png|800px]]
<br>
* course_student_grade_summary
[[File:Course grade summary view.png|800px]]
<br>

* '''Solution''': The implementation has been changed in the following way to address the issues:
* One consolidated view is made : all_student_all_reviews which displays all the scores corresponding to each assignment for every student enrolled in a particular course
* No redundant columns exist since the entire data is consolidated in a single view.
* all_students_all_review view
[[File:Consolidated view.png|800px]]

* '''Problem 2''': Every course instructor that logs in to Expertiza is able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course in a tabular form in 2 different views. Although, it is difficult to view respective teammate and meta review scores on sorting by peer review scores or instructor grades and vice versa.
For example: The instructor cannot sort the peer review scores in the table based on the teammate reviews or the meta reviews since they are in 2 different views

* '''Solution''': The implementation has been modified such that an instructor can sort any column in the table and view respective data for other columns. This can be done since the entire data can now be seen in a single consolidated view.
<pre>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});

<table class="table table-striped sortable">
<thead>
<tr>
<th rowspan=2 width="320" class="noborder sorter-true">Students</th>
<th rowspan=2 width="30" class="noborder">Teammate Count</th>
<% @assignments.each do |assignment| %>
<th colspan="<%= @colspan %>" class="sorter-false"><%= assignment.name %> </th>
<% end %>
.....
</tr>
<tr>
<% @assignments.each do |assignment| %>
.......
</tr>
</thead>
...............
</table>
</pre>
* '''Problem 3''': Page loading time for all_student_all_reviews is extremely high since a network call is being made as soon as a user clicks on a link to navigate to that page.
<pre>
<table class="table table-striped">
<tr>
<th rowspan=2 width="320">Students</th>
.....
</tr>
<tr>
<% (0..@assignments.size).each do %>
<td><b>Metareviews</b></td>
<td><b>Teammate Reviews</b></td>
<% end %>
</tr>
<% @course_participants.each do |cp|%>
<tr>
.....
</tr>
<%end%>
<tr>
....
</tr>
</table>
</div>
</pre>
* Since there is no condition on rendering the entire view is loaded as soon as the user navigates to the page. This makes the page load extremely slow since the network call is made immediately on page load making it a bad user experience.
* '''Solution''': The implementation has been changed such that instructor can customise the table to only view the columns relevant to them and post selecting the network call is made. Due to this the page loads faster, as soon as the user clicks a link to navigate to the page.
<pre>
<div>
<%# This section renders the checkboxes and passes values to controller as different variables %>
<%= form_tag({:action => 'all_students_all_reviews'},{:method => :get}) %>
<p>Which field do you want to see?</p>
<div style="display: inline-flex;">
<p><input type="checkbox" name="show_topics" id="show_topics" value=true>Topics  </p>
<p><input type="checkbox" name="show_teammate_reviews" id="show_teammate_reviews" value=true>Teammate reviews  </p>
<p><input type="checkbox" name="show_meta_reviews" id="show_meta_reviews" value=true>Meta-reviews  </p>
<p><input type="checkbox" name="show_peer_scores" id="show_peer_scores" value=true>Peer scores  </p>
<p><input type="checkbox" name="show_instructor_grades" id="show_instructor_grades" value=true>Instructor grades </p>
</div>
<%= button_tag 'Go', value: @course_id, type: :submit, name: :course_id%>
</div>
<% if @render_partial %>
<%= render 'assessment' %>
<% end %>
</pre>
* The assessment view is rendered only if the render_partial variable is true. Due to this check, the all_students_all_reviews page loads faster on navigation since the network call is not made immediately. Instead it is made after a user action which makes it a better user experience.

===New Implementation===
* '''Consolidation of views''' - The 2 views all_students_all_review and course_student_grade_summary are now merged into 1 view: views all_students_all_review. This view can be accessed using the list icon from the Manage Courses page.
Navigation to the manage courses page:
* 1. Choose Manage on the navigation bar on the top of the screen.
* 2. Choose Courses from the list
[[File:Manage courses option.png|900px]]
* 3. Choose the list icon corresponding to the course for which you need to view the student score summary.
*Previous Implementation
   [[File:Two views.png|900px]]
<br>
*Modified Implementation
   [[File:One view.png|900px]]
* '''Customisation''' - New checkbox functionality is added which allows the instructor to customise the view by selecting from a list of columns and viewing only those that are relevant to them. Checkboxes for the following columns exist:
* 1. Topics
* 2. Teammate reviews
* 3. Meta reviews
* 4. Peer scores
* 5. Instructor grades
* The instructor can customise the table by selecting the any or all of the above mentioned columns and only view columns that are relevant to them.
[[File:Checkboxes option.png|900px]]
* '''Dynamic UI''' - A new functionality in the UI is added that ensures '''dynamic resizing''' of the table based on the number of columns to be displayed.
* '''UI Enhancement''' - The UI of the all_student_all_reviews page is enhanced for better user experience.

===Code Improvement===
* '''Implementation of partials''' - Refactoring of the code was done to ensure better readability by implementing partials.
<pre>
<%# Partial to render the table %>
.......
</style>

<script>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});
</script>

<table class="table table-striped sortable">
<thead>
<tr>
....
</tr>
<tr>
<% @assignments.each do |assignment| %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
<% if @show_topics%>
<th><b>Topic</b></th>
<% end %>
<% if @show_peer_scores %>
<th><b>Peer Score</b></th>
<% end %>
<% if @show_instructor_grades %>
<th><b>Instructor Grade</b></th>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<th class="sorter-true"><b>Total Instructor Grade</b></th>
<% end %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
</tr>
</thead>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
<tr>
<td><b>Class Average</b></td>
<td></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= "#{@overall_meta_review_grades[assignment.id] / @overall_meta_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= "#{@overall_teammate_review_grades[assignment.id] / @overall_teammate_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_topics%>
<td><%= "—" %></td>
<% end %>
<% if @show_peer_scores %>
<td><%= "—" %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% end%>
<% total_meta_review_grade = @overall_meta_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td>
<% end %>
<% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_teammate_reviews %>
<td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td>
<% end %>
</tr>
</table>
</pre>
* '''Code comments''' - Code comments for every new implementation are added to provide a better understanding and easier experience for developers viewing the code.
* '''Refactoring''' - Refactoring of the code is done by renaming certain variables based on the naming convention, choosing ideal names for all the newly added variables, removing unused code.
* 1. Removed the view - course_student_grade_summary
* 2. Replaced teamed_count to teammate count
* Previous code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teamed_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end%>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
</tr>
<%end%>
</pre>
* Modified code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
</pre>
* 3. Added variables names according to the naming convention
<pre>
@topics = {}
@assignment_grades = {}
@peer_review_scores = {}
@final_grades = {}
course = Course.find(params[:course_id])
@course_id = params[:course_id]
@assignments = course.assignments.reject(&:is_calibrated).reject {|a| a.participants.empty? }
@course_participants = course.get_participants
# variable to check if we have to render just the checkboxes or partials too
@render_partial = false
insure_existence_of(@course_participants,course)
# hashes for view
@meta_review = {}
@teammate_review = {}
@teammate_count = {}
# instance variables based on each checkbox
@show_teammate_reviews = params[:show_teammate_reviews] || false
@show_meta_reviews = params[:show_meta_reviews] || false
@show_peer_scores = params[:show_peer_scores] || false
@show_instructor_grades = params[:show_instructor_grades] || false
@show_topics = params[:show_topics] || false
@checkboxes_array = [@show_teammate_reviews,@show_meta_reviews,@show_peer_scores,@show_instructor_grades,@show_topics]
# number of columns to span for each assignment
@colspan = assignment_colspan @checkboxes_array
# number of columns to span for Aggregate Score table header
@colspan_review = review_colspan @checkboxes_array
# for course
# eg. @overall_teammate_review_grades = {assgt_id1: 100, assgt_id2: 178, ...}
# @overall_teammate_review_count = {assgt_id1: 1, assgt_id2: 2, ...}
# network calls to be done only when we need to render_partial
@render_partial = show_table? @checkboxes_array
</pre>
* '''Improved Performance''' - Improved the application performance by enhancing the user experience on navigation to the all_students_all_reviews page by changing when the network call should be made.
* '''Relevant Test Cases''' - Added relevant test cases for all the newly implemented code.

===Modified File===
* The following are the list of modified files:
* 1. assessment_360.controller.rb
* 2. course_student_grade_summary.html.erb - removed
* 3. all_students_all_review.html.erb - removed
* 4. tree_display.jsx
* 5. assessment360_controller_spec.rb

===Steps to run the application on your local===
* The following are the list of modified files:
* 1. git clone https://github.com/asingh072318/expertiza
* 2. cd expertiza
* 3. bash setup.sh [Linux or Unix]
* 4. bundle install
* 5. rake db:migrate
* 6. rails s

===Test Plan - TDD Approach===
Testing on the assessment 360 controller was done for the following cases:
* 1. '''Edge cases''' :
* When no score currently exists for a particular assignment.
* When an entire column does not exist for an assignment
* 2. '''Ideal case''':
* When there exists atleast one student with a score for every assignment.
* 3. '''Invalid Inputs''': Atleast one column needs to be selected by the user to view the table. No column selected is an invalid input case.

===Testing using RSPEC===
In the existing version of Expertiza there existed certain test cases for the Assessment360 controller.We have added an additional set of RSPEC tests for Assessment360 contoller, to test all the modifications made to the controller and have also removed the testcases corresponding to the code that was removed. The tests can be executed "rpec rspec spec/controllers/assessment360_controller_spec.rb" command as shown below.
<pre>
user-expertiza $rspec spec/controllers/assessment360_controller_spec.rb
Randomized with seed 52813
........................

Finished in 1 minute 36.91 seconds (files took 6.76 seconds to load)
24 examples, 0 failures

Randomized with seed 52813

</pre>

===Project Team===
* '''Mentor''' - Dr. Edward Gehringer
* '''Members'''
* 1. Neha Kotcherlakota
* 2. Ankit Singh
* 3. Supriya Krishna

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/asingh072318/expertiza GitHub Project Repository Fork]
#[http://152.7.176.208:3000/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2021 - E2131. Improve assessment360 controller.rb

2021-10-21T14:26:51Z

Nkotche:

==E2131. Improving the Assessment 360 Controller==

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

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

* Improved the clarity of code by improving the variable and parameter names.
* Long character strings were taken and given appropriate names.
* Combined two views: Grade summary by student & Aggregate teammate and Meta Review to 1 page : All Students All Reviews.
* Added a new functionality for the user to customise the table to view relevant columns.
* Added RSPEC test cases for testing changes made in the Assessment360 Controller

===About Assessment 360 Controller===
This controller provides functionality for displaying course-level data, specifically, review averages, and for each student who is a course participant, a list of the projects they worked on and the grades that they received. The reason it is called “assessment 360” is because that’s a term that relates to evaluating performance by combining a lot of different perspectives into a single view. Its externally callable methods are all_students_all_reviews and course_student_grade_summary. I believe that all other methods are simply helper methods for these methods, but please check, because I’m not sure of it.

===Current Implementation===

=====Functionality=====
* Every course instructor that logs in to Expertiza should be able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course
* The instructor can navigate to 2 different views: all_students_all_review and course_student_grade_summary to view the scores.
* all_students_all_review view - Allows the instructor to view the teammate review and the meta review scores corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:
* course_student_grade_summary - Allows the instructor to view the peer review score, instructor grade corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:

====Drawbacks and Solutions=====
* '''Problem 1''': The instructor has to navigate to two different views to view the data regarding the scores of all the students enrolled in a particular course. The following are the issues caused due to 2 views:
* 1. Difficult to view consolidated data regarding student scores at one place.
* 2. Redundant columns
* all_students_all_review view
[[File:All students all reviews view.png|800px]]
<br>
* course_student_grade_summary
[[File:Course grade summary view.png|800px]]
<br>

* '''Solution''': The implementation has been changed in the following way to address the issues:
* One consolidated view is made : all_student_all_reviews which displays all the scores corresponding to each assignment for every student enrolled in a particular course
* No redundant columns exist since the entire data is consolidated in a single view.
* all_students_all_review view
[[File:Consolidated view.png|800px]]

* '''Problem 2''': Every course instructor that logs in to Expertiza is able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course in a tabular form in 2 different views. Although, it is difficult to view respective teammate and meta review scores on sorting by peer review scores or instructor grades and vice versa.
For example: The instructor cannot sort the peer review scores in the table based on the teammate reviews or the meta reviews since they are in 2 different views

* '''Solution''': The implementation has been modified such that an instructor can sort any column in the table and view respective data for other columns. This can be done since the entire data can now be seen in a single consolidated view.
<pre>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});

<table class="table table-striped sortable">
<thead>
<tr>
<th rowspan=2 width="320" class="noborder sorter-true">Students</th>
<th rowspan=2 width="30" class="noborder">Teammate Count</th>
<% @assignments.each do |assignment| %>
<th colspan="<%= @colspan %>" class="sorter-false"><%= assignment.name %> </th>
<% end %>
.....
</tr>
<tr>
<% @assignments.each do |assignment| %>
.......
</tr>
</thead>
...............
</table>
</pre>
* '''Problem 3''': Page loading time for all_student_all_reviews is extremely high since a network call is being made as soon as a user clicks on a link to navigate to that page.
<pre>
<table class="table table-striped">
<tr>
<th rowspan=2 width="320">Students</th>
.....
</tr>
<tr>
<% (0..@assignments.size).each do %>
<td><b>Metareviews</b></td>
<td><b>Teammate Reviews</b></td>
<% end %>
</tr>
<% @course_participants.each do |cp|%>
<tr>
.....
</tr>
<%end%>
<tr>
....
</tr>
</table>
</div>
</pre>
* Since there is no condition on rendering the entire view is loaded as soon as the user navigates to the page. This makes the page load extremely slow since the network call is made immediately on page load making it a bad user experience.
* '''Solution''': The implementation has been changed such that instructor can customise the table to only view the columns relevant to them and post selecting the network call is made. Due to this the page loads faster, as soon as the user clicks a link to navigate to the page.
<pre>
<div>
<%# This section renders the checkboxes and passes values to controller as different variables %>
<%= form_tag({:action => 'all_students_all_reviews'},{:method => :get}) %>
<p>Which field do you want to see?</p>
<div style="display: inline-flex;">
<p><input type="checkbox" name="show_topics" id="show_topics" value=true>Topics  </p>
<p><input type="checkbox" name="show_teammate_reviews" id="show_teammate_reviews" value=true>Teammate reviews  </p>
<p><input type="checkbox" name="show_meta_reviews" id="show_meta_reviews" value=true>Meta-reviews  </p>
<p><input type="checkbox" name="show_peer_scores" id="show_peer_scores" value=true>Peer scores  </p>
<p><input type="checkbox" name="show_instructor_grades" id="show_instructor_grades" value=true>Instructor grades </p>
</div>
<%= button_tag 'Go', value: @course_id, type: :submit, name: :course_id%>
</div>
<% if @render_partial %>
<%= render 'assessment' %>
<% end %>
</pre>
* The assessment view is rendered only if the render_partial variable is true. Due to this check, the all_students_all_reviews page loads faster on navigation since the network call is not made immediately. Instead it is made after a user action which makes it a better user experience.

===New Implementation===
* '''Consolidation of views''' - The 2 views all_students_all_review and course_student_grade_summary are now merged into 1 view: views all_students_all_review. This view can be accessed using the list icon from the Manage Courses page.
Navigation to the manage courses page:
* 1. Choose Manage on the navigation bar on the top of the screen.
* 2. Choose Courses from the list
[[File:Manage courses option.png|900px]]
* 3. Choose the list icon corresponding to the course for which you need to view the student score summary.
*Previous Implementation
   [[File:Two views.png|900px]]
<br>
*Modified Implementation
   [[File:One view.png|900px]]
* '''Customisation''' - New checkbox functionality is added which allows the instructor to customise the view by selecting from a list of columns and viewing only those that are relevant to them. Checkboxes for the following columns exist:
* 1. Topics
* 2. Teammate reviews
* 3. Meta reviews
* 4. Peer scores
* 5. Instructor grades
* The instructor can customise the table by selecting the any or all of the above mentioned columns and only view columns that are relevant to them.
[[File:Checkboxes option.png|900px]]
* '''Dynamic UI''' - A new functionality in the UI is added that ensures '''dynamic resizing''' of the table based on the number of columns to be displayed.
* '''UI Enhancement''' - The UI of the all_student_all_reviews page is enhanced for better user experience.

===Code Improvement===
* '''Implementation of partials''' - Refactoring of the code was done to ensure better readability by implementing partials.
<pre>
<%# Partial to render the table %>
<%# Format of table %>
<%# | Assignment1 | Assignment2 | Assignment3 | Final Grades | Aggregate Score %>
<%# Students Teammate_Count |Metareview Teammate_review Topic Peer Instructor | | | Total Inst Grade | Metareview | Teammate Review %>
<%# s1 | | | | | | %>
<%# s2 | | | | | | %>
<%# Class_Average | x% y% N/A N/A N/A | | | N/A | x'% | y'% %>
<style>
.......
</style>

<script>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});
</script>

<table class="table table-striped sortable">
<thead>
<tr>
....
</tr>
<tr>
<% @assignments.each do |assignment| %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
<% if @show_topics%>
<th><b>Topic</b></th>
<% end %>
<% if @show_peer_scores %>
<th><b>Peer Score</b></th>
<% end %>
<% if @show_instructor_grades %>
<th><b>Instructor Grade</b></th>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<th class="sorter-true"><b>Total Instructor Grade</b></th>
<% end %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
</tr>
</thead>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
<tr>
<td><b>Class Average</b></td>
<td></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= "#{@overall_meta_review_grades[assignment.id] / @overall_meta_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= "#{@overall_teammate_review_grades[assignment.id] / @overall_teammate_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_topics%>
<td><%= "—" %></td>
<% end %>
<% if @show_peer_scores %>
<td><%= "—" %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% end%>
<% total_meta_review_grade = @overall_meta_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td>
<% end %>
<% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_teammate_reviews %>
<td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td>
<% end %>
</tr>
</table>
</pre>
* '''Code comments''' - Code comments for every new implementation are added to provide a better understanding and easier experience for developers viewing the code.
* '''Refactoring''' - Refactoring of the code is done by renaming certain variables based on the naming convention, choosing ideal names for all the newly added variables, removing unused code.
* 1. Removed the view - course_student_grade_summary
* 2. Replaced teamed_count to teammate count
* Previous code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teamed_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end%>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
</tr>
<%end%>
</pre>
* Modified code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
</pre>
* 3. Added variables names according to the naming convention
<pre>
@topics = {}
@assignment_grades = {}
@peer_review_scores = {}
@final_grades = {}
course = Course.find(params[:course_id])
@course_id = params[:course_id]
@assignments = course.assignments.reject(&:is_calibrated).reject {|a| a.participants.empty? }
@course_participants = course.get_participants
# variable to check if we have to render just the checkboxes or partials too
@render_partial = false
insure_existence_of(@course_participants,course)
# hashes for view
@meta_review = {}
@teammate_review = {}
@teammate_count = {}
# instance variables based on each checkbox
@show_teammate_reviews = params[:show_teammate_reviews] || false
@show_meta_reviews = params[:show_meta_reviews] || false
@show_peer_scores = params[:show_peer_scores] || false
@show_instructor_grades = params[:show_instructor_grades] || false
@show_topics = params[:show_topics] || false
@checkboxes_array = [@show_teammate_reviews,@show_meta_reviews,@show_peer_scores,@show_instructor_grades,@show_topics]
# number of columns to span for each assignment
@colspan = assignment_colspan @checkboxes_array
# number of columns to span for Aggregate Score table header
@colspan_review = review_colspan @checkboxes_array
# for course
# eg. @overall_teammate_review_grades = {assgt_id1: 100, assgt_id2: 178, ...}
# @overall_teammate_review_count = {assgt_id1: 1, assgt_id2: 2, ...}
# network calls to be done only when we need to render_partial
@render_partial = show_table? @checkboxes_array
</pre>
* '''Improved Performance''' - Improved the application performance by enhancing the user experience on navigation to the all_students_all_reviews page by changing when the network call should be made.
* '''Relevant Test Cases''' - Added relevant test cases for all the newly implemented code.

===Modified File===
* The following are the list of modified files:
* 1. assessment_360.controller.rb
* 2. course_student_grade_summary.html.erb - removed
* 3. all_students_all_review.html.erb - removed
* 4. tree_display.jsx
* 5. assessment360_controller_spec.rb

===Steps to run the application on your local===
* The following are the list of modified files:
* 1. git clone https://github.com/asingh072318/expertiza
* 2. cd expertiza
* 3. bash setup.sh [Linux or Unix]
* 4. bundle install
* 5. rake db:migrate
* 6. rails s

===Test Plan - TDD Approach===
Testing on the assessment 360 controller was done for the following cases:
* 1. '''Edge cases''' :
* When no score currently exists for a particular assignment.
* When an entire column does not exist for an assignment
* 2. '''Ideal case''':
* When there exists atleast one student with a score for every assignment.
* 3. '''Invalid Inputs''': Atleast one column needs to be selected by the user to view the table. No column selected is an invalid input case.

===Testing using RSPEC===
In the existing version of Expertiza there existed certain test cases for the Assessment360 controller.We have added an additional set of RSPEC tests for Assessment360 contoller, to test all the modifications made to the controller and have also removed the testcases corresponding to the code that was removed. The tests can be executed "rpec rspec spec/controllers/assessment360_controller_spec.rb" command as shown below.
<pre>
user-expertiza $rspec spec/controllers/assessment360_controller_spec.rb
Randomized with seed 52813
........................

Finished in 1 minute 36.91 seconds (files took 6.76 seconds to load)
24 examples, 0 failures

Randomized with seed 52813

</pre>

===Project Team===
* '''Mentor''' - Dr. Edward Gehringer
* '''Members'''
* 1. Neha Kotcherlakota
* 2. Ankit Singh
* 3. Supriya Krishna

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/asingh072318/expertiza GitHub Project Repository Fork]
#[http://152.7.176.208:3000/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2021 - E2131. Improve assessment360 controller.rb

2021-10-21T14:26:15Z

Nkotche:

==E2131. Improving the Assessment 360 Controller==

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

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

* Improved the clarity of code by improving the variable and parameter names.
* Long character strings were taken and given appropriate names.
* Combined two views: Grade summary by student & Aggregate teammate and Meta Review to 1 page : All Students All Reviews.
* Added a new functionality for the user to customise the table to view relevant columns.
* Added RSPEC test cases for testing changes made in the Assessment360 Controller

===About Assessment 360 Controller===
This controller provides functionality for displaying course-level data, specifically, review averages, and for each student who is a course participant, a list of the projects they worked on and the grades that they received. The reason it is called “assessment 360” is because that’s a term that relates to evaluating performance by combining a lot of different perspectives into a single view. Its externally callable methods are all_students_all_reviews and course_student_grade_summary. I believe that all other methods are simply helper methods for these methods, but please check, because I’m not sure of it.

===Current Implementation===

=====Functionality=====
* Every course instructor that logs in to Expertiza should be able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course
* The instructor can navigate to 2 different views: all_students_all_review and course_student_grade_summary to view the scores.
* all_students_all_review view - Allows the instructor to view the teammate review and the meta review scores corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:
* course_student_grade_summary - Allows the instructor to view the peer review score, instructor grade corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:

====Drawbacks and Solutions=====
* '''Problem 1''': The instructor has to navigate to two different views to view the data regarding the scores of all the students enrolled in a particular course. The following are the issues caused due to 2 views:
* 1. Difficult to view consolidated data regarding student scores at one place.
* 2. Redundant columns
* all_students_all_review view
[[File:All students all reviews view.png|800px]]
<br>
* course_student_grade_summary
[[File:Course grade summary view.png|800px]]
<br>

* '''Solution''': The implementation has been changed in the following way to address the issues:
* One consolidated view is made : all_student_all_reviews which displays all the scores corresponding to each assignment for every student enrolled in a particular course
* No redundant columns exist since the entire data is consolidated in a single view.
* all_students_all_review view
[[File:Consolidated view.png|800px]]

* '''Problem 2''': Every course instructor that logs in to Expertiza is able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course in a tabular form in 2 different views. Although, it is difficult to view respective teammate and meta review scores on sorting by peer review scores or instructor grades and vice versa.
For example: The instructor cannot sort the peer review scores in the table based on the teammate reviews or the meta reviews since they are in 2 different views

* '''Solution''': The implementation has been modified such that an instructor can sort any column in the table and view respective data for other columns. This can be done since the entire data can now be seen in a single consolidated view.
<pre>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});

<table class="table table-striped sortable">
<thead>
<tr>
<th rowspan=2 width="320" class="noborder sorter-true">Students</th>
<th rowspan=2 width="30" class="noborder">Teammate Count</th>
<% @assignments.each do |assignment| %>
<th colspan="<%= @colspan %>" class="sorter-false"><%= assignment.name %> </th>
<% end %>
.....
</tr>
<tr>
<% @assignments.each do |assignment| %>
.......
</tr>
</thead>
...............
</table>
</pre>
* '''Problem 3''': Page loading time for all_student_all_reviews is extremely high since a network call is being made as soon as a user clicks on a link to navigate to that page.
<pre>
<table class="table table-striped">
<tr>
<th rowspan=2 width="320">Students</th>
.....
</tr>
<tr>
<% (0..@assignments.size).each do %>
<td><b>Metareviews</b></td>
<td><b>Teammate Reviews</b></td>
<% end %>
</tr>
<% @course_participants.each do |cp|%>
<tr>
.....
</tr>
<%end%>
<tr>
....
</tr>
</table>
</div>
</pre>
* Since there is no condition on rendering the entire view is loaded as soon as the user navigates to the page. This makes the page load extremely slow since the network call is made immediately on page load making it a bad user experience.
* '''Solution''': The implementation has been changed such that instructor can customise the table to only view the columns relevant to them and post selecting the network call is made. Due to this the page loads faster, as soon as the user clicks a link to navigate to the page.
<pre>
<div>
<%# This section renders the checkboxes and passes values to controller as different variables %>
<%= form_tag({:action => 'all_students_all_reviews'},{:method => :get}) %>
<p>Which field do you want to see?</p>
<div style="display: inline-flex;">
<p><input type="checkbox" name="show_topics" id="show_topics" value=true>Topics  </p>
<p><input type="checkbox" name="show_teammate_reviews" id="show_teammate_reviews" value=true>Teammate reviews  </p>
<p><input type="checkbox" name="show_meta_reviews" id="show_meta_reviews" value=true>Meta-reviews  </p>
<p><input type="checkbox" name="show_peer_scores" id="show_peer_scores" value=true>Peer scores  </p>
<p><input type="checkbox" name="show_instructor_grades" id="show_instructor_grades" value=true>Instructor grades </p>
</div>
<%= button_tag 'Go', value: @course_id, type: :submit, name: :course_id%>
</div>
<% if @render_partial %>
<%= render 'assessment' %>
<% end %>
</pre>
* The assessment view is rendered only if the render_partial variable is true. Due to this check, the all_students_all_reviews page loads faster on navigation since the network call is not made immediately. Instead it is made after a user action which makes it a better user experience.

===New Implementation===
* '''Consolidation of views''' - The 2 views all_students_all_review and course_student_grade_summary are now merged into 1 view: views all_students_all_review. This view can be accessed using the list icon from the Manage Courses page.
Navigation to the manage courses page:
* 1. Choose Manage on the navigation bar on the top of the screen.
* 2. Choose Courses from the list
[[File:Manage courses option.png|900px]]
* 3. Choose the list icon corresponding to the course for which you need to view the student score summary.
*Previous Implementation
   [[File:Two views.png|900px]]
<br>
*Modified Implementation
   [[File:One view.png|900px]]
* '''Customisation''' - New checkbox functionality is added which allows the instructor to customise the view by selecting from a list of columns and viewing only those that are relevant to them. Checkboxes for the following columns exist:
* 1. Topics
* 2. Teammate reviews
* 3. Meta reviews
* 4. Peer scores
* 5. Instructor grades
* The instructor can customise the table by selecting the any or all of the above mentioned columns and only view columns that are relevant to them.
[[File:Checkboxes option.png|900px]]
* '''Dynamic UI''' - A new functionality in the UI is added that ensures '''dynamic resizing''' of the table based on the number of columns to be displayed.
* '''UI Enhancement''' - The UI of the all_student_all_reviews page is enhanced for better user experience.

===Code Improvement===
* '''Implementation of partials''' - Refactoring of the code was done to ensure better readability by implementing partials.
<pre>
<%# Partial to render the table %>
<%# Format of table %>
<%# | Assignment1 | Assignment2 | Assignment3 | Final Grades | Aggregate Score %>
<%# Students Teammate_Count |Metareview Teammate_review Topic Peer Instructor | | | Total Inst Grade | Metareview | Teammate Review %>
<%# s1 | | | | | | %>
<%# s2 | | | | | | %>
<%# Class_Average | x% y% N/A N/A N/A | | | N/A | x'% | y'% %>
<style>
.......
</style>

<script>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});
</script>

<table class="table table-striped sortable">
<thead>
<tr>
....
</tr>
<tr>
<% @assignments.each do |assignment| %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
<% if @show_topics%>
<th><b>Topic</b></th>
<% end %>
<% if @show_peer_scores %>
<th><b>Peer Score</b></th>
<% end %>
<% if @show_instructor_grades %>
<th><b>Instructor Grade</b></th>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<th class="sorter-true"><b>Total Instructor Grade</b></th>
<% end %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
</tr>
</thead>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
<tr>
<td><b>Class Average</b></td>
<td></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= "#{@overall_meta_review_grades[assignment.id] / @overall_meta_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= "#{@overall_teammate_review_grades[assignment.id] / @overall_teammate_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_topics%>
<td><%= "—" %></td>
<% end %>
<% if @show_peer_scores %>
<td><%= "—" %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% end%>
<% total_meta_review_grade = @overall_meta_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td>
<% end %>
<% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_teammate_reviews %>
<td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td>
<% end %>
</tr>
</table>
</pre>
* '''Code comments''' - Code comments for every new implementation are added to provide a better understanding and easier experience for developers viewing the code.
* '''Refactoring''' - Refactoring of the code is done by renaming certain variables based on the naming convention, choosing ideal names for all the newly added variables, removing unused code.
* 1. Removed the view - course_student_grade_summary
* 2. Replaced teamed_count to teammate count
* Previous code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teamed_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end%>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
</tr>
<%end%>
</pre>
* Modified code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
</pre>
* 3. Added variables names according to the naming convention
<pre>
@topics = {}
@assignment_grades = {}
@peer_review_scores = {}
@final_grades = {}
course = Course.find(params[:course_id])
@course_id = params[:course_id]
@assignments = course.assignments.reject(&:is_calibrated).reject {|a| a.participants.empty? }
@course_participants = course.get_participants
# variable to check if we have to render just the checkboxes or partials too
@render_partial = false
insure_existence_of(@course_participants,course)
# hashes for view
@meta_review = {}
@teammate_review = {}
@teammate_count = {}
# instance variables based on each checkbox
@show_teammate_reviews = params[:show_teammate_reviews] || false
@show_meta_reviews = params[:show_meta_reviews] || false
@show_peer_scores = params[:show_peer_scores] || false
@show_instructor_grades = params[:show_instructor_grades] || false
@show_topics = params[:show_topics] || false
@checkboxes_array = [@show_teammate_reviews,@show_meta_reviews,@show_peer_scores,@show_instructor_grades,@show_topics]
# number of columns to span for each assignment
@colspan = assignment_colspan @checkboxes_array
# number of columns to span for Aggregate Score table header
@colspan_review = review_colspan @checkboxes_array
# for course
# eg. @overall_teammate_review_grades = {assgt_id1: 100, assgt_id2: 178, ...}
# @overall_teammate_review_count = {assgt_id1: 1, assgt_id2: 2, ...}
# network calls to be done only when we need to render_partial
@render_partial = show_table? @checkboxes_array
</pre>
* '''Improved Performance''' - Improved the application performance by enhancing the user experience on navigation to the all_students_all_reviews page by changing when the network call should be made.
* '''Relevant Test Cases''' - Added relevant test cases for all the newly implemented code.

===Modified File===
* The following are the list of modified files:
* 1. assessment_360.controller.rb
* 2. course_student_grade_summary.html.erb - removed
* 3. all_students_all_review.html.erb - removed
* 4. tree_display.jsx
* 5. assessment360_controller_spec.rb

===Steps to run the application on your local===
* The following are the list of modified files:
* 1. git clone https://github.com/asingh072318/expertiza
* 2. cd expertiza
* 3. bash setup.sh [Linux or Unix]
* 4. bundle install
* 5. rake db:migrate
* 6. rails s

===Test Plan - TDD Approach===
Testing on the assessment 360 controller was done for the following cases:
* 1. '''Edge cases''' :
* When no score currently exists for a particular assignment.
* When an entire column does not exist for an assignment
* 2. '''Ideal case''':
* When there exists atleast one student with a score for every assignment.
* 3. '''Invalid Inputs''': Atleast one column needs to be selected by the user to view the table. No column selected is an invalid input case.

===Testing using RSPEC===
In the existing version of Expertiza there existed certain test cases for the Assessment360 controller.We have added an additional set of RSPEC tests for Assessment360 contoller, to test all the modifications made to the controller and have also removed the testcases corresponding to the code that was removed. The tests can be executed "rpec rspec spec/controllers/assessment360_controller_spec.rb" command as shown below.
<pre>
user-expertiza $rspec spec/controllers/assessment360_controller_spec.rb
Randomized with seed 52813
........................

Finished in 1 minute 36.91 seconds (files took 6.76 seconds to load)
24 examples, 0 failures

Randomized with seed 52813

</pre>

===Project Team===
* '''Mentor''' - Dr. Edward Gehringer
* '''Members'''
* 1. Neha Kotcherlakota
* 2. Ankit Singh
* 3. Supriya Krishna

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/asingh072318/expertiza GitHub Project Repository Fork]
#[http://152.7.176.208:3000/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2021 - E2131. Improve assessment360 controller.rb

2021-10-21T00:17:52Z

Nkotche: Created page with "==E2131. Improving the Assessment 360 Controller== This page provides a description of the Expertiza based OSS project. __TOC__ ===About Expertiza=== [http://expertiza...."

==E2131. Improving the Assessment 360 Controller==

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

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

* Improved the clarity of code by improving the variable and parameter names.
* Long character strings were taken and given appropriate names.
* Combined two views: Grade summary by student & Aggregate teammate and Meta Review to 1 page : All Students All Reviews.
* Added a new functionality for the user to customise the table to view relevant columns.
* Added RSPEC test cases for testing changes made in the Assessment360 Controller

===About Assessment 360 Controller===
This controller provides functionality for displaying course-level data, specifically, review averages, and for each student who is a course participant, a list of the projects they worked on and the grades that they received. The reason it is called “assessment 360” is because that’s a term that relates to evaluating performance by combining a lot of different perspectives into a single view. Its externally callable methods are all_students_all_reviews and course_student_grade_summary. I believe that all other methods are simply helper methods for these methods, but please check, because I’m not sure of it.

===Current Implementation===

=====Functionality=====
* Every course instructor that logs in to Expertiza should be able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course
* The instructor can navigate to 2 different views: all_students_all_review and course_student_grade_summary to view the scores.
* all_students_all_review view - Allows the instructor to view the teammate review and the meta review scores corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:
* course_student_grade_summary - Allows the instructor to view the peer review score, instructor grade corresponding to each assignment of every student enrolled in a particular course in a tabular form. These details can be viewed along with details like:

====Drawbacks and Solutions=====
* '''Problem 1''': The instructor has to navigate to two different views to view the data regarding the scores of all the students enrolled in a particular course. The following are the issues caused due to 2 views:
* 1. Difficult to view consolidated data regarding student scores at one place.
* 2. Redundant columns
* all_students_all_review view
[[File:All students all reviews view.png|800px]]
<br>
* course_student_grade_summary
[[File:Course grade summary view.png|800px]]
<br>

* '''Solution''': The implementation has been changed in the following way to address the issues:
* One consolidated view is made : all_student_all_reviews which displays all the scores corresponding to each assignment for every student enrolled in a particular course
* No redundant columns exist since the entire data is consolidated in a single view.
* all_students_all_review view
[[File:Consolidated view.png|800px]]

* '''Problem 2''': Every course instructor that logs in to Expertiza is able to view the course grade summary and the teammate and meta review scores corresponding to each assignment for all the students enrolled in a particular course in a tabular form in 2 different views. Although, it is difficult to view respective teammate and meta review scores on sorting by peer review scores or instructor grades and vice versa.
For example: The instructor cannot sort the peer review scores in the table based on the teammate reviews or the meta reviews since they are in 2 different views

* '''Solution''': The implementation has been modified such that an instructor can sort any column in the table and view respective data for other columns. This can be done since the entire data can now be seen in a single consolidated view.
<pre>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});

<table class="table table-striped sortable">
<thead>
<tr>
<th rowspan=2 width="320" class="noborder sorter-true">Students</th>
<th rowspan=2 width="30" class="noborder">Teammate Count</th>
<% @assignments.each do |assignment| %>
<th colspan="<%= @colspan %>" class="sorter-false"><%= assignment.name %> </th>
<% end %>
.....
</tr>
<tr>
<% @assignments.each do |assignment| %>
.......
</tr>
</thead>
...............
</table>
</pre>
* '''Problem 3''': Page loading time for all_student_all_reviews is extremely high since a network call is being made as soon as a user clicks on a link to navigate to that page.
<pre>
<table class="table table-striped">
<tr>
<th rowspan=2 width="320">Students</th>
.....
</tr>
<tr>
<% (0..@assignments.size).each do %>
<td><b>Metareviews</b></td>
<td><b>Teammate Reviews</b></td>
<% end %>
</tr>
<% @course_participants.each do |cp|%>
<tr>
.....
</tr>
<%end%>
<tr>
....
</tr>
</table>
</div>
</pre>
* Since there is no condition on rendering the entire view is loaded as soon as the user navigates to the page. This makes the page load extremely slow since the network call is made immediately on page load making it a bad user experience.
* '''Solution''': The implementation has been changed such that instructor can customise the table to only view the columns relevant to them and post selecting the network call is made. Due to this the page loads faster, as soon as the user clicks a link to navigate to the page.
<pre>
<div>
<%# This section renders the checkboxes and passes values to controller as different variables %>
<%= form_tag({:action => 'all_students_all_reviews'},{:method => :get}) %>
<p>Which field do you want to see?</p>
<div style="display: inline-flex;">
<p><input type="checkbox" name="show_topics" id="show_topics" value=true>Topics  </p>
<p><input type="checkbox" name="show_teammate_reviews" id="show_teammate_reviews" value=true>Teammate reviews  </p>
<p><input type="checkbox" name="show_meta_reviews" id="show_meta_reviews" value=true>Meta-reviews  </p>
<p><input type="checkbox" name="show_peer_scores" id="show_peer_scores" value=true>Peer scores  </p>
<p><input type="checkbox" name="show_instructor_grades" id="show_instructor_grades" value=true>Instructor grades </p>
</div>
<%= button_tag 'Go', value: @course_id, type: :submit, name: :course_id%>
</div>
<% if @render_partial %>
<%= render 'assessment' %>
<% end %>
</pre>
* The assessment view is rendered only if the render_partial variable is true. Due to this check, the all_students_all_reviews page loads faster on navigation since the network call is not made immediately. Instead it is made after a user action which makes it a better user experience.

===New Implementation===
* '''Consolidation of views''' - The 2 views all_students_all_review and course_student_grade_summary are now merged into 1 view: views all_students_all_review. This view can be accessed using the list icon from the Manage Courses page.
Navigation to the manage courses page:
* 1. Choose Manage on the navigation bar on the top of the screen.
* 2. Choose Courses from the list
[[File:Manage courses option.png|900px]]
* 3. Choose the list icon corresponding to the course for which you need to view the student score summary.
*Previous Implementation
   [[File:Two views.png|900px]]
<br>
*Modified Implementation
   [[File:One view.png|900px]]
* '''Customisation''' - New checkbox functionality is added which allows the instructor to customise the view by selecting from a list of columns and viewing only those that are relevant to them. Checkboxes for the following columns exist:
* 1. Topics
* 2. Teammate reviews
* 3. Meta reviews
* 4. Peer scores
* 5. Instructor grades
* The instructor can customise the table by selecting the any or all of the above mentioned columns and only view columns that are relevant to them.
[[File:Checkboxes option.png|900px]]
* '''Dynamic UI''' - A new functionality in the UI is added that ensures '''dynamic resizing''' of the table based on the number of columns to be displayed.
* '''UI Enhancement''' - The UI of the all_student_all_reviews page is enhanced for better user experience.

===Code Improvement===
* '''Implementation of partials''' - Refactoring of the code was done to ensure better readability by implementing partials.
<pre>
<%# Partial to render the table %>
<%# Format of table %>
<%# | Assignment1 | Assignment2 | Assignment3 | Final Grades | Aggregate Score %>
<%# Students Teammate_Count |Metareview Teammate_review Topic Peer Instructor | | | Total Inst Grade | Metareview | Teammate Review %>
<%# s1 | | | | | | %>
<%# s2 | | | | | | %>
<%# Class_Average | x% y% N/A N/A N/A | | | N/A | x'% | y'% %>
<style>
.......
</style>

<script>
$(function() {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] // sort by Student name
});
});
</script>

<table class="table table-striped sortable">
<thead>
<tr>
....
</tr>
<tr>
<% @assignments.each do |assignment| %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
<% if @show_topics%>
<th><b>Topic</b></th>
<% end %>
<% if @show_peer_scores %>
<th><b>Peer Score</b></th>
<% end %>
<% if @show_instructor_grades %>
<th><b>Instructor Grade</b></th>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<th class="sorter-true"><b>Total Instructor Grade</b></th>
<% end %>
<% if @show_meta_reviews %>
<th><b>Metareviews</b></th>
<% end %>
<% if @show_teammate_reviews %>
<th><b>Teammate Reviews</b></th>
<% end %>
</tr>
</thead>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
<tr>
<td><b>Class Average</b></td>
<td></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= "#{@overall_meta_review_grades[assignment.id] / @overall_meta_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= "#{@overall_teammate_review_grades[assignment.id] / @overall_teammate_review_count[assignment.id]}%" %></td>
<% end %>
<% if @show_topics%>
<td><%= "—" %></td>
<% end %>
<% if @show_peer_scores %>
<td><%= "—" %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% end%>
<% total_meta_review_grade = @overall_meta_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_instructor_grades %>
<td><%= "—" %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td>
<% end %>
<% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %>
<% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %>
<% if @show_teammate_reviews %>
<td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td>
<% end %>
</tr>
</table>
</pre>
* '''Code comments''' - Code comments for every new implementation are added to provide a better understanding and easier experience for developers viewing the code.
* '''Refactoring''' - Refactoring of the code is done by renaming certain variables based on the naming convention, choosing ideal names for all the newly added variables, removing unused code.
* 1. Removed the view - course_student_grade_summary
* 2. Replaced teamed_count to teammate count
* Previous code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teamed_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end%>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
</tr>
<%end%>
</pre>
* Modified code
<pre>
<% @course_participants.each do |cp|%>
<tr>
<td align="center"><%= "#{cp.name(session[:ip])} (#{cp.fullname(session[:ip])})" %> </td>
<td><%= @teammate_count[cp.id] %></td>
<% @assignments.each do |assignment|%>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][assignment.id] %></td>
<% end %>
<% if @show_topics%>
<% topic = format_topic(@topics[cp.id][assignment.id]) %>
<td title="<%= topic %>" class="topic topic-tooltip">
<%= topic %>
</td>
<% end %>
<% if @show_peer_scores %>
<td><%= format_score(@peer_review_scores[cp.id][assignment.id]) %></td>
<% end %>
<% if @show_instructor_grades %>
<td><%= format_score(@assignment_grades[cp.id][assignment.id]) %> </td>
<% end %>
<% end %>
<% if @show_instructor_grades %>
<td><%= @final_grades[cp.id] %></td>
<% end %>
<% if @show_meta_reviews %>
<td><%= @meta_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
<% if @show_teammate_reviews %>
<td><%= @teammate_review[cp.id][:avg_grade_for_assgt] %></td>
<% end %>
</tr>
<% end %>
</pre>
* 3. Added variables names according to the naming convention
<pre>
@topics = {}
@assignment_grades = {}
@peer_review_scores = {}
@final_grades = {}
course = Course.find(params[:course_id])
@course_id = params[:course_id]
@assignments = course.assignments.reject(&:is_calibrated).reject {|a| a.participants.empty? }
@course_participants = course.get_participants
# variable to check if we have to render just the checkboxes or partials too
@render_partial = false
insure_existence_of(@course_participants,course)
# hashes for view
@meta_review = {}
@teammate_review = {}
@teammate_count = {}
# instance variables based on each checkbox
@show_teammate_reviews = params[:show_teammate_reviews] || false
@show_meta_reviews = params[:show_meta_reviews] || false
@show_peer_scores = params[:show_peer_scores] || false
@show_instructor_grades = params[:show_instructor_grades] || false
@show_topics = params[:show_topics] || false
@checkboxes_array = [@show_teammate_reviews,@show_meta_reviews,@show_peer_scores,@show_instructor_grades,@show_topics]
# number of columns to span for each assignment
@colspan = assignment_colspan @checkboxes_array
# number of columns to span for Aggregate Score table header
@colspan_review = review_colspan @checkboxes_array
# for course
# eg. @overall_teammate_review_grades = {assgt_id1: 100, assgt_id2: 178, ...}
# @overall_teammate_review_count = {assgt_id1: 1, assgt_id2: 2, ...}
# network calls to be done only when we need to render_partial
@render_partial = show_table? @checkboxes_array
</pre>
* '''Improved Performance''' - Improved the application performance by enhancing the user experience on navigation to the all_students_all_reviews page by changing when the network call should be made.
* '''Relevant Test Cases''' - Added relevant test cases for all the newly implemented code.

===Modified File===
* The following are the list of modified files:
* 1. assessment_360.controller.rb
* 2. course_student_grade_summary.html.erb - removed
* 3. all_students_all_review.html.erb - removed
* 4. tree_display.jsx
* 5. assessment360_controller_spec.rb

===Steps to run the application on your local===
* The following are the list of modified files:
* 1. git clone https://github.com/asingh072318/expertiza
* 2. cd expertiza
* 3. bash setup.sh [Linux or Unix]
* 4. bundle install
* 5. rake db:migrate
* 6. rails s

===Testing using RSPEC===
In the existing version of Expertiza there existed certain test cases for the Assessment360 controller.We have added an additional set of RSPEC tests for Assessment360 contoller, to test all the modifications made to the controller and have also removed the testcases corresponding to the code that was removed. The tests can be executed "rpec rspec spec/controllers/assessment360_controller_spec.rb" command as shown below.

<pre>
user-expertiza $rspec spec/controllers/assessment360_controller_spec.rb
Randomized with seed 52813
........................

Finished in 1 minute 36.91 seconds (files took 6.76 seconds to load)
24 examples, 0 failures

Randomized with seed 52813

</pre>

===Project Team===
* '''Mentor''' - Dr. Edward Gehringer
* '''Members'''
* 1. Neha Kotcherlakota
* 2. Ankit Singh
* 3. Supriya Krishna

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/asingh072318/expertiza GitHub Project Repository Fork]
#[http://152.7.176.208:3000/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

File:Checkboxes option.png

2021-10-20T19:51:16Z

Nkotche:

File:Manage courses option.png

2021-10-20T19:49:57Z

Nkotche:

File:Consolidated view.png

2021-10-20T18:54:48Z

Nkotche:

File:Checkboxes selected.png

2021-10-20T18:53:56Z

Nkotche:

File:Course grade summary view.png

2021-10-20T18:51:10Z

Nkotche:

File:All students all reviews view.png

2021-10-20T18:49:24Z

Nkotche:

File:One view.png

2021-10-20T16:00:12Z

Nkotche:

File:Two views.png

2021-10-20T15:51:55Z

Nkotche: Nkotche uploaded a new version of File:Two views.png

File:Two views.png

2021-10-20T15:46:00Z

Nkotche: