View source for CSC/ECE 517 E2024 Mentor management for assignments without topics

CSC/ECE 517 E2024 Mentor management for assignments without topics

== Problem Statement == 

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.  The instructor needs to watch teams being formed, and every time a new team is formed, a new mentor needs to be assigned, outside of Expertiza. This leads to a lot of work for the instructor, as well as sometimes long delays before a team is assigned a mentor.

== Project Goal == 

Develop a trigger that: <br>
# Is activated when any team has been formed that has k members, where k is greater than 50% of the maximum team capacity <br>
#* ex. max members = 4, trigger activated when the team size reaches 3
# Assign a mentor to the team. Mentors should be evenly assigned to teams, so a good strategy is to assign the mentor who has the fewest teams to mentor so far.
# Notify the mentor via email that they are now assigned to a specific team, and provide the email addresses of the team members.
# Possibly notify the team members that they have been assigned the mentor with contact information.

== Previous Work == 
=== Design Pattern ===

Since the trigger they implemented would need multiple handlers and each of the responses in different actions, they decided to use Chain of Responsibility as the design pattern. Chain of Responsibility is a behavioural design pattern that lets you pass requests along a chain of handlers. Upon receiving a request, each handler decides either to process the request or to pass it to the next handler in the chain.
The reason to take this approach is we have a certain question which needs to be answered, based on the answer the flow moves. It follows a sequence which follows this behaviour pattern well. 
[[File:Cor.PNG]]
[[File:CoR_(1).PNG]]

=== Work Flow Diagram ===
[[File:Orig flow mentor.jpg]]
[[File:Orig flow mentor1.jpg]]

Assignments with or without a topic could be assigned with mentors automatically
[[File:AddMentor.png]]

== Improvement on the Previous Work ==
=== Change in Work Flow Diagram ===
[[File:New flow.jpg]]



'''Files Modified'''

Controllers:
*app/controllers/submission_records_controller.rb 
*app/controllers/student_teams_controller.rb 


Models:
*app/models/assignment_team.rb
*app/models/assignment_participants.rb
*app/models/team.rb
*app/models/team_users.rb

<br>
Views:
*app/views/student_task/view
*app/views/student_teams/view
*app/views/shared_scripts/_add_individual
*app/views/participants/_participant
*app/views/assignments/list_submissions.html.erb
*app/views/mailer/notify_member.html.erb
<br>

Rspec:
*spec/features/staggered_deadline_spec.rb 
*spec/models/assignment_team_spec.rb 
*spec/models/team_spec.rb
<br>
Mailers:
*app/mailers/mailer.rb


''' I. Refactor Code to follow good coding practices''' <br>
Example:<br>
1. Rename method names more meaningfully and intuitive. 
[[File:WEdit1.png]]

2. Reduce the number of conditional statements checking for mentor.
3. Rename variable names to reduce confusion like changing lowest_team_no to lowest_number_of_teams.
4. Make the code DRYer
[[File:Edit.png]]


'''II. Correct Previous Design''' <br>

1. Remove mentors from being included in a team's number of members count.<br>

2. Change the View to make mentor separate from the team. <br>
'''BEFORE''' <br>
[[File:Wstart5.png]]

'''AFTER''' <br>
[[File:Wstart3.png]]


3. Change the conditional statement that checks if a mentor has to be added to the team. (The strength of the team has to be greater than 50% of the team size).
[[File:WEdit4.png]]

4. Fix the SUBMIT button issue during role selection

[[File:Wstart.png]]
[[File:Wstart1.png]]

''' III. Code placed in the wrong locations to be moved to the desired locations.''' <br>
Example:<br>
# The email code moved to the email module.
# Code written in team file moved to the assignment team file.

== Functionalities added ==
 
* The mentor should be able to check submissions of his team.<br>
This is a new functionality, where a mentor when logged in , would be able to view all the teams assigned under him for an assignment, when he clicks view and manage teams. Additionally the respective teams submissions and submission histories could be viewed by the mentor (if and only a submission is available).Existing functions and classes were reused.

[[File:WCodeDiff3.jpg]]
[[File:WCodeDiff4.jpg]]
*Email notification for mentor/ team members
This functionality aims at generating an email notification to the mentor/ team member when a team is created giving details about the team name and the team members/mentor they have been assigned with. Additionally a notification is generated for every team member that is newly added to the group.
[[File:WCodeDiff1.jpg]]
[[File:WCodeDiff2.jpg]]
* Accommodate changes in team members/assigned topics after a mentor has been assigned.<br>
This is planned to be addressed as per the new flow diagram, where a check will be performed to see what type of a team it is, new or modified one. If the strength of the team reduces below the threshold, the assigned mentor is removed and a new mentor is added when the threshold is reached again. <br>
[[File:Start6.PNG]]

== Testing ==
# Some existing test cases have been modified, which have been reverted. <br>
# Run and pass the existing RSpec Tests. <br>
# Test the UI for the deployed project.<br>

== UI Testing ==
Part 1: <br>
* Login as the instructor6 <br>
* In the assignments view, select the add participants icon. <br>
* Now, all the existing participants and their roles and permissions are visible. Add a new participant or change permissions. This could be a member or mentor for our case. <br>
* Fix the max team size of the project. This size will decide when to add a mentor. (Here set as 4) <br>

Part 2:  <br>
* Login as student575 (added to the program by the instructor) <br>
* In the assignments view, select program 1. Within that select your team link. <br>
* Currently there is no team. Create a new team. <br>
* Invite student573 (who's also a participant in this project) <br>
* Invite student574 (who's also a participant in this project) <br>
Part 3: <br>
* Login as student573. <br>
* In the assignments view, select program 1. Within that select your team link. <br>
* There will be an invite from user575, accept it. <br>
* Will be added to the team and a mentor is assigned. (here it is 563) <br>
*Check for a received email regarding team information. <br>
[[File:WImage101.jpg]]
[[File:WImage100.jpg]]
Part4: <br>
* Login as student574. <br>
* Steps are the same as Part3. The difference will be in the email received. No new team formed or mentor assigned. Only 574 is added to the team and he alone gets the email. <br>

Part5: <br>
*Login as student563. (Mentor) <br>
* In the assignments view, select program 1. Within that select your team link. All the mentor's teams for that project will be listed. <br>
* The mentor would have gotten an email when a new team is formed and they are added as the mentor.  <br>
[[File:WImage102.jpg]]
[[File:WImage103.jpg]]

== Future Work ==
* Rubrik for a Mentor has to be implemented. Since this functionality has multiple dependencies, it could not implemented this time. 
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Rajan Anbazhagan - ranbazh@ncsu.edu <br>
*Sreenidhi Ganapathi Raman - sganapa4@ncsu.edu <br>
*Mohnish Ramani - mramani@ncsu.edu <br>
*Thomas Winter - thwinter@ncsu.edu <br>

Mentor: Srujana Rachakonda - srachak@ncsu.edu



== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]