Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2017 E1734

2017-04-13T12:42:09Z

Trichmo: /* Database Schema */ Added UML

=Improve survey functionality=

== Problem Description ==

Expertiza used to have functionality for conducting surveys. However, the existing code is inefficient and needs to be improved. This functionality has rarely been used and so isn't tested very well either. Therefore, there are parts of survey functionality that are broken or are totally unfinished.

So, there are three major problems this project will tackle.

1) Restructure and move around functionality within classes to further streamline the code.

2) Test the existing functionality and catalog what parts work and what do not. As an instance of a broken feature, take survey deployments for example. During initial testing, it is not possible to deploy any kind of survey. There are other features as well that need little fixes to make them work.

3) Fixing the broken features. This involves little bug fixes here and there, as well as finishing the features that are completely unfinished.

== Requirements ==

1) A page to show the distribution of results for all types of questionnaires.

2) Use of inheritance so that survey questionnaire is a subclass of the questionnaire class. Also, course evaluation questionnaire and global survey questionnaire should be subclasses of survey questionnaire.

3) Use response_controller to implement the survey functionality. This should be similar to how other questionnaires like the peer review questionnaire, are implemented.

4) Use the same code to display existing survey responses as to display the responses in peer reviews.

5) For each course or assignment, the admin/instructor should be able to create a survey and have some (or all) of the participants receive the survey. The instructor should have the option to not include some questions from a global survey. The quiz takers can take the global survey and course survey consecutively.

6) An entry in the participants table called a survey_participant record must be added to indicate when a user is assigned to take part in a survey.

7) Tests need to be written for the feature.

Note: Although the requirements document mentions that the existing code needs to be scrapped and rewritten, after discussion with professor it was decided that this is not a strict requirement.

== Types of Surveys ==

There are three kinds of surveys available in the Expertiza application. They are differentiated based on the group of people that can have access to these surveys.

The surveys are as follows:

1) Course Survey:

All the participants in a course can take the course survey.

File: course_evaluation_questionnaire.rb

2) Global Survey:

Any Expertiza user can take the global survey.

File: global_survey_questionnaire.rb

3) Targeted Survey:

The admin can create a survey targeted to a specific group of people.

File: survey_questionnaire.rb

== Class Design ==

=== Existing class structure: ===

[[File:E1734-structure-1.png|frame|center]]

=== Updated class structure: ===

[[File:E1734-structure-2New.jpg|frame|center]]

=== New Class Functionality: ===

==== Questionnaire: ====

Contains the basic information and methods required for posing questions to students or users in general. It is inherited by Classes Quiz, Survey, etc.

We can reuse this class's functionality to create, edit and delete surveys. The functionality for checking if questions have been answered can also be borrowed from this class.

==== Survey: ====

This project will introduce a new class called Survey.

This class will inherit from the Questionnaire class and it will be a superclass for the three different kinds of survey classes.

This class will include the assign_participants() method that can be used by any of the child classes to assign participants for their respective surveys.

This class will also have the statistics_generation functionality to be used to provide statistics for any kind of survey. This is the one that will take care of the requirement for getting the distribution of responses.

==== Global Survey: ====

This class will inherit from class Survey.

This class will be set the display_type for the survey to be global. So, while assigning participants all the users of Expertiza will be able to see this particular survey.

This kind of survey can only be created by admins of the Expertiza system.

==== Course Evaluation: ====

This is also another type of survey and will inherit from class Survey.

Surveys of this type, however, will only be available to the class to which this survey would be assigned. Accordingly, the display_type for it will be set to course.

So assign_participants() will create new survey participants for all users in a particular course.

==== Survey Questionnaire: ====

This class will also inherit from the class Survey. The name used for this class may change after further discussions with the professor.

The existing survey_questionnaire class will be repurposed to be used to create surveys that could be targeted to a group of users or be attached to a questionnaire.

It will allow for an association between an assignment and a questionnaire to be established. Additionally, it maintains the instructor id who will create the association.

A flag for a score outside an acceptable range will also be set. It could also be used to play a part in the total score calculation for the assignment.

== Database Schema ==

There are database tables that are used to track the deployment of the surveys, that are used to help keep track of the participants for each survey and that keep track of all the responses for the surveys we create. We would not be making any or would make only minimal design changes to these tables. Our main task would be to go in and fix things that are not currently operational given what we already have.

To give an idea about these database tables we have included them below.

Table: Survey Deployments

{| class="wikitable"
|-
! Element
! Type
! Attributes
|-
| course_evaluation_id
| Integer
| Limit: 4
|-
| start_date
| Datetime
|
|-
| end_date
| Datetime
|
|-
| num_of_students
| Integer
| Limit: 4
|-
| last_reminder
| Datetime
|
|-
| course_id
| Integer
| Limit: 4, Default: 0, Null: false
|}

Table: Survey Participants

{| class="wikitable"
|-
! Element
! Type
! Attributes
|-
| user_id
| Integer
| Limit: 4
|-
| survey_deployment_id
| Integer
| Limit: 4
|-
|}

Table: Survey Responses

{| class="wikitable"
|-
! Element
! Type
! Attributes
|-
| score
| Integer
| Limit: 4
|-
| comments
| Text
| Limit: 65535
|-
| assignment_id
| Integer
| Limit: 4, Default: 0, Nil: false
|-
| question_id
| Integer
| Limit: 4, Default: 0, Nil: false
|-
| survey_id
| Integer
| Limit: 4, Default: 0, Nil: false
|-
| email
| String
| Limit: 255
|}

====UML Diagram====

[[File:UML600.jpg]]

== Tasks to be performed ==

Given the information at hand, the following list will provide a good summary of the tasks we will have to perform to achieve the goals of this project.

1) Change the hierarchical structure of classes. Make survey the child of questionnaire. Global survey, survey_questionnaire and course evaluation to be subclasses of survey.

2) Creation, editing and deletion of questions, is a functionality that would be inherited into class Survey(which is a kind of questionnaire) and so into all its children surveys, from the Questionnaire class.

3) Add new class Survey and include functionality to assign(which is in the survey_controller currently) to this model.

4) In the new class add functionality to generate statistics.

5) The display_type for each of the subclasses of Survey can be set individually in the post_initialization method.

6) The three kinds of surveys can be assigned to some either an assignment, a course, a student or to all the users of Expertiza depending on their display_type.

7) Use the course evaluation tab on the Expertiza homepage to display any pending surveys instead of just the course evaluation surveys. The course evaluation tab’s functionality is currently broken and needs to be fixed.

8) "Survey deployment" functionality is broken. Need to make survey deployment of all forms of surveys functional. This would include the following tasks:

a) Ability to add new survey deployments.
b) View responses to the deployments.
c) Delete deployments.

9) "Statistic generation for Survey" functionality is broken. From the drop down menu in survey deployments, we can select Statistical tests and that should take the user to a page where depending on the survey chosen the corresponding statistics would be displayed.

== Test Plan ==

Testing tool:

RSpec (For the automated tests)

{| class="wikitable"
|-
! Test #
! Type
! Description
! Steps
|-
|Test case 1:
|Manual
|Test to check whether an instructor can create a survey.
|
1. Login to Expertiza as an instructor

2. Click Manage… and go to Questionnaire

3. Add the questions, and specify options

4. In the same Questionnaire view, create the questionnaire by Clicking Create
|-
|Test case 2:
|Manual
|Test to check whether a survey is deployed to the appropriate users.
|
1. After creation of a survey that a particular student can participate in, login as that student

2. The student can then participate in the survey by clicking on Surveys.

3.If the survey appears there, that indicates that the survey has been deployed successfully.
|-
|Test case 3:
|Manual
|Test to check whether the distribution of survey responses is displayed.
|
1. Login to Expertiza as an instructor

2. Assuming that a survey is created, and students have participated in it, we can check the distribution of results.

3. Under the Manage… Surveys tab, click Statistical tests

4. Click the particular survey that was created to view the distribution of responses.
|-
|Test case 4:
|Automated
|Test to check whether a survey_participant record is created for the user in the participants table, if the user is assigned to take part in a survey.
|
1.Create a survey

2. Assign a user(a student) to the survey

3. In the survey participants table, fire a query to check whether the student having that particular ID is present
|-
|Test case 5:
|Manual
|Test to check that only allowed users can participate in the survey
|
1. Login to Expertiza as a student that is not included as a participant in the survey.

2. By clicking on Surveys, the list of surveys that the student can currently take is displayed

3. If the survey that was created is not visible, then the user is correctly excluded.
|-
|Test case 6:
|Automated
|Test for the display_type after creation of a survey
|
1. Create any kind of survey, i.e. Survey Questionnaire, Global Survey Questionnaire, or Course Evaluation Questionnaire

2. Post_initialization as the name suggests, is called after the initialization of a survey, so it gets called on creation in the first step.

3. Assert whether the value of display_type is course/survey/global depending on what survey was created
|-
|}

File:UML600.jpg

2017-04-13T12:40:24Z

Trichmo: E1734 UML Diagram

E1734 UML Diagram

File:UML 600.jpg

2017-04-13T12:37:32Z

Trichmo:

File:UML.JPG

2017-04-13T12:30:32Z

Trichmo:

CSC/ECE 517 Spring 2017 E1734

2017-04-05T00:50:16Z

Trichmo: /* Tasks */ Added bullets

=Improve survey functionality=

==Description==
===What Needs to be done===
Expertiza used to be able to distribute surveys to the users in this system. The survey can be a course survey (all the participants of the course can take it) or a global survey (all the users in Expertiza can take it). The survey can also be targeted (the admin can specify a group of people who will receive this survey). Since there are other survey tools available, the survey feature is not used much. But, it would be good to improve it, since we could then keep survey data in our db along with the courses and assignments that it was produced from.

===Tasks===
*You should remove all the survey-related code and build from scratch.
*The three kinds of surveys in this project are survey_questionnaire.rb, global_survey_questionnaire.rb, and course_evaluation_questionnaire.rb.
*Survey questionnaire should be a subclass of questionnaire. The various kinds of surveys should, in turn, be subclasses of survey_questionnaire. The creation, editing, filling in, and checking that all the questions have been answered survey should be similar to the procedure used for other types of questionnaires (e.g. peer-review questionnaires). You should not treat the surveys differently than other questionnaires, but use polymorphism as much as you can.
*There should be a page to see the distribution of results for any question (e.g., how many people answered “1”, how many answered “2”, etc.). This page should not only be designed for surveys, but also for other types of questionnaires. (E.g. this view be able to show the score distribution for a question in other types of questionnaires, no matter whether it is a survey question like “how much do you like the course?” or a peer-review question like “how well did the author test the code?”)
*We should use the same controller method to take the survey as to fill in the peer-review, namely, response_controller.
*We should use the same code to display the existing survey responses as to display the responses in peer reviews.
*For each course or assignment, the admin/instructor should be able to create a survey and have some (or all) of the participants receive the survey. *Normally, all questions in the global_survey_questionnaire are included in every survey, but we should allow the instructor not to include them if (s)he doesn’t want to. The quiz takers can take the global survey and course survey consecutively.
*When a user is assigned to take part in a survey, a survey_participant record should be created for that user in the participants table.
*Write tests for this feature.

CSC/ECE 517 Spring 2017 E1734

2017-04-05T00:49:18Z

Trichmo: Initial Commit

=Improve survey functionality=

==Description==
===What Needs to be done===
Expertiza used to be able to distribute surveys to the users in this system. The survey can be a course survey (all the participants of the course can take it) or a global survey (all the users in Expertiza can take it). The survey can also be targeted (the admin can specify a group of people who will receive this survey). Since there are other survey tools available, the survey feature is not used much. But, it would be good to improve it, since we could then keep survey data in our db along with the courses and assignments that it was produced from.

===Tasks===
You should remove all the survey-related code and build from scratch.
The three kinds of surveys in this project are survey_questionnaire.rb, global_survey_questionnaire.rb, and course_evaluation_questionnaire.rb.
Survey questionnaire should be a subclass of questionnaire. The various kinds of surveys should, in turn, be subclasses of survey_questionnaire. The creation, editing, filling in, and checking that all the questions have been answered survey should be similar to the procedure used for other types of questionnaires (e.g. peer-review questionnaires). You should not treat the surveys differently than other questionnaires, but use polymorphism as much as you can.
There should be a page to see the distribution of results for any question (e.g., how many people answered “1”, how many answered “2”, etc.). This page should not only be designed for surveys, but also for other types of questionnaires. (E.g. this view be able to show the score distribution for a question in other types of questionnaires, no matter whether it is a survey question like “how much do you like the course?” or a peer-review question like “how well did the author test the code?”)
We should use the same controller method to take the survey as to fill in the peer-review, namely, response_controller.
We should use the same code to display the existing survey responses as to display the responses in peer reviews.
For each course or assignment, the admin/instructor should be able to create a survey and have some (or all) of the participants receive the survey. Normally, all questions in the global_survey_questionnaire are included in every survey, but we should allow the instructor not to include them if (s)he doesn’t want to. The quiz takers can take the global survey and course survey consecutively.
When a user is assigned to take part in a survey, a survey_participant record should be created for that user in the participants table.
Write tests for this feature.

CSC/ECE 517 Spring 2017 E1714

2017-03-31T01:24:44Z

Trichmo: /* Motivation */ More specific on team/student relationship

== Motivation ==

=== Problem ===
For instructors to sign up or drop teams from a topic, the instructors can impersonate a student and then choose to sign up or drop a topic. 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-31T01:19:53Z

Trichmo: /* Testing */ Clarification for reviewers who didn't understand what we are doing

== Motivation ==

=== Problem ===
For instructors to sign up or drop students from a topic, the instructors can impersonate a student and then choose to sing up or drop a topic. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple students 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 student 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 students from topics.
Along with the removal from signup, an instructor also has the option to sign a specific student up for a topic. To allow this action, 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.

== 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-31T01:15:36Z

Trichmo: /* Testing */ Added precondition information

== Motivation ==

=== Problem ===
For instructors to sign up or drop students from a topic, the instructors can impersonate a student and then choose to sing up or drop a topic. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple students 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 student 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 students from topics.
Along with the removal from signup, an instructor also has the option to sign a specific student up for a topic. To allow this action, 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.

== 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.

=====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-23T19:56:36Z

Trichmo: Updated motivation formatting

== Motivation ==

=== Problem ===
For instructors to sign up or drop students from a topic, the instructors can impersonate a student and then choose to sing up or drop a topic. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple students 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 student 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 students from topics.
Along with the removal from signup, an instructor also has the option to sign a specific student up for a topic. To allow this action, 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.

== 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 ==

=====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-23T19:55:51Z

Trichmo: /* Motivation */ Edited motivation

== Motivation ==

== Problem ==
For instructors to sign up or drop students from a topic, the instructors can impersonate a student and then choose to sing up or drop a topic. The current workflow introduces unnecessary complexity to the process. For adding or dropping multiple students 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 student 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 students from topics.
Along with the removal from signup, an instructor also has the option to sign a specific student up for a topic. To allow this action, 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.

== 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 ==

=====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-23T19:46:17Z

Trichmo: /* Peer Review Information */ Added info on how to add a user to a course or assignment

== 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.

== 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 ==

=====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-23T19:32:26Z

Trichmo: /* Expected Functionality */ Added expectations for the changes

== 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.

== 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
* 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 ==

=====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-23T19:20:08Z

Trichmo: Added expected functionality stub

== 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.

== Expected Functionality ==

== 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
* 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 ==

=====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-23T19:18:59Z

Trichmo: /* Peer Review Information */ Added basic review steps

== 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.

== 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
* 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 ==

=====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-23T18:51:27Z

Trichmo: Init peer review section

CSC/ECE 517 Spring 2017 E1714

2017-03-23T00:47:50Z

Trichmo: Edit preconditions format

CSC/ECE 517 Spring 2017 E1714

2017-03-23T00:47:12Z

Trichmo: Added preconditions

CSC/ECE 517 Spring 2017 E1714

2017-03-23T00:45:43Z

Trichmo: /* Preconditions */

CSC/ECE 517 Spring 2017 E1714

2017-03-23T00:39:49Z

Trichmo: /* Preconditions */ Removed testing out of scope

CSC/ECE 517 Spring 2017 E1714

2017-03-22T21:21:06Z

Trichmo: /* Testing */ Preconditions placeholder

CSC/ECE 517 Spring 2017 E1714

2017-03-22T21:11:37Z

Trichmo: /* Testing */ Added invalid user test case

CSC/ECE 517 Spring 2017 E1714

2017-03-22T21:03:11Z

Trichmo: /* Testing */

CSC/ECE 517 Spring 2017 E1714

2017-03-22T20:54:41Z

Trichmo: