Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-24T17:16:12Z

Jasanch3: /* Possible Future Enhancements */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
'''First Design: '''
<br>
[[File:Program_Design.png]]
<br>
<br>

Ultimately we were able to implement the following design:<br>
'''Final Design: '''
<br>
[[File:Final_Program_Design_2.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team proposed adding an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team originally proposed to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*'''Schema.rb'''
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.
**Created a can_mentor column for the participants table in order to be able to know who was a mentor and who was a student.
[[File:Db_migrations.png|1000px]]

'''Models'''
*'''assignment_team_mentor.rb'''
**Responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
**Started to add mailer functionality for notifying the mentor assigned.
[[File:Assignment_team_mentor.png|1000px]]

*'''assignment_team.rb'''
**Established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
[[File:Assignment_team_to_assignment_team_mentor_relation.png|1000px]]

*'''participant.rb'''
**Established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
[[File:Participant_to_assignment_mentor_relation.png|1000px]]
**Added a function to set the new can_mentor column for a participant.
**Added a function to get a list of all participants who can be mentors for a specified assignment based on the can_mentor column.
[[File:Participant_model_added_methods_2.png|1000px]]

'''Controllers'''
*'''teams_controller.rb'''
**The following code was added within the create method.
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams. Will generate notice if unable to assign mentor to recently created team.
[[File:Teams_controller.png|1000px]]

**The following code was added within the list method.
**A hash is generated with the assigned mentor of each team.
[[File:Teams_controller_list.png|1000px]]

*'''student_teams_controllers.rb'''
**The following code was added within the create method.
**Calls on AssignmentTeamMentor to assign mentor for student created teams. Will generate notice if unable to assign mentor to recently created team.
[[File:Student_teams_controller_create.png|1000px]]

**The following code was added within the view method.
[[File:Student_teams_controller_view.png|1000px]]

*'''teams_user_controller.rb'''
**added code to send the email when a user is added to a team to the mentor.
*'''participants_controller.rb'''
**updates the can_mentor column of a participant when they are added to an assignment

'''Views'''
*'''views/tree_display/_page_footer.html.erb'''
**displays mentor column header.
[[File:Row_header.png|1000px]]

*'''views/tree_display/_row_header.html.erb'''
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.
[[File:Table_row.png|1000px]]

*'''views/student_teams/view.html.erb'''
**responsible for displaying to a student the mentor assigned to their team for an assignment.
[[File:Student_view_code.png]]

*'''views/mailer/notify_member.html.erb'''
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*'''app/mailers/mailer.rb'''
**responsible for managing the mailer functionally for notifying the member

'''Rspec'''
*'''assignment_team_mentor_spec.rb'''
[[File:AssignmentTeamMentorSpec_Latest.png|1000px]]

*'''participant_spec.rb'''
**The following tests were added to validate our changes made to the Participant model.
[[File:Participant_spec_modifications.png|1000px]]

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the model created (AssignmentTeamMentor) and the model modified (Participant).

==== ''UI Test'' ====
As an instructor we were able to confirm the following UI changes after mentors were assigned to teams:<br>
[[File:Instructor_view.png|1000px]]
<br>
As a student we were able to confirm the following UI changes when a mentor has been assigned to their team:<br>
[[File:Student_view.png|1000px]]

'''The following [https://youtu.be/RQJinX6gcrA video] further expands on this UI testing.'''
<br>

As an instructor we were able to confirm the following UI changes after teams were created when no mentors had been added participants:<br>
[[File:No_mentor_participants_instructors_view.png|1000px]]
<br>

As a student we were able to confirm the following UI changes when a team was created without mentor participants for the assignment:<br>
[[File:No_mentor_participants_students_view.png|1000px]]
<br>

'''The following [https://youtu.be/nAS0WxzFAsA video] further expands on this UI testing.'''

=== Possible Future Enhancements ===

*Providing ability to manually select the mentor for a team created. Such as providing a drop down list of available mentors to choose from in the following view.
[[File:Instructor_view.png|1000px]]
*Refactor email functionality code and continue to develop to allow for the assignment team members to be notified of new assigned mentor or any other added members.
[[File:Final_Program_Design_Enhancement.png|1000px]]

==References==
[https://github.com/GitHubSanti/expertiza/tree/beta_project4 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA assigning of team mentor to newly created team video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:28:03Z

Jasanch3: /* Files Modified/Created */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created
**Created a can_mentor column for the participants table in order to be able to know who was a mentor and who was a student

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
**added mailer functionality for notifying the mentor
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
**added functionality to send email to mentor when assigned to a team.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.
*teams_user_controller.rb
**added code to send the email when a user is added to a team to the mentor.

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

*views/mailer/notify_member.html.erb
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*app/mailers/mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:Email to mentor.png]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.
2. Refactor email functionality code

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:22:52Z

Jasanch3: /* Potential Future Enhancements */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
**added mailer functionality for notifying the mentor
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
**added functionality to send email to mentor when assigned to a team.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.
*teams_user_controller.rb
**added code to send the email when a user is added to a team to the mentor.

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

*views/mailer/notify_member.html.erb
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*app/mailers/mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:Email to mentor.png]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.
2. Refactor email functionality code

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:21:51Z

Jasanch3: /* UI Test */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
**added mailer functionality for notifying the mentor
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
**added functionality to send email to mentor when assigned to a team.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.
*teams_user_controller.rb
**added code to send the email when a user is added to a team to the mentor.

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

*views/mailer/notify_member.html.erb
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*app/mailers/mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:Email to mentor.png]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

File:Email to mentor.png

2020-11-17T22:20:11Z

Jasanch3:

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:18:30Z

Jasanch3: /* Files Modified/Created */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
**added mailer functionality for notifying the mentor
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
**added functionality to send email to mentor when assigned to a team.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.
*teams_user_controller.rb
**added code to send the email when a user is added to a team to the mentor.

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

*views/mailer/notify_member.html.erb
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*app/mailers/mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:WImage103.jpg]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:08:13Z

Jasanch3: /* Files Modified/Created */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created, notifies the mentor of the team he/she is mentoring.
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

*views/mailer/notify_member.html.erb
**responsible for managing the template of the mail sent to the mentor
'''Mailers'''
*app/mailers/mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:WImage103.jpg]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-11-17T22:05:16Z

Jasanch3: /* Files Modified/Created */

==Project Overview==
=== Background ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. Keeping this in mind our code is set to work under the following conditions:

*'''Assignment teams created for an assignment without topics'''
*'''Mentors (''Instructors and TAs'') are only assigned to assignment teams if they have been added to an assignment as participants'''

We've created the following [https://youtu.be/RQJinX6gcrA video] to demonstrate the added functionality. As well as the following [https://youtu.be/nAS0WxzFAsA video] which demonstrates what happens when teams are created when no mentors have been added as participants to an assignment.

=== Objectives ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== Previous Work ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== Program Design ===
Our implementation begins when an assignment team is created. If the assignment is associated with a topic, the created team will not be assigned a mentor. If the assignment does not have a topic, a hash of potential mentors is retrieved. This hash is created from the TAs and instructors added to the assignment as participants. The keys of the hash correspond to the mentor's participant id while their values are the number of times the mentor has been assigned to mentor teams. The mentor with the lowest number of assigned teams will be the next mentor assigned to a newly created team. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment.
<br>
[[File:Program_Design.png]]
<br>

We created the following assignment_teams_mentors table with the following connections to existing tables. The new table created is responsible for storing all the mentors assigned to the various teams created. In order to do so, the assignment_team_mentors table will reference the participants and teams tables.
<br>
[[File:Schema_Modifications_UML_2.png|500px]]

We will also modify the participants table to add an additional Boolean column, '''can_mentor'''. This column will help determine what TAs and instructors can mentor for a specified assignment.

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== Files Modified/Created ===
These are the files we have modified/created throughout our project and a brief excerpt about what was done:

'''Database'''
*Schema.rb
**Created assignment_team_mentors table which references the participants table and teams tables thru foreign keys created with the assignment_team_mentors_id column and assignment_team_id column. The assignment_team_mentors table is responsible for storing all the mentors assigned to the various assignment teams created.

'''Models'''
*assignment_team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.
*assignment_team.rb
**established a has_one: active record relation with AssignmentTeamMentor model. This ensures a team only has one team mentor.
*participant.rb
**established a has_many: active record relation with AssignmentTeamMentor model. This provides the flexibility of a potential mentor added as a participant to an assignment, to mentor multiple teams created for an assignment.
*participant.rb
**

'''Controllers'''
*teams_controller.rb
**Calls on AssignmentTeamMentor to assign mentor for instructor created teams.
*student_teams_controllers.rb
**Calls on AssignmentTeamMentor to assign mentor for student created teams.
*mailer.rb
**responsible for managing the mailer functionally for notifying the member

'''Views'''
*views/tree_display/_page_footer.html.erb
**displays mentor column header.
*views/tree_display/_row_header.html.erb
**displays either mentor assigned or "No mentor assigned" for team level. For team participant level, blank cell is displayed.

*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

'''Mailers'''
*app/mailers/mailer.rb

'''RSPEC'''

=== Testing Plan ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:<br>
[[File:WImage103.jpg]]

=== Potential Future Enhancements ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
[https://github.com/expertiza/expertiza/pull/1826 Github Repository] <br>
[https://github.com/expertiza/expertiza/pull/1826 Pull Request]<br>
[https://youtu.be/RQJinX6gcrA mentor assignment video]<br>
[https://youtu.be/nAS0WxzFAsA team creation without mentor participants video]<br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T01:39:56Z

Jasanch3: /* UI Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
1. Assign a TA or instructor as a mentor for a team created for an assignment without topics<br>
2. Notify mentor and individuals of a team via Email when a mentor has been assigned<br>

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.png]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned. Once the team is assigned a mentor, an email is sent out to the mentor and students in the team to notify them of their mentor assignment
<br>

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:<br>
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified/Created'' ===
These are the files we plan to modify/create throughout our project. More to come to this section as we continue with development...

'''Database'''
*Schema.rb
**create teams_mentors table and have references to users, assignments, and teams tables.
**Keeps track of all mentors assigned to all teams.

'''Models'''
*team_mentor.rb
**responsible for ensuring mentor with the least number of teams mentored, gets assigned to the next team created.

'''Controllers'''
*teams_controller.rb
**responsible for interacting with team_mentor.rb model and ensuring the correct data is fed to model as a new team is created.

'''Views'''
*views/teams
**responsible for displaying mentors assigned to teams for an instructor creating teams.
*views/student_teams/view.html.erb
**responsible for displaying to a student the mentor assigned to their team for an assignment.

'''Mailers'''
*app/mailers/mailer.rb

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see the following after viewing their team for an assignment:<br>
[[File:Student_view_after.png|1000px]]

This is what the mentor should see:
[[File:WImage103.jpg]]

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T00:11:15Z

Jasanch3: /* UI Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
Implement code that will allow a mentor to be directly associated with a team. Notify mentor when they have been assigned to a team via email.

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.jpg]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned.
<br>

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified'' ===
List all the files we changed when implementing our project

'''Models'''
*assignment.rb
*assignment_team.rb
*assignment_form.rb
*User.rb

'''Controllers'''
*assignments_controller.rb
*teams_controller.rb

'''Views'''
TBD

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see:<br>
[[File:Student_view_before.png|1000px]]

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T00:11:03Z

Jasanch3: /* UI Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
Implement code that will allow a mentor to be directly associated with a team. Notify mentor when they have been assigned to a team via email.

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.jpg]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned.
<br>

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified'' ===
List all the files we changed when implementing our project

'''Models'''
*assignment.rb
*assignment_team.rb
*assignment_form.rb
*User.rb

'''Controllers'''
*assignments_controller.rb
*teams_controller.rb

'''Views'''
TBD

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]
<br>
A student should be able to see:
[[File:Student_view_before.png|1000px]]

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T00:10:03Z

Jasanch3: /* UI Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
Implement code that will allow a mentor to be directly associated with a team. Notify mentor when they have been assigned to a team via email.

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.jpg]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned.
<br>

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified'' ===
List all the files we changed when implementing our project

'''Models'''
*assignment.rb
*assignment_team.rb
*assignment_form.rb
*User.rb

'''Controllers'''
*assignments_controller.rb
*teams_controller.rb

'''Views'''
TBD

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:<br>
[[File:Instructor_view_after.png|1000px]]

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T00:09:09Z

Jasanch3: /* UI Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
Implement code that will allow a mentor to be directly associated with a team. Notify mentor when they have been assigned to a team via email.

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.jpg]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned.
<br>

<br>
Currently instructors see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

Currently students see the corresponding view when looking at their team for an assignment:
[[File:Student_view_before.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified'' ===
List all the files we changed when implementing our project

'''Models'''
*assignment.rb
*assignment_team.rb
*assignment_form.rb
*User.rb

'''Controllers'''
*assignments_controller.rb
*teams_controller.rb

'''Views'''
TBD

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.
<br>
[[File:Instructor_hasTopics_checkbox.png|500px]]

<br>
Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:
As an instructor should be able to see, the following:
[[File:Instructor_view_after.png|1000px]]

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-29T00:06:25Z

Jasanch3: /* RSpec Test */

==Project Overview==
=== ''Background'' ===
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.

=== ''Objectives'' ===
Implement code that will allow a mentor to be directly associated with a team. Notify mentor when they have been assigned to a team via email.

=== ''Previous Work'' ===
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:

*Code was merged from the previous team, but not refactored, so a lot of unused code remained.
*Should have followed a better naming convention for methods
*Some redundant codes in the views could be DRYed out.
*Commented code should be removed.
*Some complex logic is added but not explained in the comments.
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
*Documentation doesn't accurately represent implementation.
*Lacked sufficient detail for Test section.

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

=== ''Program Design'' ===
We are proposing the following design with our implementation.
<br>
[[File:Program_Design.jpg]]

<br>
Our implementation begins when the team is created. Once a team is created, it prompts a question asking if the assignment that the team is being created before has a topic. If the assignment is associated with a topic, teams are not given a mentor. If the assignment does not have a topic, a list of mentors is queried. The list contains mentors and details the amount of teams each of the mentors is assigned to. A mentor is then selected for the least amount of teams assigned.
<br>

<br>
Currently instructors would see the corresponding view when looking at teams associated with an assignment:
<br>
[[File:Instructor_view_before.png|1000px]]

Our team is proposing to add an additional "Mentors" column in the instructor view:
<br>
[[File:Instructor_view_after.png|1000px]]

<br>
Our team is proposing to add an additional "Mentors" section in the student view:
<br>
[[File:Student_view_after.png|1000px]]

=== ''Files Modified'' ===
List all the files we changed when implementing our project

'''Models'''
*assignment.rb
*assignment_team.rb
*assignment_form.rb
*User.rb

'''Controllers'''
*assignments_controller.rb
*teams_controller.rb

'''Views'''
TBD

=== ''Testing Plan'' ===

==== ''Edge Cases'' ====
The following are scenarios our team has thought about:

Edge Case 1: How will we handle the "Has topic?" check box being changed when editing the assignment in the instructor view. This button is how we decide if we need to assign mentors to a team.
Option A: Always run our algorithm for each assignment made and only show which mentors are assigned if the "Has topic?" is not checked
Option B: Add the functionality to add and remove mentors for all assignments, not just assignments without topics then add and remove mentors when an assignment is edited.

[[File:Instructor_hasTopics_checkbox.png|500px]]

Edge Case 2: No mentors exist
Option A: Don't assign mentors
Option B: Prevent creation of teams

==== ''RSpec Test'' ====
RSpec test to check:
* Validation of the models
* Functionality of controllers

==== ''UI Test'' ====
In the UI test we are going to verify that:

1. Instructor/Admin verifies the selection of has topics button<br>
2. Student create team and invite others<br>
3. Assign mentor and send emails, when the team is created<br>

=== Future Implementation ===

1. Implementing manual mentor assignment capability for instructors assign mentors to a team.

==References==
Github Repository: <br>
Pull Request: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki]

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang
<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-28T23:47:05Z

Jasanch3: /* UI Test */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-28T23:38:35Z

Jasanch3: /* RSpec Test */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-28T23:37:28Z

Jasanch3: /* UI Test */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-28T23:36:39Z

Jasanch3: /* UI Test */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-28T23:36:14Z

Jasanch3: /* UI Test */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:49:00Z

Jasanch3: /* Project Overview */

==Project Overview==
=== ''Background'' ===
Present a background information about the problem

=== ''Objectives'' ===
The tasks that are going to be completed

=== ''Previous Work'' ===
Show the previous implementations for this project

=== ''Possible Solutions'' ===
Show the steps we are going to take in order to fix the problems

=== ''Files Modified'' ===
List all the files we changed when implementing our project

=== ''Relevant Links'' ===
''Github Repository'': <br>
''Pull Request'': <br>
<br>

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang

<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:48:52Z

Jasanch3: /* Project Overview */

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:48:36Z

Jasanch3: /* Possible Solution */

==Project Overview==
=== ''Background'' ===
Present a background information about the problem

=== ''Objectives'' ===
The tasks that are going to be completed

=== ''Previous Work'' ===
Show the previous implementations for this project

=== ''Possible Solutions'' ===
Show the steps we are going to take in order to fix the problems

=== ''Relevant Links'' ===
''Github Repository'': <br>
''Pull Request'': <br>

=== ''Files Modified'' ===
List all the files we changed when implementing our project

<br>

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang

<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:48:29Z

Jasanch3: /* Project Overview */

==Project Overview==
=== ''Background'' ===
Present a background information about the problem

=== ''Objectives'' ===
The tasks that are going to be completed

=== ''Previous Work'' ===
Show the previous implementations for this project

=== ''Possible Solution'' ===
Show the steps we are going to take in order to fix the problems

=== ''Relevant Links'' ===
''Github Repository'': <br>
''Pull Request'': <br>

=== ''Files Modified'' ===
List all the files we changed when implementing our project

<br>

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang

<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:47:50Z

Jasanch3: /* Project Overview */

==Project Overview==
=== ''Background'' ===
Present a background information about the problem

=== ''Objectives'' ===
The tasks that are going to be completed

=== ''Previous Work'' ===
Show the previous implementations for this project

=== ''Relevant Links'' ===
''Github Repository'': <br>
''Pull Request'': <br>

=== ''Files Modified'' ===
List all the files we changed when implementing our project

<br>

==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang

<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:45:39Z

Jasanch3: /* Project Overview */

==Project Overview==
=== ''Background'' ===
Present a background information about the problem

=== ''Objectives'' ===
The tasks that are going to be completed

=== ''Previous Work'' ===
Show the previous implementations for this project

=== ''Relevant Links'' ===
''Github Repository'': <br>
''Pull Request'': <br>

=== ''Files Modified'' ===
List all the files we changed when implementing our project

<br>
=== ''Team Members'' ===
==Team==
Santiago Sepulveda <br>
Skieler Capezza <br>
Liam Donovan <br>
Javier Sanchez <br>
'''Mentor:''' Yulin Zhang

<br>

CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024

2020-10-20T22:44:04Z

Jasanch3: Created page with "==Project Overview== === ''Background'' === Present a background information about the problem === ''Objectives'' === The tasks that are going to be completed ===..."

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:36:16Z

Jasanch3: /* Result */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png|1000px]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png|1000px]]

[[File:Two_columns_UI.png|1000px]]

[[File:Dialog_joined_options.png |1000px]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:35:43Z

Jasanch3: /* Result */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]

[[File:Two_columns_UI.png]]

[[File:Dialog_joined_options.png |1000px]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

File:Dialog joined options.png

2020-10-20T01:34:36Z

Jasanch3:

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:33:39Z

Jasanch3: /* Result */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]
[[File:Two_columns_UI.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:32:26Z

Jasanch3: /* Result */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]
[[File:Two columns UI.png ‎.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:31:30Z

Jasanch3: /* Result */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]
[[File:Two_columns_Ui.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

File:Two columns UI.png

2020-10-20T01:30:44Z

Jasanch3:

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:23:52Z

Jasanch3: /* How to run the test */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza <br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:23:40Z

Jasanch3: /* How to run the test */

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. <br>cd expertiza </br>
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]

CSC/ECE 517 Fall 2020 - E2071. Improve assessment360 controller.rb

2020-10-20T01:23:11Z

Jasanch3:

This wiki page is for the description of E2071. Improve assessment360 controller.
=='''Introduction'''==
The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

=='''Problem Statement'''==
As an instructor, you are able to view tables with information on student performance across the various courses they are taking and their assignments. Currently, these tables always show the same information and you are not able to specify if you only want to see certain data. Furthermore, the source code has some variables names that are not clear to what their purpose is in the code.
===To fix the problem:===
1.There should be a dialog that appears before navigating to the pages where the table views are that contain a list of checkboxes to allow the user to choose which columns they would like to see.
====Course Grade Summary====
Selectable columns:
*Instructor Assigned Scores
*Peer Grades
*Topics
====View Aggregated Teammates and Meta Reviews====
Selectable columns:
*Teammate Review Scores
*Meta Review Scores
*Number Of Teammates

=='''Solution'''==

===1.Modify View===
File: app/views/tree_display/_dialog.html.erb

This file is a ruby view partial that contains the html for the checkbox dialogs.

<pre>
<div id="dialog_course_summary" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/course_student_grade_summary', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('InstructorAssignedScores', "Instuctor Assigned Scores") %>
<%= check_box_tag 'fields[]', 'InstructorAssignedScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('PeerGrades', "Peer Grades") %>
<%= check_box_tag 'fields[]', 'PeerGrades'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('Topics', "Topics") %>
<%= check_box_tag 'fields[]', 'Topics'%>
</div>
<%= hidden_field_tag('course_id', '', :id => 'course_summary_course_id')%>
<%= submit_tag("Submit") %>
<button type="button" id='closeCourseSummaryDialog'>Close</button>
<% end %>
</div>
<div id="dialog" title="Select Columns" hidden="true">
<%= form_tag('/assessment360/all_students_all_reviews', method: :get) do %>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('TeammateReviewScores', "Teammate Review Scores") %>
<%= check_box_tag 'fields[]', 'TeammateReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('MetaReviewScores', "Meta-Review Scores") %>
<%= check_box_tag 'fields[]', 'MetaReviewScores'%>
</div>
<div class="form-group row" style="margin-bottom: 0px !important;">
<%= label_tag('NumberOfTeammates', "Number Of Teammates") %>
<%= check_box_tag 'fields[]', 'NumberOfTeammates'%>
</div>
<%= hidden_field_tag 'course_id'%>
<%= submit_tag("Submit") %>
<button type="button" id='closeDialog'>Close</button>
<% end %>
</div>
</pre>

File: app/assets/javascripts/tree_display.jsx

Added functions to toggle dialog.
<pre>

if (document.getElementById('closeDialog')) {
document.getElementById('closeDialog').onclick = () => {jQuery('#dialog').dialog('close')};
}
if (document.getElementById('closeCourseSummaryDialog')) {
document.getElementById('closeCourseSummaryDialog').onclick = () => {jQuery('#dialog_course_summary').dialog('close')};
}

toggleModal: function() {
jQuery( "#dialog" ).dialog();
document.getElementById('course_id').value = parseInt(this.props.id/2).toString();
}
toggleCourseSummaryModal: function() {
jQuery( "#dialog_course_summary" ).dialog();
document.getElementById('course_summary_course_id').value = parseInt(this.props.id/2).toString();
}

</pre>

Added buttons to replace links that trigged dialog popups.

<pre>

<button title="View grade summary by student" onClick={this.toggleCourseSummaryModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<img src="/assets/tree_view/360-dashboard-24.png" />
</button>

<button title="View aggregated teammate & meta reviews" onClick={this.toggleModal}
style={{"padding": "0px", "margin": "0px", "border": "0px", "width": "24px", "height": "24px", "top": "8px"}} >
<span style={{"fontSize": "22px", "top": "8px"}} className="glyphicon glyphicon-list-alt"></span>
</button>

</pre>

File: app/views/assessment360/all_students_all_reviews.html.erb, app/views/assessment360/course_student_grade_summary.html.erb

Added conditionals to show selected columns for the html tables

<pre>
<% if @show_meta_reviews%><% total_meta_review_count = @overall_meta_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_meta_reviews%><td><%= "#{total_meta_review_grade / total_meta_review_count}%" %></td> <%end%>
<% if @show_teammate_reviews%><% total_teammate_review_grade = @overall_teammate_review_grades.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%><% total_teammate_review_count = @overall_teammate_review_count.inject(0) {|sum, (k, v)| sum + v } %><%end%>
<% if @show_teammate_reviews%> <td><%= "#{total_teammate_review_grade / total_teammate_review_count}%" %></td> <%end%>
</pre>

===2.Modify Controller===
File: app/controllers/assessment360_controller.rb

Added Variables to check if corresponding columns should be shown.
<pre>
fields = params[:fields]
@show_meta_reviews = fields.include? 'MetaReviewScores'
@show_teammate_reviews = fields.include? 'TeammateReviewScores'
@show_teammate_count = fields.include? 'NumberOfTeammates'
@colspan_count = 2
if !@show_teammate_reviews
@colspan_count -= 1
end
if !@show_meta_reviews
@colspan_count -= 1
end
</pre>

===3.'Updated Variable Names===
File: app/controllers/assessment360_controller.rb

Renamed @teamed_count to @total_unique_teammates

<pre>

@total_unique_teammates = {}

</pre>

====Modify course_student_grade_summary ====

File: app/controllers/assessment360_controller.rb

Added ability to calculate average peer review score for each student in a course.

<pre>
@average_peer_review_score = {}
</pre>

<pre>
...
next if peer_review_score.nil?
next if peer_review_score[:total_score].nil?
@average_peer_review_score[cp.id] += peer_review_score[:total_score].round(2)
end
if @assignments.count > 0
@average_peer_review_score[cp.id] = (@average_peer_review_score[cp.id] / @assignments.count()).round(2)
end
</pre>

=='''Result'''==

Before navigating to aggregated teammate and meta reviews, a dialog shows to allow the user select which columns they would like to see.

[[File:Aggregated_teammate_meta_reviews.png]]

Similarly, before navigating to course grade summary, another dialog shows to allow the user select their columns.

[[File:Course_grade_summary.png]]

== Testing Details==

=== RSpec ===
There was an existing test case for the assesment360 controller. We have added the test scenarios for our implementation of the average_peer_review_grades and all_students_all_reviews_all_grades. We tested url parameters as well as the average score pertaining the peer review of a student.

=== How to run the test ===

Following steps needs to be performed to test this code:<br/>
1. cd expertiza
2. rspec spec/controllers/assessment360_controller_spec.rb

== Team Information ==
'''Project Mentor:'''
<br>Dr. Gehringer

'''Project Members:'''<br>
Javier Sanchez<br>
Jack Macdonald<br>
Andrew Hirasawa<br>

== Repository ==
[https://github.com/salmonandrew/expertiza GitHub Repo]