Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-12-11T18:59:20Z

Nmchoks2: /* Additional Links: */

= E1987 - Improving search facility in Expertiza=
==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage -> Assignment -> View Reports -> Review Report (View)
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

== Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields: username, fullname, email

*Modified Files:
#app/views/users/list.html.erb
#app/views/users/_search.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

The search functionality is no longer part of the list method, instead is passed as a parameter to the rendering method. The code has been modularized to separate the search parameter fetching and matching it with the user lists. Redundant search_id field has been removed from the code, the functionality is achieved using the search_uname parameter. Variable names have been renamed to increase readability. Comments have been added to further enhance readability and maintainability of the code.

Assignment
*Search fields: assignment_name, assignee_username, assignee_name, due_date_before, due_date_after, created_before, created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields: name, text, course, assignment
*Modified files
#app/models/questionnaire_node.rb

Review
*Search fields: team, text, min_score, max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible 

==Team:==
#Nisarg Mayank Chokshi (nmchoks2@ncsu.edu)
#Omkar Nivrutti Kashid (onkashid@ncsu.edu)
#Richa Dua (rdua2@ncsu.edu)
#Steve Victor Menezes (smeneze@ncsu.edu)
'''Mentor:''' Harsh Agarwal (hagrawa2@ncsu.edu)

==Additional Links:==
Pull Request: https://github.com/expertiza/expertiza/pull/1659 
Github Project Board: https://github.com/stevemenezes/expertiza/projects/1

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-12-11T18:59:12Z

Nmchoks2: /* Additional Links: */

= E1987 - Improving search facility in Expertiza=
==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage -> Assignment -> View Reports -> Review Report (View)
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

== Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields: username, fullname, email

*Modified Files:
#app/views/users/list.html.erb
#app/views/users/_search.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

The search functionality is no longer part of the list method, instead is passed as a parameter to the rendering method. The code has been modularized to separate the search parameter fetching and matching it with the user lists. Redundant search_id field has been removed from the code, the functionality is achieved using the search_uname parameter. Variable names have been renamed to increase readability. Comments have been added to further enhance readability and maintainability of the code.

Assignment
*Search fields: assignment_name, assignee_username, assignee_name, due_date_before, due_date_after, created_before, created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields: name, text, course, assignment
*Modified files
#app/models/questionnaire_node.rb

Review
*Search fields: team, text, min_score, max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible 

==Team:==
#Nisarg Mayank Chokshi (nmchoks2@ncsu.edu)
#Omkar Nivrutti Kashid (onkashid@ncsu.edu)
#Richa Dua (rdua2@ncsu.edu)
#Steve Victor Menezes (smeneze@ncsu.edu)
'''Mentor:''' Harsh Agarwal (hagrawa2@ncsu.edu)

==Additional Links:==
Pull Request: https://github.com/expertiza/expertiza/pull/1659 
GIthub Project Board: https://github.com/stevemenezes/expertiza/projects/1

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-12-11T18:58:59Z

Nmchoks2:

= E1987 - Improving search facility in Expertiza=
==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage -> Assignment -> View Reports -> Review Report (View)
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

== Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields: username, fullname, email

*Modified Files:
#app/views/users/list.html.erb
#app/views/users/_search.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

The search functionality is no longer part of the list method, instead is passed as a parameter to the rendering method. The code has been modularized to separate the search parameter fetching and matching it with the user lists. Redundant search_id field has been removed from the code, the functionality is achieved using the search_uname parameter. Variable names have been renamed to increase readability. Comments have been added to further enhance readability and maintainability of the code.

Assignment
*Search fields: assignment_name, assignee_username, assignee_name, due_date_before, due_date_after, created_before, created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields: name, text, course, assignment
*Modified files
#app/models/questionnaire_node.rb

Review
*Search fields: team, text, min_score, max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible 

==Team:==
#Nisarg Mayank Chokshi (nmchoks2@ncsu.edu)
#Omkar Nivrutti Kashid (onkashid@ncsu.edu)
#Richa Dua (rdua2@ncsu.edu)
#Steve Victor Menezes (smeneze@ncsu.edu)
'''Mentor:''' Harsh Agarwal (hagrawa2@ncsu.edu)

==Additional Links:==
Pull Request: https://github.com/expertiza/expertiza/pull/1659
GIthub Project Board: https://github.com/stevemenezes/expertiza/projects/1

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:22:03Z

Nmchoks2: /* Automated Tests */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:21:43Z

Nmchoks2: /* Manual Tests */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:21:27Z

Nmchoks2: /* Manual Tests */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 

=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:21:03Z

Nmchoks2: /* Manual Tests */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 

# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 

# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 

# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 

=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 

# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:20:35Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 

# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 

# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 

=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 

# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:19:38Z

Nmchoks2: /* Manual Tests */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
*Setup: create a user with name="student" and userId="5000" 
 
*Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
*Response: Relevant details of student, name="student" is displayed 
 
*Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
*Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
*Setup create an assignment with name="assignment" and set a due date 
*Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
*Response : Relevant assignment should be displayed 

*Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
*Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
*Setup : Create a Questionnaire, add questions to it 
*Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
*Response : Questionnaires matching text are shown 

*Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
*Response : Questionnaires matching text are shown 

=====Search for Reviews=====
*Setup : Setup review for an assignment, login as student and then add review 

*Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
*Result : Review should be seen 

*Action : Click Advanced search, check review by text and enter text 
*Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:18:55Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

=====Search for Reviews=====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:17:34Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
=====Search for User=====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

=====Search for Assignments=====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

=====Search for Questionnaires=====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

=====Search for Reviews=====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:16:57Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
====Assignment Model ( spec/models/assignment_spec.rb )====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
====Rubrics====
# Search by name
# Search by courses used in
# Search by assignments used in
 
====Reviews====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:16:26Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
 
====Test Details:====
====User Model ( spec/models/user_spec.rb )====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
====Assignment Model ( spec/models/assignment_spec.rb )====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
====Rubrics====
# Search by name
# Search by courses used in
# Search by assignments used in
 
====Reviews====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:15:49Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
 
====Test Details:====
====User Model==== ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
====Assignment Model==== ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
====Rubrics====
# Search by name
# Search by courses used in
# Search by assignments used in
 
====Reviews====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:14:53Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
* Assignment Model ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
* Rubrics
# Search by name
# Search by courses used in
# Search by assignments used in
 
* Reviews
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:11:34Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
***Test Details***
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated in.
 
* Assignment Model ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
* Rubrics
# Search by name
# Search by courses used in
# Search by assignments used in
 
* Reviews
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T03:11:20Z

Nmchoks2: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated in.
 
* Assignment Model ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
* Rubrics
# Search by name
# Search by courses used in
# Search by assignments used in
 
* Reviews
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 
=== Manual Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:45:52Z

Nmchoks2: /* Automated Tests */

==Introduction:==

The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
We plan to two types of testing
=== UI Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible 

=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated in.
 
* Assignment Model ( spec/models/assignment_spec.rb )
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
* Rubrics
# Search by name
# Search by courses used in
# Search by assignments used in
 
* Reviews
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T01:24:37Z

Nmchoks2: /* Test Plan: */

==Introduction:==

The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.

==Problem Definition:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==

==Use Case Diagram==
[[File:UseCaseExpertizaSearch.png|center]]

==Proposed Code Changes==

==Database Design==

==Test Plan: ==
We plan to two types of testing
=== UI Tests ===
====Search for User====
Setup: create a user with name="student" and userId="5000" 
 
Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
Response: Relevant details of student, name="student" is displayed 
 
Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
Response: Relevant details of student, name="student" is displayed 

====Search for Assignments====
Setup create an assignment with name="assignment" and set a due date 
Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
Response : Relevant assignment should be displayed 

Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
Response : Relevant assignments should be displayed 

====Search for Questionnaires====
Setup : Create a Questionnaire, add questions to it 
Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
Response : Questionnaires matching text are shown 

Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
Response : Questionnaires matching text are shown 

====Search for Reviews====
Setup : Setup review for an assignment, login as student and then add review 

Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
Result : Review should be seen 

Action : Click Advanced search, check review by text and enter text 
Result : Matching review should be visible 

=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each Model 
Most tests added will be unit tests that cover the test cases for each flow and changes in the model. 
Test Details
* User Model ( spec/models/user_spec.rb )
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T00:22:01Z

Nmchoks2: /* Use Case Diagram */

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T00:17:05Z

Nmchoks2:

CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza

2019-11-11T00:09:46Z

Nmchoks2: Created page with "==Introduction:== The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display informa..."

CSC/ECE 517 Fall 2019

2019-11-11T00:07:28Z

Nmchoks2:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - Project E1943. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.]]
* [[CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades]]
* [[CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing]]
* [[CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric]]
* [[CSC/ECE 517 Fall 2019 - E1996. Enhancements to review grader]]
* [[CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza]]

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-07T01:50:05Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

''' Changes in the application with new implementation '''

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::New testcases were added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. These testcases run when we run bundle exec for the '''teams_spec.rb'''

 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 2 (153)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage >Assignments > Edit Assignment > Topics
::::3. Scroll down to the screen and click on import topics
::::4. Upload a file with the topic details and a team assigned to topic
::::5. Check the Teams Assigned optional column
::::6. Click on import and map the columns in the mapping page
::::6. After submitting, team will be assigned to appropriate topic

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
====='''Non Ascii character imports'''=====
The non ascii character issue exists for '''topic identifier''' and '''topic name''' fields as well. This should also be fixed in a similar way as is done for Issue #918 above.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:30:14Z

Nmchoks2: /* Non Ascii character imports */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
====='''Non Ascii character imports'''=====
The non ascii character issue exists for '''topic identifier''' and '''topic name''' fields as well. This should also be fixed in a similar way as is done for Issue #918 above.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:29:38Z

Nmchoks2: /* Non Ascii character imports */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
====='''Non Ascii character imports'''=====
The non ascii character issue exists for '''topic identifier''' and '''topic name''' fields as well. This should also be fixed in a similar way as is done for Issue #918
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:27:27Z

Nmchoks2: /* Non Ascii character imports */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
====='''Non Ascii character imports'''=====
The non ascii character issue exists for '''topic identifier''' and '''topic name''' fields as well.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:26:49Z

Nmchoks2: /* Possible Enhancements */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
====='''Non Ascii character imports'''=====
The non ascii character issue exists for topic identifier and topic name fields as well.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:25:42Z

Nmchoks2: /* Possible Enhancements */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 
 
The non ascii character issue exists for topic identifier and topic name fields as well.

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:22:27Z

Nmchoks2: /* Issue 329 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
'''The state of D before conflicting import''': 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the '''new team got the name D''' and the old file got renamed to '''Team_17'''.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:21:52Z

Nmchoks2: /* Issue 329 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:20:01Z

Nmchoks2: /* Issue 329 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:18:17Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:18:03Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:17:48Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:16:14Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb'''#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:15:10Z

Nmchoks2: /* Issue 329 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:14:00Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:12:09Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name.
 
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:11:45Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name.
 
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:08:31Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:07:40Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
elsif teamtype.is_a?(AssignmentTeam.class)

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:02:27Z

Nmchoks2: /* Issue 328 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 

Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:52:28Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

 
'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

controllers/import_file_controller.rb
 
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end

controllers/import_file_controller.rb (import_from_hash)
 
 

 
 

elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

views/sign_up_sheet/_add_topics.html.erb
 
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
 
 
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:47:25Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
 
 
Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
 
'''Code Changes:'''
 
import_file/_sign_up_topic.html.erb (All the select tags has been changed)
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best to extend the existing select tag with a new option for the teams assigned.
 
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 

model/sign_up_topic.rb
 
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

 

helpers/import_topics_helper.rb
 
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

controllers/import_file_controller.rb
 
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end

controllers/import_file_controller.rb (import_from_hash)
 
 

 
 

elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

views/sign_up_sheet/_add_topics.html.erb
 
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
 
 
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''
::'''[Problem 1]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::Caveat:

::'''[Problem 2]'''
::::When a deadline is assigned for a topic, we create a job (identified with delayed_job_id) to be executed on the deadline date. The module for job and queue set-up on expertiza is not fully functional, and hence this cannot be tested directly. However, we have written the code for job scheduling, here's a snapshot of the due_dates table with the delayed_job_id populated:

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:34:44Z

Nmchoks2: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Issue 153 is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
This was a new requirement to add an option to upload topics along with the teams assigned.

'''Expectations from the import file:
'''
 
Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
 
 
Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
 
'''Code Changes:'''
 
import_file/_sign_up_topic.html.erb (All the select tags has been changed)
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best to extend the existing select tag with a new option for the teams assigned.
 
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 

model/sign_up_topic.rb
 
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

 

helpers/import_topics_helper.rb
 
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

controllers/import_file_controller.rb
 
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end

controllers/import_file_controller.rb (import_from_hash)
 
 

 
 

elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

views/sign_up_sheet/_add_topics.html.erb
 
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
 
 
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''
::'''[Problem 1]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select an existing course/Create a course and an assignment under that course. Check 'Staggered deadline assignment?' for the assignment.
::::3. Create topics under the assignment.
::::4. Go to Assignment -> Topics. Click 'Show start/due date' at the bottom of the screen.
::::5. Enter 'Drop Topic Deadline' and hit 'Save start/due date'.
::::6. Reopen the assignment topic to cross verify if the deadline has been saved.

::Caveat: While creating an assignment the page would error out, but the assignment does get created, which is not related to any of the changes we have done. In case unable to do so, use 'MadeUp Problem' with Creation Date of 'Aug 30, 2017 - 9:03 AM'

::'''[Problem 2]'''
::::When a deadline is assigned for a topic, we create a job (identified with delayed_job_id) to be executed on the deadline date. The module for job and queue set-up on expertiza is not fully functional, and hence this cannot be tested directly. However, we have written the code for job scheduling, here's a snapshot of the due_dates table with the delayed_job_id populated:

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:31:28Z

Nmchoks2:

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-10-31T23:29:37Z

Nmchoks2:

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-10-28T20:38:02Z

Nmchoks2:

Issue #918 

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

Issue #328 

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities.
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
Issue #329 

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.

File:After D.PNG

2019-10-28T20:36:50Z

Nmchoks2: