Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management (Phase 2)

2024-04-23T18:10:57Z

Tpardes: /* Automated Rspec Testing Scenarios */

== Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

== Introduction ==
This project is the continuation of [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2403_Mentor-Meeting_Management/ E2304] for the implementation of the Mentor-meeting management in the Expertiza system for mentored teams. We are now required to add functionality to add mentors to the topics and then assign them to the teams when they pick up that topic.

== Problem Statement ==
The following tasks are required for the project:
#Enhancing Code Clarity: This involves renaming methods from Project 3 with ambiguous names, optimizing loops and adding comments for unclear lines of code
#Reimplement Mentored teams: Reimplement the Mentored team delegate to the Assignment team to reduce complexity and to follow best principles of Object Oriented Design
#Reimplement Sign Up Sheet or Topics: Reimplement the SignUpSheet controller to automatically add the mentor to when a topic is created and automatically assign the same mentor to a team when they choose the topic
#Writing tests for mentor meetings models: More tests have to be written for Mentor Meeting model
#Writing tests for the mentor meetings controller: More tests should be written for Mentor meeting controller
#Writing tests for the signup sheet controller: Additional tests should be written for signup sheet controller to test the new functionality

== Objectives ==
We have 3 main objectives for this project.
* Refactoring of the Mentor-meeting model and controller created for the Project 3
* Reimplementation of Mentored Teams model and controller for the Project 4
* Reimplementation of SignUp Sheet controller for the Project 4 to automatically assign mentors to the topics

== Design Goal ==
While fulfilling all the objectives, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplication already present in the Expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

== Class UML Diagram ==
[[File:OODD Proj4 E2403 - Entity Diagram 2.png ‎| 610px]]

== Classes and Relationships ==
=== Existing Structure ===
* Every Assignment has a Node
* Every Assignment has many AssignmentTeam and MentoredTeam
* AssignmentTeam is inherited from Team
* MentoredTeam is inherited from AssignmentTeam
* Every MentoredTeam has many MentorMeeting
=== Proposed Structure Structure ===
* MentoredTeam to be delegated from AssignmentTeam instead of inheriting from it

== Implementation Plan ==
=== Modify newly created controller, model and view ===
==== mentor_meeting_controller.rb ====
* Edit function names to make them more descriptive
* Add more descriptive comments for the functions
==== mentor_meetings_helper.rb ====
* Move the "get_dates_for_team" function to the model
* Rename the function to make it more descriptive
==== _entry_assignments.html.erb ====
* Add more descriptive comments for the JavaScript functions
* Move the Ruby code from the template to a helper or the controller
==== mentored_team.rb ====
* This file needs to be modified to implement the functionality of delegation instead of inheritance
* The "add_member" method must function as previously intended during reimplementation

=== Modify existing controller model and view ===
==== teams/_team.html.erb ====
* As the mentored team will now be delegated from the assignment team, we need to change the if condition on the top as we are changing MentoredTeam to be delegated from the AssignmentTeam
==== teams_controller.rb ====
* This file has to be modified to work with the delegated MentoredTeam
* These lines will not work as MentoredTeam will not be a model
[[File:Teams con1.png ‎| 600px]]
==== sign_up_sheet_controller.rb ====
* This controller has to be modified to automatically assign mentors or manually add mentors to the topics when they are created
* This will be followed by a change in schema
[[File:Signup con1.png | 600px]]
==== _topic.html.erb ====
* If we manually have to assign mentors to the topic, we have to include a input field to enter the mentor
[[File:Topic html.png | 600px]]
==== schema.rb ====
* As we are adding a new field to the table, we need to modify the schema
* We need to write 1 migration to add the field to the table to update the schema file
[[File:Schema E2403.png | 600px]]

=== Mailer Changes ===
====team.rb====
* The team model must be altered to use delegation for cases where a team would previously be a mentored team.
====add_member====
* The add member function must be altered such that the call to mail a user is better named, and that it calls directly to the mailer rather than the mailer helper.
[[File:add_member_email.png | 900px]]
====mailer_helper====
* The mailer_helper will be altered such that the send_team_confimration_to_user will be moved and renamed in the Mailer.rb class instead since using generic_message as such is leading to an unclear design.
[[File:team_confirm.png | 900px]]

====mailer.rb====
* A new function to specifically handle messaging users when added to teams will be built in the mailer, rather than just overusing the generic_message function.

== UI Changes ==
=== UI Changes before Phase 2 code changes ===
* The mentored assignment teams page has the modified UI from the Phase 1 as it is also a mentored assignemnt
* But the teams do not have a TA as the automated assignment of mentors has not been implmeneted.
[[File:UI1 E2403.png | 600px]]

=== UI Changes after Phase 2 code changes ===
TODO:: 
The mentored assignment teams with topic now has the new UI and the automated mentor assignemnt

== Implementation ==
TODO:: 

== Files Modified/Added ==
TODO:: 

== Test Plan ==
When the project was pulled from the main repository, there are not enough tests to cover the additional functionalities that we added. We are planning on using the test skeletons by Mustafa Olmez, as a reference to how and what kind of tests should be written. Test cases for mentor management were already written and we wrote new test cases for the new functionalities we added. Here are the four test case scenarios we covered and the actual ruby code for the Rspec tests

=== Automated Rspec Testing Scenarios===
1. Test scenario 1: Given an assignment_id, When there are multiple mentors with different team counts for the assignment, Then it should return the mentor with the lowest team count
it "returns the mentor with the lowest team count for the given assignment" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 2]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

2. Test scenario 2: Given an assignment_id, When there is only one mentor available for the assignment, Then it should return that mentor
it "should return that mentor if there's only one available" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 0]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

3. Test scenario 3: Given an assignment_id, When there are multiple mentors with the same lowest team count for the assignment, Then it should return the first mentor in the list
it "returns the first mentor in the list if there's a tie for lowest team count" do
# Arrange
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 1],])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

4. Test scenario 4: Given an assignment_id, When there are no mentors available for the assignment, Then it should return nil
it "returns nil" do
# Create a new assignment
a = FactoryBot.create(:assignment, id: 997, directory_path: 'OSS_project', auto_assign_mentor: true)
# Since there are no mentors associated with this assignment, should return nil
expect(MentorManagement.select_mentor(a.id)).to eq nil
end

=== Manual UI Testing ===
Apart from the automated Rspec tests, we are providing manual testing cases that can be used to verify the functioning of the website.

TODO:: 
Link to the [https://www.youtube.com/ video] to find help on testing these cases

==== Scenario 1 - Creating an mentored team ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Auto assign mentors when team hits > 50% capacity?" option is checked
[[File:MT 1-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
[[File:MT 1-2.png | 600px]]

==== Scenario 2 - Adding, editing, deleting mentor meeting dates ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Assigments
# Assuming you have created a mentored assignment and added participants to it, proceed to the teams page
# Try entering dates into it teams row and the date should persist
# You can edit and delete the dates from the rows
# Team with less than 50% capacity will have the mentor meeting dates disabled
[[File:MT 2.png | 600px]]

==== Scenario 3 - Creating an mentored team with topic ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Has topics?" option is checked and a topic is created using the Topics tab
[[File:MT 3-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
TODO:: 

== Test Coverage ==
TODO:: 
We used SimpleCov to generate a coverage report for the Rspec test cases implemeted for the model and controllers. The test coverage indicated x% percent of code was covered through the testcases.

== Test Login Credentials ==
* UserId: instructor6
* Password: password

== Demo Video ==
TODO:: 
This is our [https://www.youtube.com/ demo video] which explain how to create courses, assignments, mentored teams and mentored teams with topics. This video also show how to run the tests of our code changes.

== Relevant Links ==
TODO::
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/xxxx

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management (Phase 2)

2024-04-23T18:10:05Z

Tpardes: /* Automated Rspec Testing Scenarios */

== Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

== Introduction ==
This project is the continuation of [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2403_Mentor-Meeting_Management/ E2304] for the implementation of the Mentor-meeting management in the Expertiza system for mentored teams. We are now required to add functionality to add mentors to the topics and then assign them to the teams when they pick up that topic.

== Problem Statement ==
The following tasks are required for the project:
#Enhancing Code Clarity: This involves renaming methods from Project 3 with ambiguous names, optimizing loops and adding comments for unclear lines of code
#Reimplement Mentored teams: Reimplement the Mentored team delegate to the Assignment team to reduce complexity and to follow best principles of Object Oriented Design
#Reimplement Sign Up Sheet or Topics: Reimplement the SignUpSheet controller to automatically add the mentor to when a topic is created and automatically assign the same mentor to a team when they choose the topic
#Writing tests for mentor meetings models: More tests have to be written for Mentor Meeting model
#Writing tests for the mentor meetings controller: More tests should be written for Mentor meeting controller
#Writing tests for the signup sheet controller: Additional tests should be written for signup sheet controller to test the new functionality

== Objectives ==
We have 3 main objectives for this project.
* Refactoring of the Mentor-meeting model and controller created for the Project 3
* Reimplementation of Mentored Teams model and controller for the Project 4
* Reimplementation of SignUp Sheet controller for the Project 4 to automatically assign mentors to the topics

== Design Goal ==
While fulfilling all the objectives, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplication already present in the Expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

== Class UML Diagram ==
[[File:OODD Proj4 E2403 - Entity Diagram 2.png ‎| 610px]]

== Classes and Relationships ==
=== Existing Structure ===
* Every Assignment has a Node
* Every Assignment has many AssignmentTeam and MentoredTeam
* AssignmentTeam is inherited from Team
* MentoredTeam is inherited from AssignmentTeam
* Every MentoredTeam has many MentorMeeting
=== Proposed Structure Structure ===
* MentoredTeam to be delegated from AssignmentTeam instead of inheriting from it

== Implementation Plan ==
=== Modify newly created controller, model and view ===
==== mentor_meeting_controller.rb ====
* Edit function names to make them more descriptive
* Add more descriptive comments for the functions
==== mentor_meetings_helper.rb ====
* Move the "get_dates_for_team" function to the model
* Rename the function to make it more descriptive
==== _entry_assignments.html.erb ====
* Add more descriptive comments for the JavaScript functions
* Move the Ruby code from the template to a helper or the controller
==== mentored_team.rb ====
* This file needs to be modified to implement the functionality of delegation instead of inheritance
* The "add_member" method must function as previously intended during reimplementation

=== Modify existing controller model and view ===
==== teams/_team.html.erb ====
* As the mentored team will now be delegated from the assignment team, we need to change the if condition on the top as we are changing MentoredTeam to be delegated from the AssignmentTeam
==== teams_controller.rb ====
* This file has to be modified to work with the delegated MentoredTeam
* These lines will not work as MentoredTeam will not be a model
[[File:Teams con1.png ‎| 600px]]
==== sign_up_sheet_controller.rb ====
* This controller has to be modified to automatically assign mentors or manually add mentors to the topics when they are created
* This will be followed by a change in schema
[[File:Signup con1.png | 600px]]
==== _topic.html.erb ====
* If we manually have to assign mentors to the topic, we have to include a input field to enter the mentor
[[File:Topic html.png | 600px]]
==== schema.rb ====
* As we are adding a new field to the table, we need to modify the schema
* We need to write 1 migration to add the field to the table to update the schema file
[[File:Schema E2403.png | 600px]]

=== Mailer Changes ===
====team.rb====
* The team model must be altered to use delegation for cases where a team would previously be a mentored team.
====add_member====
* The add member function must be altered such that the call to mail a user is better named, and that it calls directly to the mailer rather than the mailer helper.
[[File:add_member_email.png | 900px]]
====mailer_helper====
* The mailer_helper will be altered such that the send_team_confimration_to_user will be moved and renamed in the Mailer.rb class instead since using generic_message as such is leading to an unclear design.
[[File:team_confirm.png | 900px]]

====mailer.rb====
* A new function to specifically handle messaging users when added to teams will be built in the mailer, rather than just overusing the generic_message function.

== UI Changes ==
=== UI Changes before Phase 2 code changes ===
* The mentored assignment teams page has the modified UI from the Phase 1 as it is also a mentored assignemnt
* But the teams do not have a TA as the automated assignment of mentors has not been implmeneted.
[[File:UI1 E2403.png | 600px]]

=== UI Changes after Phase 2 code changes ===
TODO:: 
The mentored assignment teams with topic now has the new UI and the automated mentor assignemnt

== Implementation ==
TODO:: 

== Files Modified/Added ==
TODO:: 

== Test Plan ==
When the project was pulled from the main repository, there are not enough tests to cover the additional functionalities that we added. We are planning on using the test skeletons by Mustafa Olmez, as a reference to how and what kind of tests should be written. Test cases for mentor management were already written and we wrote new test cases for the new functionalities we added. Here are the four test case scenarios we covered and the actual ruby code for the Rspec tests

=== Automated Rspec Testing Scenarios===
1. Test scenario 1: Given an assignment_id, When there are multiple mentors with different team counts for the assignment, Then it should return the mentor with the lowest team count
it "returns the mentor with the lowest team count for the given assignment" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 2]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

2. Test scenario 2: Given an assignment_id, When there is only one mentor available for the assignment, Then it should return that mentor
it "should return that mentor if there's only one available" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 0]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

3. Test scenario 3: Given an assignment_id, When there are multiple mentors with the same lowest team count for the assignment, Then it should return the first mentor in the list
it "returns the first mentor in the list if there's a tie for lowest team count" do
# Arrange
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 1],])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor # Can return either mentor in a tie
end

4. Test scenario 4: Given an assignment_id, When there are no mentors available for the assignment, Then it should return nil
it "returns nil" do
# Create a new assignment
a = FactoryBot.create(:assignment, id: 997, directory_path: 'OSS_project', auto_assign_mentor: true)
# Since there are no mentors associated with this assignment, should return nil
expect(MentorManagement.select_mentor(a.id)).to eq nil
end

=== Manual UI Testing ===
Apart from the automated Rspec tests, we are providing manual testing cases that can be used to verify the functioning of the website.

TODO:: 
Link to the [https://www.youtube.com/ video] to find help on testing these cases

==== Scenario 1 - Creating an mentored team ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Auto assign mentors when team hits > 50% capacity?" option is checked
[[File:MT 1-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
[[File:MT 1-2.png | 600px]]

==== Scenario 2 - Adding, editing, deleting mentor meeting dates ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Assigments
# Assuming you have created a mentored assignment and added participants to it, proceed to the teams page
# Try entering dates into it teams row and the date should persist
# You can edit and delete the dates from the rows
# Team with less than 50% capacity will have the mentor meeting dates disabled
[[File:MT 2.png | 600px]]

==== Scenario 3 - Creating an mentored team with topic ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Has topics?" option is checked and a topic is created using the Topics tab
[[File:MT 3-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
TODO:: 

== Test Coverage ==
TODO:: 
We used SimpleCov to generate a coverage report for the Rspec test cases implemeted for the model and controllers. The test coverage indicated x% percent of code was covered through the testcases.

== Test Login Credentials ==
* UserId: instructor6
* Password: password

== Demo Video ==
TODO:: 
This is our [https://www.youtube.com/ demo video] which explain how to create courses, assignments, mentored teams and mentored teams with topics. This video also show how to run the tests of our code changes.

== Relevant Links ==
TODO::
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/xxxx

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management (Phase 2)

2024-04-23T18:09:43Z

Tpardes: /* Test Plan */

== Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

== Introduction ==
This project is the continuation of [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2403_Mentor-Meeting_Management/ E2304] for the implementation of the Mentor-meeting management in the Expertiza system for mentored teams. We are now required to add functionality to add mentors to the topics and then assign them to the teams when they pick up that topic.

== Problem Statement ==
The following tasks are required for the project:
#Enhancing Code Clarity: This involves renaming methods from Project 3 with ambiguous names, optimizing loops and adding comments for unclear lines of code
#Reimplement Mentored teams: Reimplement the Mentored team delegate to the Assignment team to reduce complexity and to follow best principles of Object Oriented Design
#Reimplement Sign Up Sheet or Topics: Reimplement the SignUpSheet controller to automatically add the mentor to when a topic is created and automatically assign the same mentor to a team when they choose the topic
#Writing tests for mentor meetings models: More tests have to be written for Mentor Meeting model
#Writing tests for the mentor meetings controller: More tests should be written for Mentor meeting controller
#Writing tests for the signup sheet controller: Additional tests should be written for signup sheet controller to test the new functionality

== Objectives ==
We have 3 main objectives for this project.
* Refactoring of the Mentor-meeting model and controller created for the Project 3
* Reimplementation of Mentored Teams model and controller for the Project 4
* Reimplementation of SignUp Sheet controller for the Project 4 to automatically assign mentors to the topics

== Design Goal ==
While fulfilling all the objectives, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplication already present in the Expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

== Class UML Diagram ==
[[File:OODD Proj4 E2403 - Entity Diagram 2.png ‎| 610px]]

== Classes and Relationships ==
=== Existing Structure ===
* Every Assignment has a Node
* Every Assignment has many AssignmentTeam and MentoredTeam
* AssignmentTeam is inherited from Team
* MentoredTeam is inherited from AssignmentTeam
* Every MentoredTeam has many MentorMeeting
=== Proposed Structure Structure ===
* MentoredTeam to be delegated from AssignmentTeam instead of inheriting from it

== Implementation Plan ==
=== Modify newly created controller, model and view ===
==== mentor_meeting_controller.rb ====
* Edit function names to make them more descriptive
* Add more descriptive comments for the functions
==== mentor_meetings_helper.rb ====
* Move the "get_dates_for_team" function to the model
* Rename the function to make it more descriptive
==== _entry_assignments.html.erb ====
* Add more descriptive comments for the JavaScript functions
* Move the Ruby code from the template to a helper or the controller
==== mentored_team.rb ====
* This file needs to be modified to implement the functionality of delegation instead of inheritance
* The "add_member" method must function as previously intended during reimplementation

=== Modify existing controller model and view ===
==== teams/_team.html.erb ====
* As the mentored team will now be delegated from the assignment team, we need to change the if condition on the top as we are changing MentoredTeam to be delegated from the AssignmentTeam
==== teams_controller.rb ====
* This file has to be modified to work with the delegated MentoredTeam
* These lines will not work as MentoredTeam will not be a model
[[File:Teams con1.png ‎| 600px]]
==== sign_up_sheet_controller.rb ====
* This controller has to be modified to automatically assign mentors or manually add mentors to the topics when they are created
* This will be followed by a change in schema
[[File:Signup con1.png | 600px]]
==== _topic.html.erb ====
* If we manually have to assign mentors to the topic, we have to include a input field to enter the mentor
[[File:Topic html.png | 600px]]
==== schema.rb ====
* As we are adding a new field to the table, we need to modify the schema
* We need to write 1 migration to add the field to the table to update the schema file
[[File:Schema E2403.png | 600px]]

=== Mailer Changes ===
====team.rb====
* The team model must be altered to use delegation for cases where a team would previously be a mentored team.
====add_member====
* The add member function must be altered such that the call to mail a user is better named, and that it calls directly to the mailer rather than the mailer helper.
[[File:add_member_email.png | 900px]]
====mailer_helper====
* The mailer_helper will be altered such that the send_team_confimration_to_user will be moved and renamed in the Mailer.rb class instead since using generic_message as such is leading to an unclear design.
[[File:team_confirm.png | 900px]]

====mailer.rb====
* A new function to specifically handle messaging users when added to teams will be built in the mailer, rather than just overusing the generic_message function.

== UI Changes ==
=== UI Changes before Phase 2 code changes ===
* The mentored assignment teams page has the modified UI from the Phase 1 as it is also a mentored assignemnt
* But the teams do not have a TA as the automated assignment of mentors has not been implmeneted.
[[File:UI1 E2403.png | 600px]]

=== UI Changes after Phase 2 code changes ===
TODO:: 
The mentored assignment teams with topic now has the new UI and the automated mentor assignemnt

== Implementation ==
TODO:: 

== Files Modified/Added ==
TODO:: 

== Test Plan ==
When the project was pulled from the main repository, there are not enough tests to cover the additional functionalities that we added. We are planning on using the test skeletons by Mustafa Olmez, as a reference to how and what kind of tests should be written. Test cases for mentor management were already written and we wrote new test cases for the new functionalities we added. Here are the four test case scenarios we covered and the actual ruby code for the Rspec tests

=== Automated Rspec Testing Scenarios===
# Test scenario 1: Given an assignment_id, When there are multiple mentors with different team counts for the assignment, Then it should return the mentor with the lowest team count
it "returns the mentor with the lowest team count for the given assignment" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 2]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 2: Given an assignment_id, When there is only one mentor available for the assignment, Then it should return that mentor
it "should return that mentor if there's only one available" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 0]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 3: Given an assignment_id, When there are multiple mentors with the same lowest team count for the assignment, Then it should return the first mentor in the list
it "returns the first mentor in the list if there's a tie for lowest team count" do
# Arrange
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 1],])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor # Can return either mentor in a tie
end

# Test scenario 4: Given an assignment_id, When there are no mentors available for the assignment, Then it should return nil
it "returns nil" do
# Create a new assignment
a = FactoryBot.create(:assignment, id: 997, directory_path: 'OSS_project', auto_assign_mentor: true)
# Since there are no mentors associated with this assignment, should return nil
expect(MentorManagement.select_mentor(a.id)).to eq nil
end

=== Manual UI Testing ===
Apart from the automated Rspec tests, we are providing manual testing cases that can be used to verify the functioning of the website.

TODO:: 
Link to the [https://www.youtube.com/ video] to find help on testing these cases

==== Scenario 1 - Creating an mentored team ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Auto assign mentors when team hits > 50% capacity?" option is checked
[[File:MT 1-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
[[File:MT 1-2.png | 600px]]

==== Scenario 2 - Adding, editing, deleting mentor meeting dates ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Assigments
# Assuming you have created a mentored assignment and added participants to it, proceed to the teams page
# Try entering dates into it teams row and the date should persist
# You can edit and delete the dates from the rows
# Team with less than 50% capacity will have the mentor meeting dates disabled
[[File:MT 2.png | 600px]]

==== Scenario 3 - Creating an mentored team with topic ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Has topics?" option is checked and a topic is created using the Topics tab
[[File:MT 3-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
TODO:: 

== Test Coverage ==
TODO:: 
We used SimpleCov to generate a coverage report for the Rspec test cases implemeted for the model and controllers. The test coverage indicated x% percent of code was covered through the testcases.

== Test Login Credentials ==
* UserId: instructor6
* Password: password

== Demo Video ==
TODO:: 
This is our [https://www.youtube.com/ demo video] which explain how to create courses, assignments, mentored teams and mentored teams with topics. This video also show how to run the tests of our code changes.

== Relevant Links ==
TODO::
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/xxxx

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management (Phase 2)

2024-04-23T18:08:09Z

Tpardes: /* Test Plan */

== Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

== Introduction ==
This project is the continuation of [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2403_Mentor-Meeting_Management/ E2304] for the implementation of the Mentor-meeting management in the Expertiza system for mentored teams. We are now required to add functionality to add mentors to the topics and then assign them to the teams when they pick up that topic.

== Problem Statement ==
The following tasks are required for the project:
#Enhancing Code Clarity: This involves renaming methods from Project 3 with ambiguous names, optimizing loops and adding comments for unclear lines of code
#Reimplement Mentored teams: Reimplement the Mentored team delegate to the Assignment team to reduce complexity and to follow best principles of Object Oriented Design
#Reimplement Sign Up Sheet or Topics: Reimplement the SignUpSheet controller to automatically add the mentor to when a topic is created and automatically assign the same mentor to a team when they choose the topic
#Writing tests for mentor meetings models: More tests have to be written for Mentor Meeting model
#Writing tests for the mentor meetings controller: More tests should be written for Mentor meeting controller
#Writing tests for the signup sheet controller: Additional tests should be written for signup sheet controller to test the new functionality

== Objectives ==
We have 3 main objectives for this project.
* Refactoring of the Mentor-meeting model and controller created for the Project 3
* Reimplementation of Mentored Teams model and controller for the Project 4
* Reimplementation of SignUp Sheet controller for the Project 4 to automatically assign mentors to the topics

== Design Goal ==
While fulfilling all the objectives, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplication already present in the Expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

== Class UML Diagram ==
[[File:OODD Proj4 E2403 - Entity Diagram 2.png ‎| 610px]]

== Classes and Relationships ==
=== Existing Structure ===
* Every Assignment has a Node
* Every Assignment has many AssignmentTeam and MentoredTeam
* AssignmentTeam is inherited from Team
* MentoredTeam is inherited from AssignmentTeam
* Every MentoredTeam has many MentorMeeting
=== Proposed Structure Structure ===
* MentoredTeam to be delegated from AssignmentTeam instead of inheriting from it

== Implementation Plan ==
=== Modify newly created controller, model and view ===
==== mentor_meeting_controller.rb ====
* Edit function names to make them more descriptive
* Add more descriptive comments for the functions
==== mentor_meetings_helper.rb ====
* Move the "get_dates_for_team" function to the model
* Rename the function to make it more descriptive
==== _entry_assignments.html.erb ====
* Add more descriptive comments for the JavaScript functions
* Move the Ruby code from the template to a helper or the controller
==== mentored_team.rb ====
* This file needs to be modified to implement the functionality of delegation instead of inheritance
* The "add_member" method must function as previously intended during reimplementation

=== Modify existing controller model and view ===
==== teams/_team.html.erb ====
* As the mentored team will now be delegated from the assignment team, we need to change the if condition on the top as we are changing MentoredTeam to be delegated from the AssignmentTeam
==== teams_controller.rb ====
* This file has to be modified to work with the delegated MentoredTeam
* These lines will not work as MentoredTeam will not be a model
[[File:Teams con1.png ‎| 600px]]
==== sign_up_sheet_controller.rb ====
* This controller has to be modified to automatically assign mentors or manually add mentors to the topics when they are created
* This will be followed by a change in schema
[[File:Signup con1.png | 600px]]
==== _topic.html.erb ====
* If we manually have to assign mentors to the topic, we have to include a input field to enter the mentor
[[File:Topic html.png | 600px]]
==== schema.rb ====
* As we are adding a new field to the table, we need to modify the schema
* We need to write 1 migration to add the field to the table to update the schema file
[[File:Schema E2403.png | 600px]]

=== Mailer Changes ===
====team.rb====
* The team model must be altered to use delegation for cases where a team would previously be a mentored team.
====add_member====
* The add member function must be altered such that the call to mail a user is better named, and that it calls directly to the mailer rather than the mailer helper.
[[File:add_member_email.png | 900px]]
====mailer_helper====
* The mailer_helper will be altered such that the send_team_confimration_to_user will be moved and renamed in the Mailer.rb class instead since using generic_message as such is leading to an unclear design.
[[File:team_confirm.png | 900px]]

====mailer.rb====
* A new function to specifically handle messaging users when added to teams will be built in the mailer, rather than just overusing the generic_message function.

== UI Changes ==
=== UI Changes before Phase 2 code changes ===
* The mentored assignment teams page has the modified UI from the Phase 1 as it is also a mentored assignemnt
* But the teams do not have a TA as the automated assignment of mentors has not been implmeneted.
[[File:UI1 E2403.png | 600px]]

=== UI Changes after Phase 2 code changes ===
TODO:: 
The mentored assignment teams with topic now has the new UI and the automated mentor assignemnt

== Implementation ==
TODO:: 

== Files Modified/Added ==
TODO:: 

== Test Plan ==
When the project was pulled from the main repository, there are not enough tests to cover the additional functionalities that we added. We are planning on using the test skeletons by Mustafa Olmez, as a reference to how and what kind of tests should be written.

=== Automated Rspec Testing Scenarios===
# Test scenario 1: Given an assignment_id, When there are multiple mentors with different team counts for the assignment, Then it should return the mentor with the lowest team count
it "returns the mentor with the lowest team count for the given assignment" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 2]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 2: Given an assignment_id, When there is only one mentor available for the assignment, Then it should return that mentor
it "should return that mentor if there's only one available" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 0]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 3: Given an assignment_id, When there are multiple mentors with the same lowest team count for the assignment, Then it should return the first mentor in the list
it "returns the first mentor in the list if there's a tie for lowest team count" do
# Arrange
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 1],])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor # Can return either mentor in a tie
end

# Test scenario 4: Given an assignment_id, When there are no mentors available for the assignment, Then it should return nil
it "returns nil" do
# Create a new assignment
a = FactoryBot.create(:assignment, id: 997, directory_path: 'OSS_project', auto_assign_mentor: true)
# Since there are no mentors associated with this assignment, should return nil
expect(MentorManagement.select_mentor(a.id)).to eq nil
end

=== Manual UI Testing ===
Apart from the automated Rspec tests, we are providing manual testing cases that can be used to verify the functioning of the website.

TODO:: 
Link to the [https://www.youtube.com/ video] to find help on testing these cases

==== Scenario 1 - Creating an mentored team ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Auto assign mentors when team hits > 50% capacity?" option is checked
[[File:MT 1-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
[[File:MT 1-2.png | 600px]]

==== Scenario 2 - Adding, editing, deleting mentor meeting dates ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Assigments
# Assuming you have created a mentored assignment and added participants to it, proceed to the teams page
# Try entering dates into it teams row and the date should persist
# You can edit and delete the dates from the rows
# Team with less than 50% capacity will have the mentor meeting dates disabled
[[File:MT 2.png | 600px]]

==== Scenario 3 - Creating an mentored team with topic ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Has topics?" option is checked and a topic is created using the Topics tab
[[File:MT 3-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
TODO:: 

== Test Coverage ==
TODO:: 
We used SimpleCov to generate a coverage report for the Rspec test cases implemeted for the model and controllers. The test coverage indicated x% percent of code was covered through the testcases.

== Test Login Credentials ==
* UserId: instructor6
* Password: password

== Demo Video ==
TODO:: 
This is our [https://www.youtube.com/ demo video] which explain how to create courses, assignments, mentored teams and mentored teams with topics. This video also show how to run the tests of our code changes.

== Relevant Links ==
TODO::
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/xxxx

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management (Phase 2)

2024-04-23T18:04:24Z

Tpardes: /* Test Plan */

== Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

== Introduction ==
This project is the continuation of [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2403_Mentor-Meeting_Management/ E2304] for the implementation of the Mentor-meeting management in the Expertiza system for mentored teams. We are now required to add functionality to add mentors to the topics and then assign them to the teams when they pick up that topic.

== Problem Statement ==
The following tasks are required for the project:
#Enhancing Code Clarity: This involves renaming methods from Project 3 with ambiguous names, optimizing loops and adding comments for unclear lines of code
#Reimplement Mentored teams: Reimplement the Mentored team delegate to the Assignment team to reduce complexity and to follow best principles of Object Oriented Design
#Reimplement Sign Up Sheet or Topics: Reimplement the SignUpSheet controller to automatically add the mentor to when a topic is created and automatically assign the same mentor to a team when they choose the topic
#Writing tests for mentor meetings models: More tests have to be written for Mentor Meeting model
#Writing tests for the mentor meetings controller: More tests should be written for Mentor meeting controller
#Writing tests for the signup sheet controller: Additional tests should be written for signup sheet controller to test the new functionality

== Objectives ==
We have 3 main objectives for this project.
* Refactoring of the Mentor-meeting model and controller created for the Project 3
* Reimplementation of Mentored Teams model and controller for the Project 4
* Reimplementation of SignUp Sheet controller for the Project 4 to automatically assign mentors to the topics

== Design Goal ==
While fulfilling all the objectives, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplication already present in the Expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

== Class UML Diagram ==
[[File:OODD Proj4 E2403 - Entity Diagram 2.png ‎| 610px]]

== Classes and Relationships ==
=== Existing Structure ===
* Every Assignment has a Node
* Every Assignment has many AssignmentTeam and MentoredTeam
* AssignmentTeam is inherited from Team
* MentoredTeam is inherited from AssignmentTeam
* Every MentoredTeam has many MentorMeeting
=== Proposed Structure Structure ===
* MentoredTeam to be delegated from AssignmentTeam instead of inheriting from it

== Implementation Plan ==
=== Modify newly created controller, model and view ===
==== mentor_meeting_controller.rb ====
* Edit function names to make them more descriptive
* Add more descriptive comments for the functions
==== mentor_meetings_helper.rb ====
* Move the "get_dates_for_team" function to the model
* Rename the function to make it more descriptive
==== _entry_assignments.html.erb ====
* Add more descriptive comments for the JavaScript functions
* Move the Ruby code from the template to a helper or the controller
==== mentored_team.rb ====
* This file needs to be modified to implement the functionality of delegation instead of inheritance
* The "add_member" method must function as previously intended during reimplementation

=== Modify existing controller model and view ===
==== teams/_team.html.erb ====
* As the mentored team will now be delegated from the assignment team, we need to change the if condition on the top as we are changing MentoredTeam to be delegated from the AssignmentTeam
==== teams_controller.rb ====
* This file has to be modified to work with the delegated MentoredTeam
* These lines will not work as MentoredTeam will not be a model
[[File:Teams con1.png ‎| 600px]]
==== sign_up_sheet_controller.rb ====
* This controller has to be modified to automatically assign mentors or manually add mentors to the topics when they are created
* This will be followed by a change in schema
[[File:Signup con1.png | 600px]]
==== _topic.html.erb ====
* If we manually have to assign mentors to the topic, we have to include a input field to enter the mentor
[[File:Topic html.png | 600px]]
==== schema.rb ====
* As we are adding a new field to the table, we need to modify the schema
* We need to write 1 migration to add the field to the table to update the schema file
[[File:Schema E2403.png | 600px]]

=== Mailer Changes ===
====team.rb====
* The team model must be altered to use delegation for cases where a team would previously be a mentored team.
====add_member====
* The add member function must be altered such that the call to mail a user is better named, and that it calls directly to the mailer rather than the mailer helper.
[[File:add_member_email.png | 900px]]
====mailer_helper====
* The mailer_helper will be altered such that the send_team_confimration_to_user will be moved and renamed in the Mailer.rb class instead since using generic_message as such is leading to an unclear design.
[[File:team_confirm.png | 900px]]

====mailer.rb====
* A new function to specifically handle messaging users when added to teams will be built in the mailer, rather than just overusing the generic_message function.

== UI Changes ==
=== UI Changes before Phase 2 code changes ===
* The mentored assignment teams page has the modified UI from the Phase 1 as it is also a mentored assignemnt
* But the teams do not have a TA as the automated assignment of mentors has not been implmeneted.
[[File:UI1 E2403.png | 600px]]

=== UI Changes after Phase 2 code changes ===
TODO:: 
The mentored assignment teams with topic now has the new UI and the automated mentor assignemnt

== Implementation ==
TODO:: 

== Files Modified/Added ==
TODO:: 

== Test Plan ==
When the project was pulled from the main repository, there are not enough tests to cover the additional functionalities that we added. We are planning on using the test skeletons by Mustafa Olmez, as a reference to how and what kind of tests should be written.

=== Automated Rspec Testing Scenarios===
# Test scenario 1 : Given an assignment_id, When there are multiple mentors with different team counts for the assignment, Then it should return the mentor with the lowest team count
it "returns the mentor with the lowest team count for the given assignment" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 2]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 2: Given an assignment_id, When there is only one mentor available for the assignment, Then it should return that mentor
it "should return that mentor if there's only one available" do
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 0]])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor
end

# Test scenario 3: Given an assignment_id, When there are multiple mentors with the same lowest team count for the assignment, Then it should return the first mentor in the list
it "returns the first mentor in the list if there's a tie for lowest team count" do
# Arrange
allow(MentorManagement).to receive(:zip_mentors_with_team_count)
.with(assignment.id)
.and_return([[mentor.id, 1], [998, 1],])
allow(User).to receive(:where).with(id: mentor.id).and_return([mentor])
selected_mentor = MentorManagement.select_mentor(assignment.id)
expect(selected_mentor).to eq mentor # Can return either mentor in a tie
end

# Test scenario 4: Given an assignment_id, When there are no mentors available for the assignment, Then it should return nil
it "returns nil" do
# Create a new assignment
a = FactoryBot.create(:assignment, id: 997, directory_path: 'OSS_project', auto_assign_mentor: true)
# Since there are no mentors associated with this assignment, should return nil
expect(MentorManagement.select_mentor(a.id)).to eq nil
end

=== Manual UI Testing ===
Apart from the automated Rspec tests, we are providing manual testing cases that can be used to verify the functioning of the website.

TODO:: 
Link to the [https://www.youtube.com/ video] to find help on testing these cases

==== Scenario 1 - Creating an mentored team ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Auto assign mentors when team hits > 50% capacity?" option is checked
[[File:MT 1-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
[[File:MT 1-2.png | 600px]]

==== Scenario 2 - Adding, editing, deleting mentor meeting dates ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Assigments
# Assuming you have created a mentored assignment and added participants to it, proceed to the teams page
# Try entering dates into it teams row and the date should persist
# You can edit and delete the dates from the rows
# Team with less than 50% capacity will have the mentor meeting dates disabled
[[File:MT 2.png | 600px]]

==== Scenario 3 - Creating an mentored team with topic ====
# Log into Expertiza using the test credential and navigate to the home page
# Go to Manage > Courses
# Assuming you have created a course and added participants to it, proceed to create a team
# Make sure "Has topics?" option is checked and a topic is created using the Topics tab
[[File:MT 3-1.png | 600px]]
* Create team for the assignment and you can see that the team with more than 50% capacity gets a mentor assigned automatically
TODO:: 

== Test Coverage ==
TODO:: 
We used SimpleCov to generate a coverage report for the Rspec test cases implemeted for the model and controllers. The test coverage indicated x% percent of code was covered through the testcases.

== Test Login Credentials ==
* UserId: instructor6
* Password: password

== Demo Video ==
TODO:: 
This is our [https://www.youtube.com/ demo video] which explain how to create courses, assignments, mentored teams and mentored teams with topics. This video also show how to run the tests of our code changes.

== Relevant Links ==
TODO::
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/xxxx

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-25T00:29:23Z

Tpardes: /* Implementation */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

==== New Mentor Meeting Management View ====

As you can see in the Problem Statement section that the team listing view is not very intuitive. We have built a new view as shown in the screenshot below which has more functionality and is more easy to understand. This view also has input fields for the teams where the instructors or mentors can add the dates when the mentor meeting was conducted.

This view also has a lot of the user and team information present in the same table such as team name, member names, member IDs, mentor names and member email IDs.

You can also see that some dates are already present in the input fields. If meetings have already been conducted and fed to the system, they will show up in the appropriate rows as you can see in the screenshot. Only the instructors have the ability to edit any of these dates and the mentors can only edit the dates for their teams only. Apart from this, you can also see that the last row with team member capacity less than 50% is disabled for any kind of entry in the meeting date input fields. This is because only teams having capacity more than 50% can have mentor meetings.

[[File:New Mentor Meeting Mangement View.png|900px]]

==== Code changes in the views ====

We added a small code change the teams view where we have written code to render the new view.

[[File:Team View.png|900px]]

The actual code for the new view is written in the tree_display view where we have modified the table and also added JavaScript code for validations and calling controllers asynchronously.

[[File:New_Mentor_Meeting_View.png|900px]]

==== Code changes in the controller ====

We added a new controller(mentor_meeting.rb) to perform the CRUD operations on the mentor meeting table.

[[File:Mentor Meeting Controller.png|900px]]

==== Helper code ====

We also wrote a helper code to map all the team IDs in the mentor meeting table to the appropriate meeting dates.

[[File:Mentor Meeting Helper.png|900px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

File:Mentor Meeting Helper.png

2024-03-25T00:28:42Z

Tpardes:

File:Mentor Meeting Controller.png

2024-03-25T00:28:00Z

Tpardes:

File:New Mentor Meeting View.png

2024-03-25T00:27:48Z

Tpardes:

File:Team View.png

2024-03-25T00:24:28Z

Tpardes:

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-25T00:21:42Z

Tpardes: /* Implementation */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

==== New Mentor Meeting Mangement View ====

As you can see in the Problem Statement section that the team listing view is not very intuitive. We have built a new view as shown in the screenshot below which has more functionality and is more easy to understand. This view also has input fields for the teams where the instructors or mentors can add the dates when the mentor meeting was conducted.

This view also has a lot of the user and team information present in the same table such as team name, member names, member IDs, mentor names and member email IDs.

You can also see that some dates are already present in the input fields. If meetings have already been conducted and fed to the system, they will show up in the appropriate rows as you can see in the screenshot. Only the instructors have the ability to edit any of these dates and the mentors can only edit the dates for their teams only. Apart from this, you can also see that the last row with team member capacity less than 50% is disabled for any kind of entry in the meeting date input fields. This is because only teams having capacity more than 50% can have mentor meetings.

[[File:New Mentor Meeting Mangement View.png|900px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-25T00:17:49Z

Tpardes: /* New Mentor Meeting Mangement View */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

==== New Mentor Meeting Mangement View ====

As you can see in the [[Problem Statement]] section that the team listing view is not very intuitive. We have built a new view as shown in the screenshot below which has more functionality and is more easy to understand. This view also has input fields for the teams where the instructors or mentors can add the dates when the mentor meeting was conducted.

You can also see that some dates are already present in the input fields. If meetings have already been conducted and fed to the system, they will show up in the appropriate rows as you can see in the screenshot. Only the instructors have the ability to edit any of these dates and the mentors can only edit the dates for their teams only. Apart from this, you can also see that the last row with team member capacity less than 50% is disabled for any kind of entry in the meeting date input fields. This is because only teams having capacity more than 50% can have mentor meetings.

[[File:New Mentor Meeting Mangement View.png|900px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-25T00:17:35Z

Tpardes: /* New Mentor Meeting Mangement View */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

=== New Mentor Meeting Mangement View ===

As you can see in the Problem Statement section that the team listing view is not very intuitive. We have built a new view as shown in the screenshot below which has more functionality and is more easy to understand. This view also has input fields for the teams where the instructors or mentors can add the dates when the mentor meeting was conducted.

You can also see that some dates are already present in the input fields. If meetings have already been conducted and fed to the system, they will show up in the appropriate rows as you can see in the screenshot. Only the instructors have the ability to edit any of these dates and the mentors can only edit the dates for their teams only. Apart from this, you can also see that the last row with team member capacity less than 50% is disabled for any kind of entry in the meeting date input fields. This is because only teams having capacity more than 50% can have mentor meetings.

[[File:New Mentor Meeting Mangement View.png|900px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-25T00:16:51Z

Tpardes: /* Implementation */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

== New Mentor Meeting Mangement View ==

As you can see in the Problem Statement section that the team listing view is not very intuitive. We have built a new view as shown in the screenshot below which has more functionality and is more easy to understand. This view also has input fields for the teams where the instructors or mentors can add the dates when the mentor meeting was conducted.

You can also see that some dates are already present in the input fields. If meetings have already been conducted and fed to the system, they will show up in the appropriate rows as you can see in the screenshot. Only the instructors have the ability to edit any of these dates and the mentors can only edit the dates for their teams only. Apart from this, you can also see that the last row with team member capacity less than 50% is disabled for any kind of entry in the meeting date input fields. This is because only teams having capacity more than 50% can have mentor meetings.

[[File:New Mentor Meeting Mangement View.png|900px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T23:44:41Z

Tpardes: /* Implementation */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

==== add_member ====
[[File:add_member_email.png | 900px]]

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== Modified generic_message ====
[[File:mod_generic_message.png | 900px]]

We modified the generic_message function to include the team name as that's something that would be included in most messages. This function then uses the partials seen below to build the exact message our students/mentors will receive in their inbox. (note: generic_message is in mailer.rb under the mailer folder)

==== Student HTML Partial ====

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====

[[File:Mentor_Email.png | 888px]]

=== Mentor Meeting Management ===

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2772

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T23:01:49Z

Tpardes: /* Mentor Meeting Management */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Create a new view that shows the team listing in a more intuitive and easy way. 
- Add input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates should not be editable for teams having capacity less than 50%. 
- Show user information in the view.

== Implementation ==

=== Email Notifications ===

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== add_member ====
[[File:add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

==== Student HTML Partial ====

Student emails are built with the following HTML partial:

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====
Mentors should also be emailed when added to a team, however, their email should look a bit different:

[[File:Mentor_Email.png | 888px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T23:00:42Z

Tpardes: /* Mentor Meeting Management */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Created a new view that shows the team listing in a more intuitive and easy way. 
- Added input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Ability to add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view. 
- The meeting dates are not editable for teams having capacity less than 50%. 
- The view has also been modified so that user information can be seen in the table.

== Implementation ==

=== Email Notifications ===

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== add_member ====
[[File:add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

==== Student HTML Partial ====

Student emails are built with the following HTML partial:

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====
Mentors should also be emailed when added to a team, however, their email should look a bit different:

[[File:Mentor_Email.png | 888px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T23:00:27Z

Tpardes: /* Mentor Meeting Management */

__TOC__
==Background==
Expertiza is an open-source course management web application, that is maintained by students and teaching staff across NC State and other universities. Specifically, Expertiza is used as a platform to help students learn how to work collaboratively on large Object Oriented Programming Assignments. If you would like to learn more about Expertiza, please check the Expertiza wiki[https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page], or the GitHub page [https://github.com/expertiza]. For our project in particular, we were tasked with improving the mentor management system on Expertiza.

== What is a Mentor? ==
On Expertiza some users are known as mentors. These mentors can both be added to teams manually and automatically assigned if the assignment moderator chooses to select an option where mentors are automatically assigned to teams above 50% capacity. In practice, this means that if you have a max team size of 3, and 2 teammates have been added to team X then team X will automatically be given a mentor.

== Problem Statement ==
The problem we have been faced with is multifaceted. First, we found that when teams are automatically built, students are not getting notified of when they are added to a team. Even more alarming is that when mentors are being added to teams, they aren't getting any type of specialized notification letting them know. Mentors should know when they are mentoring a new team, and students should know when they've been added to a team.

The other problem we have fixed as part of this project is improving the view displaying the listing of the teams. The only listing of teams is on the “Create Teams” page for the assignment. It shows each team member on a separate line, with the mentor in an arbitrary place on the team.

[[File:Old_Mentor_Meeting_Mangement_View.png|900px]]

Expertiza doesn’t know when mentors met with teams, so there would have to be text fields where this information could be entered.

The page would have to be accessible to all mentors and course intructors, but a mentor could only enter meetings for the teams they mentored (except that the instructor could edit any of the meeting dates for any mentor).

Our project sought to fix these issues.

== Tasks ==

=== Email Notifications ===

- Add new mailer function for team addition confirmation 
- Add HTML partials for both the mentor-specific and student-specific emails 
- Add correct mailer function calls where users/mentors are added 
- Add tests 

=== Mentor Meeting Management ===

- Created a new view that shows the team listing in a more intuitive and easy way. 
- Added input fields for each team where mentors and instructors can enter new, view, edit dates when mentor meetings were conducted. 
- Instructors can edit all dates for mentor meetings regardless of the team. 
- Mentors can also edit dates but only for the team they are mentoring. 
- Ability to add more than three dates for the mentor meetings easily by pressing the + icon at the end of the view.
- The meeting dates are not editable for teams having capacity less than 50%.
- The view has also been modified so that user information can be seen in the table.

== Implementation ==

=== Email Notifications ===

First, we added to the add_member functions in both the Team and MentoredTeam models. This is because, as has already been stated, when a member is added, that is when we want the notification to be sent.

==== add_member ====
[[File:add_member_email.png | 900px]]

We added a check for the assignment_id parameter since there are some cases where add_member is called without an assignment. Additionally, we checked whether a user was a mentor or not, as that will be the determining factor as to which email the user will receive. Of course, we didn't want to do a type check, however, we saw no better options unless we went outside the scope of the assignment and added a whole new mentor class (since mentor is not an actual class in the system). We also had to check that the user is not a participant, as there are some odd scenarios where participants are passed as the user parameter in add_member. Our assignment has nothing to do with the participant class, only the user class, so we simply did a type check to make sure we didn't send emails to participants. Again, we wouldn't normally choose to do a type check, but since it involves code completely outside the scope of this project "participants" we chose to simply check that users aren't participants.

==== New Code in add_member ====
[[File:new_add_member_email.png | 900px]]

Once we know what type of user we are working with, we call the MailerHelper.send_team_confirmation_mail_to_user to send the correct email to the student/mentor. This function discerns the user email, subject, name of user, team name, and assignment name before calling upon the generic_message function in the mailer class to send an actual email.

==== send_team_confirmation_mail_to_user ====
[[File:team_confirm.png | 900px]]

==== Student HTML Partial ====

Student emails are built with the following HTML partial:

[[File:Student_Email.png | 888px]]

==== Mentor HTML Partial ====
Mentors should also be emailed when added to a team, however, their email should look a bit different:

[[File:Mentor_Email.png | 888px]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/ExtremeMachine12/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2769
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Samuel Kwiatkowski-Martin (slkwiatk)
* Tanmay Pardeshi (tpardes)
* Bala Logesh Sudalaimuthu Pandian (bsudala)

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:55:46Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:48:47Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:48:26Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:45:42Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:43:41Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:43:10Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:40:44Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:39:59Z

Tpardes: /* Design Pattern */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:38:36Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:35:52Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:34:56Z

Tpardes: /* Problem Statement */

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:33:27Z

Tpardes:

File:New Mentor Meeting Mangement View.png

2024-03-24T22:33:03Z

Tpardes:

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:32:47Z

Tpardes: /* Problem Statement */

File:Old Mentor Meeting Mangement View.png

2024-03-24T22:31:42Z

Tpardes:

CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management

2024-03-24T22:20:55Z

Tpardes: