Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2017 E1742

2017-04-07T19:56:13Z

Srashid3:

This page relates to instructor visualization for assignments in Expertiza. Refer to the live documentation at: https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit#

Note that Google Docs was used with the permission of the professor to minimize formatting issues with our charts.

CSC/ECE 517 Spring 2017 E1742

2017-04-07T19:48:25Z

Srashid3: Created page with "This page relates to instructor visualization for assignments in Expertiza. Refer to the live documentation at: https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_p..."

This page relates to instructor visualization for assignments in Expertiza. Refer to the live documentation at: https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit#

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:52:30Z

Srashid3: /* signup_sheet_controller.rb */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
An additional button was also implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following links were added to the partial where appropriate:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
Note that the instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this scenario, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===
This additional view renders a form where the instructor can specify a student for the signup action. The instructor is redirected to this page after clicking the signup link in the topic names partial.
<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced. These functions are based on the existing signup and delete actions, but are modified to match the context an instructor is given. For example, the signup action validates the user the instructor supplies and no longer uses the session user. Similarly for the delete action, the user must be extracted from the team ID. The flash messages were also modified to notify an instructor rather than a student.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:45:31Z

Srashid3: /* signup_as_instructor.html.erb */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
An additional button was also implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following links were added to the partial where appropriate:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
Note that the instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this scenario, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===
This additional view renders a form where the instructor can specify a student for the signup action. The instructor is redirected to this page after clicking the signup link in the topic names partial.
<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:42:02Z

Srashid3: /* _topic_name.html.erb */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
An additional button was also implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following links were added to the partial where appropriate:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
Note that the instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this scenario, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:39:44Z

Srashid3: /* Solution */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
An additional button was also implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:38:58Z

Srashid3: Undo revision 107777 by Srashid3 (talk)

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:38:18Z

Srashid3: /* Solution */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
An additional button also was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:32:12Z

Srashid3: /* Peer Review Information */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Navigating to the assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T01:28:47Z

Srashid3: /* Testing */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing. We describe the preconditions below.
RSpec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test adding multiple students since it is already tested with existing functions. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. The addition of too much extra functionality will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Pre-Conditions=====
We create two students and an instructor. We also create an assignment which adds the two students as participants. Two teams are created with a student assigned to one of the teams. The other team is used for tests where no work is submitted. Two topics are created and use the assignment deadline. One student is signed up to a topic and is used to test the delete functionality. The other student is signed up by the instructor and tests the signup functionality. The objects are refreshed before each test.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T00:58:22Z

Srashid3: Formatting

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name.

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the X enclosed by a red circle next to the desired team.

== Peer Review Information ==
Please review the information below on how to manually test the implemented changes.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a green plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage"
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== _topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T00:54:02Z

Srashid3: /* Instructor signs up a student for a topic */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor Signs Up a Student For a Topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T00:52:48Z

Srashid3: /* Solution */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, a team is created for the student as part of the signup process. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected back to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T00:49:24Z

Srashid3: /* Solutions */ Improved word flow

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solution ===

An instructor can view a list of all the topics for any given assignment. Each topic shows any signed up teams and whether students are signed up or waitlisted. The proposed change introduces a new button next to each team that allows an instructor to remove a team from a topic. In this manner, an instructor can drop a team from a topic with relative ease.
Next, an additional button was implemented to give an instructor the option to signup a specific team for a topic. An instructor can select a team by specifying one of the team members. If the student specified by the instructor is not part of a team, the student is signed up as a one person team. The signup button is located in the topic name box and redirects to a new page. The new page contains a form where the instructor can enter a student's name. Once a team is added, the instructor is redirected to the edit assignment page where the topic is updated with the specified student's team.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-04-01T00:28:12Z

Srashid3: /* Problem */

== Motivation ==

=== Problem ===
In order to sign up or drop teams from a topic, an instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. To add or drop multiple teams, the instructor must impersonate each student and navigate back and forth between the same set of pages.

=== Solutions ===

An instructor is able to view a list of all topics for a given an assignment and details about the topics. Each topic shows if a team is signed up for the topic, and if so which students are signed up or wait listed. The proposed change introduces a button next to each team of students that indicates removing that team from being signed up for the specific topic. In this manner, an instructor is more easily able to drop teams from topics.
Along with the removal from signup, an instructor also has the option to sign a specific team up for a topic. The instructor is able to select the team by specifying one of the team members names. If the student specified by the instructor is not part of a team, current functionality creates a team for that student as part of the sign up process. To allow signing a team up, a new button was introduced in the topic name box which redirects to a new page. The new page allows the instructor to enter a student's name which should be signed up for the topic. Once added, the instructor is brought back to the previous edit assignment page where the student's team can be seen as signed up for the topic.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-31T23:54:10Z

Srashid3: /* Preconditions */ Updated test plan

== Motivation ==

=== Problem ===
For an instructor to sign up or drop teams from a topic, the instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple teams from topics, the workflow is quite cumbersome and involves changing between many pages.

=== Solutions ===

An instructor is able to view a list of all topics for a given an assignment and details about the topics. Each topic shows if a team is signed up for the topic, and if so which students are signed up or wait listed. The proposed change introduces a button next to each team of students that indicates removing that team from being signed up for the specific topic. In this manner, an instructor is more easily able to drop teams from topics.
Along with the removal from signup, an instructor also has the option to sign a specific team up for a topic. The instructor is able to select the team by specifying one of the team members names. If the student specified by the instructor is not part of a team, current functionality creates a team for that student as part of the sign up process. To allow signing a team up, a new button was introduced in the topic name box which redirects to a new page. The new page allows the instructor to enter a student's name which should be signed up for the topic. Once added, the instructor is brought back to the previous edit assignment page where the student's team can be seen as signed up for the topic.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User already has a topic
| flash[:error] = "The student has already signed up for a topic!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| User is registered for the assignment
| flash[:error] = "The student is not registered for the assignment!"
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-31T23:46:51Z

Srashid3: /* sign_up_sheet/_topic_name.html.erb */ Update code

== Motivation ==

=== Problem ===
For an instructor to sign up or drop teams from a topic, the instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple teams from topics, the workflow is quite cumbersome and involves changing between many pages.

=== Solutions ===

An instructor is able to view a list of all topics for a given an assignment and details about the topics. Each topic shows if a team is signed up for the topic, and if so which students are signed up or wait listed. The proposed change introduces a button next to each team of students that indicates removing that team from being signed up for the specific topic. In this manner, an instructor is more easily able to drop teams from topics.
Along with the removal from signup, an instructor also has the option to sign a specific team up for a topic. The instructor is able to select the team by specifying one of the team members names. If the student specified by the instructor is not part of a team, current functionality creates a team for that student as part of the sign up process. To allow signing a team up, a new button was introduced in the topic name box which redirects to a new page. The new page allows the instructor to enter a student's name which should be signed up for the topic. Once added, the instructor is brought back to the previous edit assignment page where the student's team can be seen as signed up for the topic.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== sign_up_sheet/signup_as_instructor.html.erb ===

<code>
<%= form_tag(:controller => "sign_up_sheet", :action => "signup_as_instructor_action",:topic_id => params[:topic_id], :assignment_id => params[:assignment_id]) do %>
<%= label_tag(:username, "Sign Up User:") %>
<%= text_field_tag(:username) %>
<%= hidden_field_tag "topic_id", params[:topic_id] %>
<%= hidden_field_tag "assignment_id", params[:assignment_id] %>
<%= submit_tag("Submit") %>
<% end %>
</code>

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-31T23:39:38Z

Srashid3: /* signup_sheet_controller.rb */ Update code

== Motivation ==

=== Problem ===
For an instructor to sign up or drop teams from a topic, the instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple teams from topics, the workflow is quite cumbersome and involves changing between many pages.

=== Solutions ===

An instructor is able to view a list of all topics for a given an assignment and details about the topics. Each topic shows if a team is signed up for the topic, and if so which students are signed up or wait listed. The proposed change introduces a button next to each team of students that indicates removing that team from being signed up for the specific topic. In this manner, an instructor is more easily able to drop teams from topics.
Along with the removal from signup, an instructor also has the option to sign a specific team up for a topic. The instructor is able to select the team by specifying one of the team members names. If the student specified by the instructor is not part of a team, current functionality creates a team for that student as part of the sign up process. To allow signing a team up, a new button was introduced in the topic name box which redirects to a new page. The new page allows the instructor to enter a student's name which should be signed up for the topic. Once added, the instructor is brought back to the previous edit assignment page where the student's team can be seen as signed up for the topic.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<% for participant in @participants %>
<% if topic.id == participant.topic_id %>
<% chooser_present = true %>
<% if(@assignment.max_team_size > 1)%>
 
<%= participant.team_name_placeholder%><%= link_to image_tag('signup.png', :border => 0, :title => 'Waitlist Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
 
<%= participant.user_name_placeholder%><%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
<% else %>
<%= participant.user_name_placeholder%>
<% end %>
<% if participant.is_waitlisted == true %>
(waitlisted)
<% end %>
 
<% end %>
<% end %>
<% if chooser_present == false %>
No choosers.<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<% end %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
if user.nil? # validate invalid user
flash[:error] = "That student does not exist!"
else
if AssignmentParticipant.exists? user_id: user.id, parent_id: params[:assignment_id]
if SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "The student has already signed up for a topic!"
end
else
flash[:error] = "The student is not registered for the assignment!"
end
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
team_user = TeamsUser.find_by(team_id: team.id)
user = User.find(team_user.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-31T19:12:39Z

Srashid3: /* Problem */

== Motivation ==

=== Problem ===
For an instructor to sign up or drop teams from a topic, the instructor must first impersonate a student and then perform the necessary action. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple teams from topics, the workflow is quite cumbersome and involves changing between many pages.

=== Solutions ===

An instructor is able to view a list of all topics for a given an assignment and details about the topics. Each topic shows if a team is signed up for the topic, and if so which students are signed up or wait listed. The proposed change introduces a button next to each team of students that indicates removing that team from being signed up for the specific topic. In this manner, an instructor is more easily able to drop teams from topics.
Along with the removal from signup, an instructor also has the option to sign a specific team up for a topic. The instructor is able to select the team by specifying one of the team members names. If the student specified by the instructor is not part of a team, current functionality creates a team for that student as part of the sign up process. To allow signing a team up, a new button was introduced in the topic name box which redirects to a new page. The new page allows the instructor to enter a student's name which should be signed up for the topic. Once added, the instructor is brought back to the previous edit assignment page where the student's team can be seen as signed up for the topic.

== Expected Functionality ==
=== Instructor signs up a student for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Sign a student up if "No choosers" is displayed.
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
* Sign a student up for the waitlist if a team is already signed up
** If the student is part of a team, the whole team should be signed up
** If the student is not part of a team, a team should be created with only the given student as a member
** The team should be added to the end of the waitlist

Each action is performed by choosing the green checkmark next to the desired topic name

=== Instructor removes a student's signup for a topic ===
From the instructor's edit assignments page with the tab topics selected, the instructor should see a list of topics for the given assignment.
For each topic, the instructor should be able to:
* Remove a team's signup for a specific topic
** The team should no longer be signed up for the topic
** Any waitlisted teams should now be signed up for the topic
* Remove a team from the waitlist for a specific topic
** The team should be removed from the waitlist

Each action is done by choosing the x enclosed by a red circle next to the desired team

== Peer Review Information ==
Please review the information below for further information on how to review the modifications made.

Login Information:
{| class="wikitable"
|-
! Username
! Password
! Role
|-
| instructor6
| password
| instructor
|-
| student4340
| password
| student
|-
| student4405
| password
| student
|-
| student6376
| password
| student
|}

Review Steps:
* Check with assignments a student is signed up for
** Log in as a student
** On the main page, there should be a list of assignments which the user can be removed from signup
*** Note removing the signup only works if the student hasn't turned in work or the drop deadline has not passed
* Add a student to a course or assignment
** Log in as an instructor
** Go to "Courses" tab to add a student to a course, go to "Assignments" tab to add a student to an assignment
** Choose "Add Participants" button under "Actions" column. It appears as a person wearing a blue shirt with a gree plus above them
** The list shows all users currently signed up and what role they have
** Scroll to the bottom of the bottom of the page
*** Type in the student's name in the text box next to "Enter a user login"
*** Ensure the "Participant" radio button is selected
*** Select add
* Reaching assignment topics page
** Login as an instructor
** In the top red navigation bar, choose "Manage.."
** Select "Assignments" above the search bar
** Click the pencil button under actions column for any assignment
** Select the "Topics" tab
* Signing a student up
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the checkmark for a given topic
** At the redirected page, type in an existing student user
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Remove a team's signup from a topic
** Navigate to the assignment topics page
** Under the "Topic name(s)" column, click the x surrounded by a red circle for a given topic
** You should be redirected back to the "Edit Assignment" page, select the "Topics" tab to view your change
* Check to ensure a student can see his addition or removal from a topic
** Sign in as a student
** Select the assignment of interest on the home page
** The "your work" link should be grayed out with a message "(You have to choose a topic first) " if you've just removed the user's signup
** The "your work" link should be active if you've signed the user up
*** Select the link "signup sheet"
*** The topic you've signed the user up for should be highlighted in yellow

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<% for participant in @participants %>
<% if topic.id == participant.topic_id %>
<% chooser_present = true %>
<% if(@assignment.max_team_size > 1)%>
 
<%= participant.team_name_placeholder%><%= link_to image_tag('signup.png', :border => 0, :title => 'Waitlist Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
 
<%= participant.user_name_placeholder%><%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
<% else %>
<%= participant.user_name_placeholder%>
<% end %>
<% if participant.is_waitlisted == true %>
(waitlisted)
<% end %>
 
<% end %>
<% end %>
<% if chooser_present == false %>
No choosers.<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<% end %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
unless user.nil? # validate invalid user
unless SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:error] = "The student has already signed up for a topic!"
else
flash[:success] = "You have successfully signed up the student for the topic!"
end
else
flash[:error] = "That student does not exist!"
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
teamUsr = TeamsUser.find_by(team_id: team.id)
user = User.find(teamUsr.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

Since we added new functionality, we needed to create new preconditions for testing the functionality. We describe the preconditions below.
Rspec is utilized to perform the unit tests under the spec/controllers/sign_up_sheet_spec.rb file. We do not test the functionality of adding multiple students as this is tested in existing functionality that we utilized. We can assume that signing up a student will sign up the whole team as indicated by the contract with the existing function. The same contract exists for removing a student's sign up. We also wish to make a distinction in the goal of our functionality. It is not to remove one student from the team. It is to remove the whole team from a topic. Addition of too much extra functionality because it may be nice will clutter the system, thus we don't implement or test the addition or removal of an individual from a team since it is implemented elsewhere.

=====Preconditions=====
We create a three students and an instructor. We also create an assignment to which we add the three students as participants. Three teams are created with one user assigned to each team. The third team is created such that it has already submitted it's work. Three topics are created for the assignment with deadlines. The second and third teams are signed up for topics two and three. The instructor is to add the first student to topic one created for the assignment. The instructor is also to attempt to remove team two and three from being signed up.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-23T02:29:06Z

Srashid3: Updated signup action

== Motivation ==

Prior to our modifications, the Expertiza system offered no way for instructors to sign up or drop students from a topic. Instructors could impersonate a student, but this introduced unnecessary complexity to the process. By adding access to the signup functionality on the assignments page, instructors can now easily fix mistakes or free up topics as needed.

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<% for participant in @participants %>
<% if topic.id == participant.topic_id %>
<% chooser_present = true %>
<% if(@assignment.max_team_size > 1)%>
 
<%= participant.team_name_placeholder%><%= link_to image_tag('signup.png', :border => 0, :title => 'Waitlist Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
 
<%= participant.user_name_placeholder%><%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
<% else %>
<%= participant.user_name_placeholder%>
<% end %>
<% if participant.is_waitlisted == true %>
(waitlisted)
<% end %>
 
<% end %>
<% end %>
<% if chooser_present == false %>
No choosers.<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<% end %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
unless user.nil? # validate invalid user
unless SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:error] = "The student has already signed up for a topic!"
else
flash[:success] = "You have successfully signed up the student for the topic!"
end
else
flash[:error] = "That student does not exist!"
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
teamUsr = TeamsUser.find_by(team_id: team.id)
user = User.find(teamUsr.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

=====Preconditions=====
We create a user and instructor. The instructor is to add the user to one of two topics created for an assignment.
The objects are refreshed each time.

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-22T21:22:24Z

Srashid3:

== Motivation ==

Prior to our modifications, the Expertiza system offered no way for instructors to sign up or drop students from a topic. Instructors could impersonate a student, but this introduced unnecessary complexity to the process. By adding access to the signup functionality on the assignments page, instructors can now easily fix mistakes or free up topics as needed.

== Modifications ==

=== sign_up_sheet/_topic_name.html.erb ===

The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
<code>
<% for participant in @participants %>
<% if topic.id == participant.topic_id %>
<% chooser_present = true %>
<% if(@assignment.max_team_size > 1)%>
 
<%= participant.team_name_placeholder%><%= link_to image_tag('signup.png', :border => 0, :title => 'Waitlist Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
 
<%= participant.user_name_placeholder%><%= link_to image_tag('leave_topic.png', :border => 0, :title => 'Drop Student', :align => 'middle'), :controller => "sign_up_sheet", :action => "delete_signup_as_instructor", :id => participant.team_id, :topic_id => topic.id %>
<% else %>
<%= participant.user_name_placeholder%>
<% end %>
<% if participant.is_waitlisted == true %>
(waitlisted)
<% end %>
 
<% end %>
<% end %>
<% if chooser_present == false %>
No choosers.<%= link_to image_tag('signup.png', :border => 0, :title => 'Sign Up Student', :align => 'middle'), signup_as_instructor_sign_up_sheet_index_path( assignment_id: params[:id], topic_id: topic.id) %>
<% end %>
</code>
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

=== signup_sheet_controller.rb ===
The signup_sheet_controller is where most of the new functionality is introduced.

<code>
def signup_as_instructor_action
user = User.find_by(name: params[:username])
unless user.nil? # validate invalid user
unless SignUpSheet.signup_team(params[:assignment_id], user.id, params[:topic_id])
flash[:error] = "The student has already signed up for a topic!"
end
flash[:success] = "You have successfully signed up the student for the topic!"
else
flash[:error] = "That student does not exist!"
end
redirect_to controller: 'assignments', action: 'edit', id: params[:assignment_id]
end
</code>

<code>
def delete_signup_as_instructor
# find participant using assignment using team and topic ids
team = Team.find(params[:id])
assignment = Assignment.find(team.parent_id)
teamUsr = TeamsUser.find_by(team_id: team.id)
user = User.find(teamUsr.user_id)
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: assignment.id)
drop_topic_deadline = assignment.due_dates.find_by_deadline_type_id(6)
if !participant.team.submitted_files.empty? or !participant.team.hyperlinks.empty?
flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
elsif !drop_topic_deadline.nil? and Time.now > drop_topic_deadline.due_at
flash[:error] = "You cannot drop a student after the drop topic deadline!"
else
delete_signup_for_topic(assignment.id, params[:topic_id], participant.user_id)
flash[:success] = "You have successfully dropped the student from the topic!"
end
redirect_to controller: 'assignments', action: 'edit', id: assignment.id
end
</code>

== Testing ==

===Preconditions===

{| class="wikitable"
|-
! Test Description
! Expected Result
! Tested File
! Method Tested
|-
| Add user to topic with no signed up team
| Correct user is added to topic
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Add user to topic with signed up team
| Correct user is added to waitlist
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Add user to topic with waitlist
| Correct user is added to end of waitlist
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Deny adding user already signed up
| flash[:error] = "The student already signed up for a topic!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Username does not exist in database
| flash[:error] = "The student does not exist!"
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Delete signup updates waitlist
| Top of waitlist is now signed up
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow to delete signup if submitted
| flash[:error] = "The student has already submitted their work, so you are not allowed to remove them."
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Don’t allow delete signup with passed deadline
| flash[:error] = "You cannot drop the student after the drop topic deadline!"
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|-
| Redirect Delete Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| signup_as_instructor_action
|-
| Redirect Signup
| Redirects back to topic list page
| Sign_up_sheet_controller.rb
| delete_signup_as_instructor
|}

CSC/ECE 517 Spring 2017 E1714

2017-03-22T20:58:38Z

Srashid3: Added code blocks

CSC/ECE 517 Spring 2017 E1714

2017-03-22T20:53:02Z

Srashid3: Fixed formatting

CSC/ECE 517 Spring 2017 E1714

2017-03-22T20:49:44Z

Srashid3: Created page with "Motivation Prior to our modifications, the Expertiza system offered no way for instructors to sign up or drop students from a topic. Instructors could impersonate a student, but ..."

Motivation
Prior to our modifications, the Expertiza system offered no way for instructors to sign up or drop students from a topic. Instructors could impersonate a student, but this introduced unnecessary complexity to the process. By adding access to the signup functionality on the assignments page, instructors can now easily fix mistakes or free up topics as needed.

Modifications
sign_up_sheet/_topic_name.html.erb
The topic_name partial is the primary view for this feature. It renders the table cell where the topic, team, and students are listed. The following code was modified:
[ ADD SOURCE CODE ]
The instructor will see a different set of links depending on whether or not a team has already been assigned to a topic. If no team is present, only a single link that adds a student and their team will be visible. If a team is already present, then an additional link that drops that existing team will be visible. In this case, the signup link will add students to the waitlist instead.

signup_sheet_controller.rb
The signup_sheet_controller is where most of the new functionality is introduced.
[ ADD SOURCE CODE ]

Testing