Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-12T03:39:20Z

Ichench: /* Rspec Unit Tests */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
Because this component is only specified in the file "app/assets/javascripts/tree display.jsx," we can only use javascript to implement it. The format of the interactive dropdown advanced search code will be the same as "User Advanced Search." We built a pop up advanced search capability in React component FilterableTable utilizing AdditionalSearchDropDown, DatePicker, and HASQUIZ TOGGLE components.

The ContentTable component handles the searching mechanism, which filters out course titles that match the user's input.

Because course and assignment searches are so similar, they share the same code in the FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result, everything should be included.
# The filtered search produces a list of items that include the filtered search item.
# When a search is invalid, an empty list is returned.

==== Code Snippet Modified ====
Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with the given user name' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches an empty users list if user with given user name is not found' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with the given email' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches an empty users list if user with given email is not found' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with given user name and email' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with given full name and email' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name and full name' do
it 'fetches all users with given user name and full name' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with given user name, full name and email' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first image depicts the USER search UI page. The second image depicts the USER page, which allows users to search by userid, name, and e-mail.
It's worth noting that not all parameters are required for a successful search. You can search using one, two, or all of the options.

[[File:Users 1.png|700px]]
[[File:Users 2.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Courses_1.png|700px]]
[[File:Courses_2.png|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignments_1.png|700px]]
[[File:Assignments_2.png|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionaires_1.png|700px]]
[[File:Questionaries_2.png|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-12T03:30:16Z

Ichench: /* Questionnaire Search UI */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
Because this component is only specified in the file "app/assets/javascripts/tree display.jsx," we can only use javascript to implement it. The format of the interactive dropdown advanced search code will be the same as "User Advanced Search." We built a pop up advanced search capability in React component FilterableTable utilizing AdditionalSearchDropDown, DatePicker, and HASQUIZ TOGGLE components.

The ContentTable component handles the searching mechanism, which filters out course titles that match the user's input.

Because course and assignment searches are so similar, they share the same code in the FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result, everything should be included.
# The filtered search produces a list of items that include the filtered search item.
# When a search is invalid, an empty list is returned.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first image depicts the USER search UI page. The second image depicts the USER page, which allows users to search by userid, name, and e-mail.
It's worth noting that not all parameters are required for a successful search. You can search using one, two, or all of the options.

[[File:Users 1.png|700px]]
[[File:Users 2.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Courses_1.png|700px]]
[[File:Courses_2.png|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignments_1.png|700px]]
[[File:Assignments_2.png|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionaires_1.png|700px]]
[[File:Questionaries_2.png|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

File:Questionaries 2.png

2022-04-12T03:26:25Z

Ichench: Ichench uploaded a new version of File:Questionaries 2.png

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-12T03:24:17Z

Ichench: /* Questionnaire Search UI */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
Because this component is only specified in the file "app/assets/javascripts/tree display.jsx," we can only use javascript to implement it. The format of the interactive dropdown advanced search code will be the same as "User Advanced Search." We built a pop up advanced search capability in React component FilterableTable utilizing AdditionalSearchDropDown, DatePicker, and HASQUIZ TOGGLE components.

The ContentTable component handles the searching mechanism, which filters out course titles that match the user's input.

Because course and assignment searches are so similar, they share the same code in the FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result, everything should be included.
# The filtered search produces a list of items that include the filtered search item.
# When a search is invalid, an empty list is returned.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first image depicts the USER search UI page. The second image depicts the USER page, which allows users to search by userid, name, and e-mail.
It's worth noting that not all parameters are required for a successful search. You can search using one, two, or all of the options.

[[File:Users 1.png|700px]]
[[File:Users 2.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Courses_1.png|700px]]
[[File:Courses_2.png|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignments_1.png|700px]]
[[File:Assignments_2.png|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionaires_1.png|700px]]
[[File:Questionaires_2.png|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza

2022-04-12T03:12:13Z

Ichench: /* Questionnaire Search UI */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. It is an open-source application running on Ruby on Rails. It is used for the 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 that display 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 parameter which includes 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 an advanced search feature where user can search on the basis of more than one parameters, and making the search functionality appear more elegant.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#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 criterion needs to be specified, there should be an 'Advanced Search' button.

=== E2153 Our Result ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== E2079 Previous Implementation ===
#[https://github.com/prashantyadla/expertiza/tree/beta E2079 Github Repository]
#[https://github.com/expertiza/expertiza/pull/1842 E2079 Pull Request]
#[https://drive.google.com/file/d/1yr_4b0SsN_J4qGMpZbQLzKXzWAjoX7fV/view. Video Link]

=== Issue With Previous Implementation ===
# All implementation are working on javascript inside tree_display.jsx.
# With compatibility issue, these work can't be check-in currently.
# Format are not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching of user with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==
[https://youtu.be/SxbHz9bp2L0 Demo Video]

The design proposed in this iteration of the project is not much different from a high level than the design proposed form last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]. Below you will see a similar description of the solution previously proposed and some additional design choices added to improve upon the previous iteration of this issue. Changes from the previous design will be denoted by clear statements indicating the revision.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
In the current system workflow, the Manage Users view can search users by Username, Full name, and email. We will retain these 3 searching criteria, except changing "Username" into "User ID" to avoid confusion with "Full name". We will 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.
====Implementation====
User has its own "list" controller, so it will directly implemented in list form with a "_search" html form after apply the search result. Since only this class has rails list, so only this file will implement in ruby code. Our goal is to maintain the logic and search alike.
# Delete the original simple search in "app/views/users/list.html.erb"
## Add a render for search form
## Align the UI for direct user access, which is not part of our project, but to make the page looks similar, we also change the style of it
## Align the user list table UI with style "class="table table-hover""
# Add a form in "app/views/users/_search.html.erb"
## Note that to align the UI design, the "Search" button will using style "class='btn btn-primary'"
## Note that to align the UI design, the "text blank" will using the style "class:'form-control'"
## Advanced Search toggle button is done with javascript (jquery) inside this form individually, and the form is divided into 2 separate field
### search_button_field: This part should always be displayed
### advance_search_form: This part should only display after the "Advanced Search" be toggled
# Add a form input handler in the "users_controller.rb" to parse the form, which should only do parsing and send parameters to model
# Add a advanced search feature to the User model "user.rb" inside the method "get_user_list"
## This change will cause this method to take up 3 parameters with (user id, full name, e-mail)
## We use regular expression to match the search with user fields, and it should allow multiple input for comparison
## The result will return back to controller in @users, and list view will render it again with paginated users

===Search for Courses:===
In the current system implementation, searching via the name of the course is supported with a partial or complete course name. In the proposed system, the user will be able to search for a course using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for a course by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the courses created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All courses that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.nce.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop-up advanced search functionality in React component FilterableTable.
# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The proposed system will implement search functionality for searching via below criteria:
# Keyword within Name of Questionnaire: A text field
# Keyword or a string in a single question within a questionnaire: A text field
# Course Name: A text field for the course name
# Assignment Name: A text field for the assignment

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.

There will be a default search box of the name of questionnaire as a simple search, and if a user want to apply multiple filters, the user can tap on the "Advanced Search" button which is adjacent to the "Search" button, and a hidden field will be rendered below-containing text boxes for all the columns. All the matched questionnaires will be listed at once.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:42660.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==
=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

==== Code Snippet Added ====
Before checking the code, here's some preliminary:
# We are testing the only function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire 1.png|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire 2.png|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Yu-Hsuan Lo (ylo@ncsu.edu)

Fu-Jen Yen (fyen@ncsu.edu)

Shao-Yo Chao (schao2@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza

2022-04-12T03:11:08Z

Ichench: /* Questionnaire Search UI */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. It is an open-source application running on Ruby on Rails. It is used for the 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 that display 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 parameter which includes 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 an advanced search feature where user can search on the basis of more than one parameters, and making the search functionality appear more elegant.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#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 criterion needs to be specified, there should be an 'Advanced Search' button.

=== E2153 Our Result ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== E2079 Previous Implementation ===
#[https://github.com/prashantyadla/expertiza/tree/beta E2079 Github Repository]
#[https://github.com/expertiza/expertiza/pull/1842 E2079 Pull Request]
#[https://drive.google.com/file/d/1yr_4b0SsN_J4qGMpZbQLzKXzWAjoX7fV/view. Video Link]

=== Issue With Previous Implementation ===
# All implementation are working on javascript inside tree_display.jsx.
# With compatibility issue, these work can't be check-in currently.
# Format are not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching of user with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==
[https://youtu.be/SxbHz9bp2L0 Demo Video]

The design proposed in this iteration of the project is not much different from a high level than the design proposed form last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]. Below you will see a similar description of the solution previously proposed and some additional design choices added to improve upon the previous iteration of this issue. Changes from the previous design will be denoted by clear statements indicating the revision.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
In the current system workflow, the Manage Users view can search users by Username, Full name, and email. We will retain these 3 searching criteria, except changing "Username" into "User ID" to avoid confusion with "Full name". We will 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.
====Implementation====
User has its own "list" controller, so it will directly implemented in list form with a "_search" html form after apply the search result. Since only this class has rails list, so only this file will implement in ruby code. Our goal is to maintain the logic and search alike.
# Delete the original simple search in "app/views/users/list.html.erb"
## Add a render for search form
## Align the UI for direct user access, which is not part of our project, but to make the page looks similar, we also change the style of it
## Align the user list table UI with style "class="table table-hover""
# Add a form in "app/views/users/_search.html.erb"
## Note that to align the UI design, the "Search" button will using style "class='btn btn-primary'"
## Note that to align the UI design, the "text blank" will using the style "class:'form-control'"
## Advanced Search toggle button is done with javascript (jquery) inside this form individually, and the form is divided into 2 separate field
### search_button_field: This part should always be displayed
### advance_search_form: This part should only display after the "Advanced Search" be toggled
# Add a form input handler in the "users_controller.rb" to parse the form, which should only do parsing and send parameters to model
# Add a advanced search feature to the User model "user.rb" inside the method "get_user_list"
## This change will cause this method to take up 3 parameters with (user id, full name, e-mail)
## We use regular expression to match the search with user fields, and it should allow multiple input for comparison
## The result will return back to controller in @users, and list view will render it again with paginated users

===Search for Courses:===
In the current system implementation, searching via the name of the course is supported with a partial or complete course name. In the proposed system, the user will be able to search for a course using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for a course by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the courses created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All courses that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.nce.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop-up advanced search functionality in React component FilterableTable.
# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The proposed system will implement search functionality for searching via below criteria:
# Keyword within Name of Questionnaire: A text field
# Keyword or a string in a single question within a questionnaire: A text field
# Course Name: A text field for the course name
# Assignment Name: A text field for the assignment

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.

There will be a default search box of the name of questionnaire as a simple search, and if a user want to apply multiple filters, the user can tap on the "Advanced Search" button which is adjacent to the "Search" button, and a hidden field will be rendered below-containing text boxes for all the columns. All the matched questionnaires will be listed at once.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:42660.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==
=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

==== Code Snippet Added ====
Before checking the code, here's some preliminary:
# We are testing the only function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-1.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire-2.JPG|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Yu-Hsuan Lo (ylo@ncsu.edu)

Fu-Jen Yen (fyen@ncsu.edu)

Shao-Yo Chao (schao2@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

File:Questionaries 2.png

2022-04-12T03:10:00Z

Ichench:

File:Questionaires 1.png

2022-04-12T03:09:14Z

Ichench:

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-07T00:12:03Z

Ichench: /* Search for Questionnaires: */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-07T00:11:23Z

Ichench: /* Search for Questionnaires: */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-07T00:10:55Z

Ichench: /* Sequence Diagram */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-07T00:10:13Z

Ichench: /* Search for Questionnaires: */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Sequence Diagram====
[[File:questionnaires sequence.png|500px|center]]

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

File:Questionnaires sequence.png

2022-04-07T00:08:31Z

Ichench:

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T21:34:06Z

Ichench: /* Implementation */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

#Getting sub-contents when a user press on a course
##From FilterableTable ,getSubFolderData() method makes an HTTP POST request.
##It will update the state of the FilterableTable component after retrieving the data.
##When the state is updated, the ContentTable component is updated, and the component is rerendered

#Searching for questionnaire
##FilterableTable is in charge of the searching method. When the search button is pressed, all sub-contents from each questionnaire category are filtered based on the user's input.
##From FilterableTable component, handleQuestionnaireSearchChange() method keeps track of the search input field. When the input field is cleared, it will trigger an update.

Proposed Implementation

In the proposed system.we will be using existing list method However, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T21:21:01Z

Ichench: /* Implementation */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

In the proposed system the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T21:19:00Z

Ichench: /* Implementation */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

Current Implementation:

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T21:15:16Z

Ichench: /* Implementation */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T21:11:55Z

Ichench: /* Implementation */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching by assignment name (partial or whole) is supported. After pressing the Advanced Search button in the proposed system, the user will be able to search for an assignment with additional filters. The filters will contain a creation date, an updated date, and a checkbox to indicate if a quiz is included. The user might apply many filters at the same time, and the query's output would match all of them.

When searching for an assignment by date, the user will have the option of searching by created or modified date from a drop-down menu. Following that, he will be presented with a calendar from which he may choose a date, and any tasks created/updated on or before that date will be displayed.

The user may apply additional filters by tapping the Advanced Search button adjacent to the Search button; a hidden div will then be shown below, including text fields for all of the columns. The filters will return all assignments that fit the criteria. If the search criteria do not match any entries in the database, an empty list will be provided.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
We will use the existing list method and make changes to it in order to present the "Advanced Search" functionality.

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

=== Rspec Unit Tests ===
Functionalities to be tested:
# Given an unfiltered search result that should include everything.
# The result of the filtered search is a list of objects that contain the filtered search item.
# An empty list is returned when a search is invalid.
RSpec tests will be written to cover the depth of each test point above for all the search objects mentioned in the proposed solution.

Here are some improvements on previously implemented test cases:
# The "it" clause is going to be more specific with respect to each test.
# We will be introducing fixtures in the tests to modularize the common code in each test.
# We will try to add more tests if possible to increase the code coverage of the controllers and models.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
You can watch this demo video for a rough idea of the UI pages. [https://youtu.be/SxbHz9bp2L0 Demo].

We will be making more changes during the implementation phase and will be adding the screenshots parallelly in this wiki.

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T20:01:22Z

Ichench: /* Search for Questionnaires: */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project makes use of peer review to allow students to learn from one another. It's a Ruby on Rails-based open-source application. It is used by faculty and students for the management of courses and assignments for specific courses. Different screens in the manage content area of the application offer information about users, courses, assignments, questionnaires, and reviews.

The program should have a fully functional search functionality throughout all views, allowing a user to quickly find any sort of data using any number of parameters that meet his needs. Users should be found using one additional parameter, such as their name, full name, email address, and so on. Similarly, assignments should be searched by name, creation date, updated date, and other criteria.

However, the existing application's search functionality is limited to a single parameter for users and assignments. A search feature has not yet been introduced in the management of questionnaires. This project aims to improve Expertiza's search functionality by adding search bars if they aren't already there, creating an advanced search tool that allows users to search using several parameters, and making the search functionality look more appealing.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#An instructor or administrator can look for a person using their name, user ID, or other criteria.
#An instructor should be able to look for assignments based on their name, due date, or other criteria.
#An instructor should be able to find rubrics (or other questionnaires) by name or by the courses or assignments in which they were utilized.
##There should also be a means for instructors to quickly locate rubrics (and other surveys) that have been utilized in a particular course. It should be possible to search or click someplace to bring up a list of questionnaires used in the course, with the list of questionnaires only extending to include those that are pertinent.
##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 for specific ratings or text strings across all reviews of a team's work. Filtering reviews by score, text comment length, reviewer, and reviewee should be possible.
#An instructor or administrator should be able to search for all the assignments that a user has participated in.
#If more than one criterion needs to be specified, there should be an 'Advanced Search' button.

Expertiza presently supports some of these queries, but the user interface is extremely clumsy. This is especially true on the site of an instructor or administrator, where huge and complicated search boxes push the vital elements of the page to the bottom of the screen. A quick search should be possible by just inputting text into an unobtrusive textbox. If further criteria are needed, there should be an "advanced search" button or link that opens up more textboxes, perhaps in Javascript, that are of an acceptable size and do not overwhelm the rest of the page's content.

=== E2153 Previous Implementation ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== Issue With Previous Implementation ===
# The code is not readable and there are some parts of code that still need to DRYed out.
# The test cases "it" clause must be more specific to the test. This is the same for all the test cases as of now which is quite confusing.
# All implementations are working on javascript inside tree_display.jsx. There are some changes that are overlapping and confusing to refactor.
# All the code changes should follow proper ruby naming conventions and there should be enough comments to explain the functionality.
# With compatibility issues, these workers can't be check-in currently.
# Format is not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching for users with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

== Proposed Solution ==

The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue. Clear words stating the modification will be used to indicate changes from the previous design.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
The Manage Users view in the current system process allows search users by Username, Full Name, and Email. We'll keep these three search criteria the same, but we'll rename "Username" to "User ID" to avoid confusion with "Full name." We'll let you search for fields regardless of the case of the string you're looking for. The user will be able to apply numerous filters at once, with the query's output matching all of them. An empty list will be returned if no results are found.
====Sequence Diagram====
[[File:User flow.jpeg|500px|center]]

====Implementation====
In order to introduce the "Advanced Search" functionality, we will leverage the existing list method and make changes in that method.
# Remove the existing simple search in "app/views/users/list.html.erb".
## Add a new partial to render the search form.
## Style the user list table UI by adding the code as "class="table table-hover"".
# So in order to perform the search, we will introduce code to render a form input in file: "app/views/users/_search.html.erb".
## We will by styling the "Search" button with "class='btn btn-primary'".
## We will be styling the "text blank" using "class:'form-control'".
## Now our UI contains two search components to be displayed in the UI.
### search_field: This search bar is always displayed as it is in the existing UI.
### advance_search_fields: These are only displayed when the "Advanced Search" button is toggled to be ON.
# In "users controller.rb," add a form input handler to parse the form, which should just do parsing and provide arguments to the model.
# In the method "get_user_list", add code to perform the newly introduced advanced search which is in the User model file: "user.rb"
## As a result of this modification, the method "get_user_list" will now have three parameters (user id, full name, e-mail).
## To match the search with user fields, we utilize regular expressions, and it should allow for multiple input for comparison.
## The result will be returned to the controller in @users, and the list view will render it with paginated users once more.

===Search for Courses:===
In the current system when a user goes on Course page to look up for any course, a search box is present. User can add course name to look up any course. Functionality of Advanced search is also present in which user can search for any course based on start date and end date. User can select a filter whether he wants to search via created date filter or updated date filter. User can also select whether he wants course name which has a quiz present or not.

But the issue with the current system is that it may lead to some discrepancies if multiple filters are selected and current system of searching a course does not work on DRY approach. Hence, we propose a new system which is quite like current one just with some additional modifications to make course search more effective and use the DRY approach.

In the proposed system, the user will be able to search a course with the similar advanced search option as previous one, just the back-end code for implementing this functionality will be based on Don’t Repeat Yourself Approach. The part of code which is being reused again and again will be written at just one place and a call will be made to use that functionality.
To search for a course by date, the user will have a similar drop-down list to choose whether he want to search by created date or updated date. For the date drop down menu, a calendar prompt will be displayed for date selection.

To clear out the discrepancies in applying multiple filters, we implemented the DRY approach and tried to remove as much duplicate code as possible. All the courses that match user preferences in search box will be returned when user search using multiple filters. An empty list will be returned if search criteria is not matched.

====UML Diagram for Course Search====
[[File:OODD1.png|500px|center]]

====Implementation====
Current system has most of the functionalities implemented already, like Advanced search functionality etc. We will use this code of current system and optimize this code by using the DRY approach and removing the duplicate and reused code. Hence our implementation first describes the current implementation of various functionalities as described in wiki page of 2021 and then we provide the refactoring of the code.

The implementation of this functionality of advanced search and optimal UI is written in "app/assets/javascripts/tree_display.jsx". The functionality of dropdown menu in advanced search has the same format as “User Advanced Search”. The components used for implementing the advanced search functionality are AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE. The React component FilterableTable is used to implement pop-up advanced search functionality.
# Fetching and Displaying all the sub-contents when user clicks on a course
## The HTTP POST request is sent by getSubFolderData() from FilterableTable component
## The state of FilterableTable component is updated after retrieving the data.
## An update to ContentTable component is triggered once the state is updated.
# Course Search
## ContentTable component handles the search method, which filters out courses' names that match the user's input corresponding to each filter as selected by the user.

Refactoring of implementation of above desired functionalities is done in this new proposed system and code duplication is removed. DRY approach has been implemented in this system for Course and assignment search functionality along with advanced search.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.

====Sequence Diagram====
[[File:Assigments sequence diagrame.jpeg|500px|center]]

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The existing system includes search functionality for the following criteria:
#A text field : where you can search for a keyword within name of Questionnaire
#A text field : to search for a keyword or a string In a single question within a questionnaire
#A text field:For the Course name
#A text field:For the Assignment name

The user will be able to apply numerous filters at once, and the query's output will match all of them. An empty list will be returned if no results are found..

As a simple search,There is a default search box for the questionnaire's name and if a user wants to apply several filters, user need to press the "Advanced Search" button which is adjacent to the "Search" button, Also, a hidden field with text boxes for all the columns are being rendered below. A List is being displayed for the questionnaires which matches the search

In the current system for searching for a Questionnaire does not follow the DRY approach. As a result, we suggest a new system that is quite similar to the current one, but with a few tweaks to make the Questionnaire search more effective and to follow the DRY approach.

Proposed System:

The user will be able to search questionnaires in the proposed system using an advanced search option similar to the previous one; however, the back end code for implementing this functionality needs to be refactored by following DRY Approach.In the file: app/assets/javascripts/tree display.jsx code that is in common for all the searches needs to be refactored

====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==

;Rspec Tests Files
:spec/models/[https://github.com/expertiza/expertiza/blob/beta/spec/models/assignment_spec.rb assignment_spec.rb]
:spec/models/[https://github.com/expertiza/expertiza/blob/beta/spec/models/response_spec.rb response_spec.rb]
:spec/models/[https://github.com/expertiza/expertiza/blob/beta/spec/models/user_spec.rb user_spec.rb]

=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

here's some preliminary points for testing:
# We are testing only the function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Courses ====
# Log into expertiza to view the home page
# Go to Manage > Courses
# Type the search criteria fro the course (name, institution etc) in the available search box and select the appropriate field from the dropdown.
# To perform a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire.JPG|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

Banpreet Singh Chhabra (bchhabr@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-06T00:10:36Z

Ichench: /* Lo-fi UI Example */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. It is an open-source application running on Ruby on Rails. It is used for the 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 that display 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 parameter which includes 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 an advanced search feature where user can search on the basis of more than one parameters, and making the search functionality appear more elegant.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#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 criterion needs to be specified, there should be an 'Advanced Search' button.

Some of these searches are currently possible in Expertiza, but the user interface is quite cumbersome. This is especially true on an instructor’s or administrator’s homepage, where large and confusing search boxes shift the important parts of the page down to the bottom of the screen. There should be a way to do a simple search by just typing text into an unobtrusive textbox. If more criteria need to be specified, there should be an “advanced search” button or link that opens up additional textboxes, perhaps in Javascript, that are of reasonable size and do not overwhelm other content on the page.

=== E2153 Our Result ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== E2079 Previous Implementation ===
#[https://github.com/prashantyadla/expertiza/tree/beta E2079 Github Repository]
#[https://github.com/expertiza/expertiza/pull/1842 E2079 Pull Request]
#[https://drive.google.com/file/d/1yr_4b0SsN_J4qGMpZbQLzKXzWAjoX7fV/view. Video Link]

=== Issue With Previous Implementation ===
# All implementation are working on javascript inside tree_display.jsx.
# With compatibility issue, these work can't be check-in currently.
# Format are not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching of user with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

=== Comments on Previous Implementation ===
The functionality of this project is quite good, better than any previous attempt. We have some questions about whether the code is as readable as it should be.
The appearance of the search pages is now uniform, fixing a problem from the previous project attempt. However, code is still duplicated, and should be DRYed out.
Tests ""are just testing the keyword."" ??
In the tests, the it clauses say, ""allows certain action"" or ""refuses certain action"". They should be more specific!
Re. the code, there are a lot of changes to big .jsx files that may prove confusing to refactor. In tree_display.jsx, the _this variable is removed; this seems to be an overlapping edit that will have to be resolved.
It's in the same repo with their 1st OSS project, which could be a problem. However, that project was highly rated and should probably be merged too.

== Proposed Solution ==
[https://youtu.be/SxbHz9bp2L0 Demo Video]

The design proposed in this iteration of the project is not much different from a high level than the design proposed form last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]. Below you will see a similar description of the solution previously proposed and some additional design choices added to improve upon the previous iteration of this issue. Changes from the previous design will be denoted by clear statements indicating the revision.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
In the current system workflow, the Manage Users view can search users by Username, Full name, and email. We will retain these 3 searching criteria, except changing "Username" into "User ID" to avoid confusion with "Full name". We will 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.
====Implementation====
User has its own "list" controller, so it will directly implemented in list form with a "_search" html form after apply the search result. Since only this class has rails list, so only this file will implement in ruby code. Our goal is to maintain the logic and search alike.
# Delete the original simple search in "app/views/users/list.html.erb"
## Add a render for search form
## Align the UI for direct user access, which is not part of our project, but to make the page looks similar, we also change the style of it
## Align the user list table UI with style "class="table table-hover""
# Add a form in "app/views/users/_search.html.erb"
## Note that to align the UI design, the "Search" button will using style "class='btn btn-primary'"
## Note that to align the UI design, the "text blank" will using the style "class:'form-control'"
## Advanced Search toggle button is done with javascript (jquery) inside this form individually, and the form is divided into 2 separate field
### search_button_field: This part should always be displayed
### advance_search_form: This part should only display after the "Advanced Search" be toggled
# Add a form input handler in the "users_controller.rb" to parse the form, which should only do parsing and send parameters to model
# Add a advanced search feature to the User model "user.rb" inside the method "get_user_list"
## This change will cause this method to take up 3 parameters with (user id, full name, e-mail)
## We use regular expression to match the search with user fields, and it should allow multiple input for comparison
## The result will return back to controller in @users, and list view will render it again with paginated users

===Search for Courses:===
In the current system implementation, searching via the name of the course is supported with a partial or complete course name. In the proposed system, the user will be able to search for a course using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for a course by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the courses created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All courses that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.nce.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop-up advanced search functionality in React component FilterableTable.
# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The proposed system will implement search functionality for searching via below criteria:
# Keyword within Name of Questionnaire: A text field
# Keyword or a string in a single question within a questionnaire: A text field
# Course Name: A text field for the course name
# Assignment Name: A text field for the assignment

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.

There will be a default search box of the name of questionnaire as a simple search, and if a user want to apply multiple filters, the user can tap on the "Advanced Search" button which is adjacent to the "Search" button, and a hidden field will be rendered below-containing text boxes for all the columns. All the matched questionnaires will be listed at once.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:Lofi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==
=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

==== Code Snippet Added ====
Before checking the code, here's some preliminary:
# We are testing the only function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire.JPG|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

File:Lofi.jpg

2022-04-06T00:07:22Z

Ichench:

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-05T23:59:52Z

Ichench: /* Lo-fi UI Example */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. It is an open-source application running on Ruby on Rails. It is used for the 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 that display 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 parameter which includes 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 an advanced search feature where user can search on the basis of more than one parameters, and making the search functionality appear more elegant.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#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 criterion needs to be specified, there should be an 'Advanced Search' button.

Some of these searches are currently possible in Expertiza, but the user interface is quite cumbersome. This is especially true on an instructor’s or administrator’s homepage, where large and confusing search boxes shift the important parts of the page down to the bottom of the screen. There should be a way to do a simple search by just typing text into an unobtrusive textbox. If more criteria need to be specified, there should be an “advanced search” button or link that opens up additional textboxes, perhaps in Javascript, that are of reasonable size and do not overwhelm other content on the page.

=== E2153 Our Result ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== E2079 Previous Implementation ===
#[https://github.com/prashantyadla/expertiza/tree/beta E2079 Github Repository]
#[https://github.com/expertiza/expertiza/pull/1842 E2079 Pull Request]
#[https://drive.google.com/file/d/1yr_4b0SsN_J4qGMpZbQLzKXzWAjoX7fV/view. Video Link]

=== Issue With Previous Implementation ===
# All implementation are working on javascript inside tree_display.jsx.
# With compatibility issue, these work can't be check-in currently.
# Format are not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching of user with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

=== Comments on Previous Implementation ===
The functionality of this project is quite good, better than any previous attempt. We have some questions about whether the code is as readable as it should be.
The appearance of the search pages is now uniform, fixing a problem from the previous project attempt. However, code is still duplicated, and should be DRYed out.
Tests ""are just testing the keyword."" ??
In the tests, the it clauses say, ""allows certain action"" or ""refuses certain action"". They should be more specific!
Re. the code, there are a lot of changes to big .jsx files that may prove confusing to refactor. In tree_display.jsx, the _this variable is removed; this seems to be an overlapping edit that will have to be resolved.
It's in the same repo with their 1st OSS project, which could be a problem. However, that project was highly rated and should probably be merged too.

== Proposed Solution ==
[https://youtu.be/SxbHz9bp2L0 Demo Video]

The design proposed in this iteration of the project is not much different from a high level than the design proposed form last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]. Below you will see a similar description of the solution previously proposed and some additional design choices added to improve upon the previous iteration of this issue. Changes from the previous design will be denoted by clear statements indicating the revision.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
In the current system workflow, the Manage Users view can search users by Username, Full name, and email. We will retain these 3 searching criteria, except changing "Username" into "User ID" to avoid confusion with "Full name". We will 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.
====Implementation====
User has its own "list" controller, so it will directly implemented in list form with a "_search" html form after apply the search result. Since only this class has rails list, so only this file will implement in ruby code. Our goal is to maintain the logic and search alike.
# Delete the original simple search in "app/views/users/list.html.erb"
## Add a render for search form
## Align the UI for direct user access, which is not part of our project, but to make the page looks similar, we also change the style of it
## Align the user list table UI with style "class="table table-hover""
# Add a form in "app/views/users/_search.html.erb"
## Note that to align the UI design, the "Search" button will using style "class='btn btn-primary'"
## Note that to align the UI design, the "text blank" will using the style "class:'form-control'"
## Advanced Search toggle button is done with javascript (jquery) inside this form individually, and the form is divided into 2 separate field
### search_button_field: This part should always be displayed
### advance_search_form: This part should only display after the "Advanced Search" be toggled
# Add a form input handler in the "users_controller.rb" to parse the form, which should only do parsing and send parameters to model
# Add a advanced search feature to the User model "user.rb" inside the method "get_user_list"
## This change will cause this method to take up 3 parameters with (user id, full name, e-mail)
## We use regular expression to match the search with user fields, and it should allow multiple input for comparison
## The result will return back to controller in @users, and list view will render it again with paginated users

===Search for Courses:===
In the current system implementation, searching via the name of the course is supported with a partial or complete course name. In the proposed system, the user will be able to search for a course using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for a course by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the courses created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All courses that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.nce.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop-up advanced search functionality in React component FilterableTable.
# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The proposed system will implement search functionality for searching via below criteria:
# Keyword within Name of Questionnaire: A text field
# Keyword or a string in a single question within a questionnaire: A text field
# Course Name: A text field for the course name
# Assignment Name: A text field for the assignment

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.

There will be a default search box of the name of questionnaire as a simple search, and if a user want to apply multiple filters, the user can tap on the "Advanced Search" button which is adjacent to the "Search" button, and a hidden field will be rendered below-containing text boxes for all the columns. All the matched questionnaires will be listed at once.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:Lo-fi.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==
=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

==== Code Snippet Added ====
Before checking the code, here's some preliminary:
# We are testing the only function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire.JPG|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

File:Lo-fi.jpg

2022-04-05T23:57:59Z

Ichench:

CSC/ECE 517 Spring 2022 - E2233. Improving search facility in Expertiza

2022-04-03T04:01:45Z

Ichench: /* Problem Statement */

== Introduction ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. It is an open-source application running on Ruby on Rails. It is used for the 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 that display 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 parameter which includes 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 an advanced search feature where user can search on the basis of more than one parameters, and making the search functionality appear more elegant.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement ==

#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 criterion needs to be specified, there should be an 'Advanced Search' button.

Some of these searches are currently possible in Expertiza, but the user interface is quite cumbersome. This is especially true on an instructor’s or administrator’s homepage, where large and confusing search boxes shift the important parts of the page down to the bottom of the screen. There should be a way to do a simple search by just typing text into an unobtrusive textbox. If more criteria need to be specified, there should be an “advanced search” button or link that opens up additional textboxes, perhaps in Javascript, that are of reasonable size and do not overwhelm other content on the page.

=== E2153 Our Result ===
#[https://github.com/yhslo/expertiza E2153 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2165 E2153 Pull Request]
#[https://youtu.be/SxbHz9bp2L0 Demo Video]

=== E2079 Previous Implementation ===
#[https://github.com/prashantyadla/expertiza/tree/beta E2079 Github Repository]
#[https://github.com/expertiza/expertiza/pull/1842 E2079 Pull Request]
#[https://drive.google.com/file/d/1yr_4b0SsN_J4qGMpZbQLzKXzWAjoX7fV/view. Video Link]

=== Issue With Previous Implementation ===
# All implementation are working on javascript inside tree_display.jsx.
# With compatibility issue, these work can't be check-in currently.
# Format are not aligned between course search/assignment search and user search/rubric search.
# Questionnaire search is not straightforward and the list is not working.
# Searching of user with "name" and "full name" is confusing.
# Searching criteria can't be accumulated.
# Instructors and administrators can't find assignments with participants.

=== Comments on Previous Implementation ===
The functionality of this project is quite good, better than any previous attempt. We have some questions about whether the code is as readable as it should be.
The appearance of the search pages is now uniform, fixing a problem from the previous project attempt. However, code is still duplicated, and should be DRYed out.
Tests ""are just testing the keyword."" ??
In the tests, the it clauses say, ""allows certain action"" or ""refuses certain action"". They should be more specific!
Re. the code, there are a lot of changes to big .jsx files that may prove confusing to refactor. In tree_display.jsx, the _this variable is removed; this seems to be an overlapping edit that will have to be resolved.
It's in the same repo with their 1st OSS project, which could be a problem. However, that project was highly rated and should probably be merged too.

== Proposed Solution ==
[https://youtu.be/SxbHz9bp2L0 Demo Video]

The design proposed in this iteration of the project is not much different from a high level than the design proposed form last year in [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]. Below you will see a similar description of the solution previously proposed and some additional design choices added to improve upon the previous iteration of this issue. Changes from the previous design will be denoted by clear statements indicating the revision.

Three main objects in this application are used as the basis for expanding search functionality. These are the user, assignment and questionnaire. Each of these points are searchable by the title of the object or not searchable at all. The remaining sections note the current situation and propose a tentative solution.

===Search for User:===
In the current system workflow, the Manage Users view can search users by Username, Full name, and email. We will retain these 3 searching criteria, except changing "Username" into "User ID" to avoid confusion with "Full name". We will 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.
====Implementation====
User has its own "list" controller, so it will directly implemented in list form with a "_search" html form after apply the search result. Since only this class has rails list, so only this file will implement in ruby code. Our goal is to maintain the logic and search alike.
# Delete the original simple search in "app/views/users/list.html.erb"
## Add a render for search form
## Align the UI for direct user access, which is not part of our project, but to make the page looks similar, we also change the style of it
## Align the user list table UI with style "class="table table-hover""
# Add a form in "app/views/users/_search.html.erb"
## Note that to align the UI design, the "Search" button will using style "class='btn btn-primary'"
## Note that to align the UI design, the "text blank" will using the style "class:'form-control'"
## Advanced Search toggle button is done with javascript (jquery) inside this form individually, and the form is divided into 2 separate field
### search_button_field: This part should always be displayed
### advance_search_form: This part should only display after the "Advanced Search" be toggled
# Add a form input handler in the "users_controller.rb" to parse the form, which should only do parsing and send parameters to model
# Add a advanced search feature to the User model "user.rb" inside the method "get_user_list"
## This change will cause this method to take up 3 parameters with (user id, full name, e-mail)
## We use regular expression to match the search with user fields, and it should allow multiple input for comparison
## The result will return back to controller in @users, and list view will render it again with paginated users

===Search for Courses:===
In the current system implementation, searching via the name of the course is supported with a partial or complete course name. In the proposed system, the user will be able to search for a course using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for a course by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the courses created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All courses that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.nce.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop-up advanced search functionality in React component FilterableTable.
# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Assignments:===
In the current system implementation, searching via the name of the assignment is supported with a partial or complete assignment name. In the proposed system, the user will be able to search for an assignment using additional filters after they press the Advanced Search button. The filters will have creation date, updated date and a checkbox represent whether it include a quiz. The user could apply multiple filters at a time and the output of the query would match all filters applied.

To search for an assignment by Date, the user will have a drop down list to choose search by created or updated date. The following will prompt with a calendar where he can select a date and all the assignments created/update on or before the selected date will be displayed.

To apply multiple filters, the user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below-containing text boxes for all the columns. All assignments that match the filters will be returned. An empty list will be returned if the search criteria don't match any records in the database.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search". By using AdditionalSearchDropDown, DatePicker, and HASQUIZ_TOGGLE components, we build a pop up advanced search functionality in React component FilterableTable.
# Searching for courses
## The searching method is handled by ContentTable component, which filters out courses' names that match the user's input.

Due to the similarity of course search and assignment search, they share the same code in FilterableTable component.

===Search for Questionnaires:===
The proposed system will implement search functionality for searching via below criteria:
# Keyword within Name of Questionnaire: A text field
# Keyword or a string in a single question within a questionnaire: A text field
# Course Name: A text field for the course name
# Assignment Name: A text field for the assignment

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.

There will be a default search box of the name of questionnaire as a simple search, and if a user want to apply multiple filters, the user can tap on the "Advanced Search" button which is adjacent to the "Search" button, and a hidden field will be rendered below-containing text boxes for all the columns. All the matched questionnaires will be listed at once.
====Implementation====
This part is solely listed within the file "app/assets/javascripts/tree_display.jsx", so we can only implement this part with javascript. The interactive dropdown advanced search code will maintain the same format as "User Advanced Search."

# Getting sub-contents when a user press on a course
## The getSubFolderData() from FilterableTable will send HTTP POST request.
## After retrieving the data, it will update the state of FilterableTable component.
## Once the state is updated, it will trigger an update to ContentTable component and rerender the component.
#Searching for questionnaire
## The searching method is handled by FilterableTable component. Once the search button is pressed, it filters all the sub-contents from every questionnaire category based on the user input.
## handleQuestionnaireSearchChange() in FilterableTable component keeps track of the search input field. It will trigger an update when the input field has been cleared.

=== ''' Lo-fi UI Example ''' ===
[[File:42660.jpg|1000px|center]]

=== ''' Flowchart ''' ===
[[File:Flowchart.jpg|750px|center]]

== Test Plan ==
=== Rspec Unit Tests ===
Automated tests can be written to test the following functionalities:
# Given an unfiltered search result which should show all
# Given a filtered search, the result renders a list of objects containing the filtered search item
# Given an invalid search, an empty list returns
RSpec tests will be written to cover the depth of each test point above for all four search objects mentioned in the proposed solution.

==== Code Snippet Added ====
Before checking the code, here's some preliminary:
# We are testing the only function that related to the search function in model/user.rb which is used to output search result
# get_user_list(arg1, arg2, arg3), where (arg1, arg2, arg3) represents (userid, full name, email)
# For each test, we are trying to find the users with "keyword", that is, if there is user with the keyword in selected field, it should return in the list, otherwise null.
# For each test, we also checked the search function with multiple input, that is, with or without either userid, full name or email.

<pre>
# spec/models/user_spec.rb
context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abcd", "", "")).to eq([])
end
end

context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "")).to eq([user1, user2])
end
end
context 'when current user is super admin and search by user full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbcd", "")).to eq([])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "", "abcbbcd@gmail.com")).to eq([])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "")).to eq([user1, user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", " bbc", "abcbbe@gmail.com")).to eq([user2])
end
end

context 'when current user is super admin and search by user name, full name and email' do
it 'fetches all users with abc' do
allow(user).to receive_message_chain("role.super_admin?") { true }
expect(user.get_user_list("abc", "abc bbc", "abcbbc@gmail.com")).to eq([user1])
end
end
end
</pre>

=== Manual UI Testing ===
UI tests will be performed to reproduce the behavior previously mentioned. These steps were reproduced from the previously proposed solution for this issue.
Please pair with our [https://youtu.be/SxbHz9bp2L0 Demo Video] to confirm our testing
==== Search for User ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Assignment ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

==== Search for Questionnaire ====
# Log into 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 a 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 text boxes 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 don't match any valid records in the database.

== Resulting Snapshots ==
The following screenshots show before and after an advanced search for courses, assignments, and users.

You can also watch [https://youtu.be/SxbHz9bp2L0 the demo video here]

=== User Search UI ===
<li>Before Change</li>
[[File:User_BeforeEdit.png|700px]]

<li>After Change</li>
The first picture shows the page of USER search UI. The second picture shows the USER page that search by userid, name and e-mail.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:User_BeforeAdv.png|700px]]
[[File:User_AfterMultiSrch.png|700px]]

=== Course Search UI ===
<li>Before Change</li>
[[File:Course-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of COURSE searching UI. The second picture shows the searching result that search by created date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Course.JPG|700px]]
[[File:Course-date.JPG|700px]]

=== Assignment Search UI ===
<li>Before Change</li>
[[File:Assignment-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of ASSIGNMENT searching UI. The second picture shows the searching result that search by updated date.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Assignment.JPG|700px]]
[[File:Assignment-date.JPG|700px]]

=== Questionnaire Search UI ===
<li>Before Change</li>
[[File:Questionnaire-origin.JPG|700px]]

<li>After Change</li>
The first picture shows the main page of questionnaire searching UI. The second picture shows the questionnaire searching page with advance search and detail of review questionnaire.
Note that it doesn't necessarily need all parameters to search. One can search with one or two or all parameters.

[[File:Questionnaire.JPG|700px]]
[[File:Questionnaire-open.JPG|700px]]

== Project Mentor ==

Ed Gehringer (efg@ncsu.edu)

== Team Members ==

Vishnu Challa (vchalla2@ncsu.edu)

Sujith Tumma (stumma2@ncsu.edu)

Indu Chenchala (ichench@ncsu.edu)

==References==

#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza Fall 2021 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1987._Improving_search_facility_in_Expertiza Fall 2019 Design]
#[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2079._Improve_Search_Facility_In_Expertiza Fall 2020 Design]
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T23:23:25Z

Ichench:

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.

[[File:Line_91_check.JPG]]

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T22:40:11Z

Ichench:

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are two checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

*'''Solution''': <code>if @questionnaire.type == "QuizQuestionnaire"</code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because for saving a new question there is no need to check for the QuizQuestionnaire.

[[File:266_check.JPG]]

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> has been removed. Explanation is given above in the three checks for QuizQuestionnaire Problem 3

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T21:56:18Z

Ichench:

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

*'''Solution''': <code>if @questionnaire.type == "QuizQuestionnaire"</code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.

[[File:266_check.JPG]]

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> has been removed. Explanation is given above in the three checks for QuizQuestionnaire Problem 3

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T21:41:41Z

Ichench: /* Problem: There are three checks for whether a question is a QuizQuestionnaire */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

*'''Solution''': <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.

[[File:266_check.JPG]]

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> has been removed. Explanation is given above in the three checks for QuizQuestionnaire Problem 3

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T21:41:15Z

Ichench: /* Problem: There are three checks for whether a question is a QuizQuestionnaire */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

*'''Solution''': <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.====

[[File:266_check.JPG]]

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> has been removed. Explanation is given above in the three checks for QuizQuestionnaire Problem 3

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-21T04:08:27Z

Ichench:

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on refactoring <code>questionnaires_controller.rb</code> by sanding down rough edges of code throughthe removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used====
<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>
*'''Solution''': <code>create_questionnaire</code> method and its corresponding test has been removed because it was not used anywhere.

==== '''Problem''': The <code>create</code> method is 49 lines long====
*'''Solution''':<code>@questionnaire</code> initialization was moved to a new method called <code>initialize_values</code>. The questionnaire node initialization was moved to <code>create_questionnaire_node</code>.

[[File:Initialize values.JPG]]

[[File:Create questionnaire node.JPG]]

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>====
These checks are likely unnecessary, and testing the class of an object carries potential problems.
*'''Solution''': The first check was located in the <code>create_questionnaire</code> and has been deleted along with the method.

*'''Solution''': <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.===

[[File:266_check.JPG]]

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>====
Although these fields are okay to default to the given values, these should be defined constants
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter====
Although not functionally broken, this may be unnecessary in several situations where <code>params[:id]</code> would suffice
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> has been removed. Explanation is given above in the three checks for QuizQuestionnaire Problem 3

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
<code>questionnaires_controller.rb</code>

<code>scored_question.rb</code>

<code>questionnaires_controller_spec.rb</code>

== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
*Check for <code>if question.is_a? ScoredQuestion</code> has been removed.

*Explore if <code>create_questionnaire_node</code> can be moved to the <code>node</code> class

*Explore moving <code>ScoredQuestion</code> initialization into the <code>scored_question.rb</code> model.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/War-Keeper/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2320 here]

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-20T16:26:13Z

Ichench:

This page describes the changes made for the Spring 2022 OSS Project E2216: Refactoring late_policies_controller

== Description ==
Write a short description of the project
== Problems and Solutions ==
===='''Problem''':All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires.====

*'''Solution''':

===='''Problem''':create and update have some duplicate code. Fix that using a partial, _form.====

*'''Solution''':

===='''Problem''':Both create and update need comments and a better identifier naming.====

*'''Solution''':

===='''Problem''':Reduce code duplication. Find a way to make the code more DRY.====

*'''Solution''':

===='''Problem''':Line 64: The if condition can be simplified. ====

*'''Solution''':

===='''Problem''':Improve the variable name for same_policy_name. (Boolean variables can be named in a better way). ====

*'''Solution''':

===='''Problem''':Add method comments. ====

*'''Solution''':

===='''Problem''':Find the use of instance variables in create and update method? Do we really need it? Can it be made local variables instead? ====

*'''Solution''':

== Modified Files ==
(Add modified files and list of changes here)
== Testing ==
(Add any testing that were added)
=== Running Tests ===
<pre>
rspec ./spec/controllers/late_policies_controller_spec.rb
</pre>

==Pull Request==
(Add pull request link here)

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-20T15:34:01Z

Ichench: /* Future Improvements */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on sanding down the rough edges of <code>questionnaires_controller.rb</code> through the removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used.<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>.====
*'''Solution''':

==== '''Problem''': The <code>create</code> method is 49 lines long, and needs to be broken up====
*'''Solution''':

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>. These checks are likely unnecessary, and testing the class of an object carries potential problems.====
*'''Solution''':

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>. Although these fields are okay to default to the given values, these should be defined constants====
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter, this may be unnecessary in several situations where <code>params[:id]</code> would suffice====
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.
[[File:266_check.JPG]]

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
(Add modified files and list of changes here)
== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==
check for <code>if question.is_a? ScoredQuestion</code> has been removed.explore moving ScoredQuestion initialization into the scored_question model

==Pull Request==
GitHub link: https://github.com/expertiza/expertiza/pull/2320

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-20T04:00:37Z

Ichench: /* Problem: Several bad if statements exist */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on sanding down the rough edges of <code>questionnaires_controller.rb</code> through the removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used.<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>.====
*'''Solution''':

==== '''Problem''': The <code>create</code> method is 49 lines long, and needs to be broken up====
*'''Solution''':

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>. These checks are likely unnecessary, and testing the class of an object carries potential problems.====
*'''Solution''':

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>. Although these fields are okay to default to the given values, these should be defined constants====
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:

[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter, this may be unnecessary in several situations where <code>params[:id]</code> would suffice====
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:

[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is not a QuizQuestionnaire is not necessary so this line has been removed because the for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.
[[File:266_check.JPG]]

Line 190 : <code>if question.is_a? ScoredQuestion</code> check for ScoredQuestion has been removed.Also hardcoded the minlabel and max label values from <code>question.max_label = 'Strongly agree'</code> <code>question.min_label = 'Strongly disagree'</code> to
<code>question.max_label = ScoredQuestion::DEFAULT_MAX_AGREEMENT</code><code>question.min_label = ScoredQuestion::DEFAULT_MIN_AGREEMENT</code>

[[File:score.png]]

== Modified Files ==
(Add modified files and list of changes here)
== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==

==Pull Request==
GitHub link: https://github.com/expertiza/expertiza/pull/2320

File:Score.png

2022-03-20T04:00:13Z

Ichench:

File:Scored.png

2022-03-20T03:57:45Z

Ichench:

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-18T04:14:28Z

Ichench: /* Problem: Several bad if statements exist */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on sanding down the rough edges of <code>questionnaires_controller.rb</code> through the removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used.<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>.====
*'''Solution''':

==== '''Problem''': The <code>create</code> method is 49 lines long, and needs to be broken up====
*'''Solution''':

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>. These checks are likely unnecessary, and testing the class of an object carries potential problems.====
*'''Solution''':

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>. Although these fields are okay to default to the given values, these should be defined constants====
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:
[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter, this may be unnecessary in several situations where <code>params[:id]</code> would suffice====
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:
[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check.JPG]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because the for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.
[[File:266_check.JPG]]

== Modified Files ==
(Add modified files and list of changes here)
== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==

==Pull Request==
GitHub link: https://github.com/expertiza/expertiza/pull/2320

File:266 check.JPG

2022-03-18T04:13:57Z

Ichench:

File:Line 91 check.JPG

2022-03-18T04:13:05Z

Ichench:

CSC/ECE 517 Spring 2022 - E2217: Refactor questionnaires controller

2022-03-18T04:06:33Z

Ichench: /* Problem: Several bad if statements exist */

This page describes the changes made for the Spring 2022 OSS Project E2217: Refactoring Questionnaires Controller

== Description ==
This project focused on sanding down the rough edges of <code>questionnaires_controller.rb</code> through the removal of the unused ''create_questionnaire'' method, breaking up the exceedingly long ''create'' method, transfer of hardcoded values in the ''add_new_questions'' method, and general code cleanup.

== Problems and Solutions ==
===='''Problem''': The <code>create_questionnaire</code> method is not used.<code>create_questionnaire</code> has no immediate apparent calls, and appears to have the same functionality as <code>create</code>.====
*'''Solution''':

==== '''Problem''': The <code>create</code> method is 49 lines long, and needs to be broken up====
*'''Solution''':

===='''Problem''': There are three checks for whether a question is a <code>QuizQuestionnaire</code>. These checks are likely unnecessary, and testing the class of an object carries potential problems.====
*'''Solution''':

===='''Problem''': There are assignment values hardwired into the code in <code>add_new_questions</code>. Although these fields are okay to default to the given values, these should be defined constants====
*'''Solution''': As these values related to <code>ScoredQuestion</code> items, constants were created in <code>scored_question.rb</code>. <code>add_new_questions</code> now uses these class constants when assigning default values for fields. These values are all changeable in the UI after initialization.

Addition of constants to <code>scored_question.rb</code>:
[[File:Scored_question_changes.png]]

===='''Problem''': Several methods have a <code>questionnaire_id</code> as a parameter, this may be unnecessary in several situations where <code>params[:id]</code> would suffice====
*'''Solution''': Where applicable, <code>questionnaire_id</code> was changed to <code>params[:id]</code>. This was done in methods where <code>params[:id].nil?</code> was not called, and in methods where <code>questionnaire_id = params[:id]</code> was called

Change of <code>questionnaire_id</code> to <code>params[:id]</code> in <code>save_all_questions</code>:
[[File:save_all_questions_changes.png]]

===='''Problem''': Several bad <var>if</var> statements exist====
*'''Solution''': Line 96: <code>if @questionnaire.type != "QuizQuestionnaire" </code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because the QuizQuestionnaire is same as the other questionnaire types.
[[File:Line_91_check_quizquestionanire.png]]

Line 244 & 266 : <code>if @questionnaire.type != "QuizQuestionnaire"</code> checking if it is a QuizQuestionnaire is not necessary so this line has been removed because the for saving a new question there is no need to check for the QuizQuestionnaire and weights used in this check are not used anywhere.
[[File:Bad_if_quiz.JPG]]

== Modified Files ==
(Add modified files and list of changes here)
== Testing ==

=== Running Tests ===
<pre>
rspec ./spec/controllers/questionnaires_controller_spec.rb
</pre>

==Future Improvements==

==Pull Request==
GitHub link: https://github.com/expertiza/expertiza/pull/2320

File:Bad if quiz.JPG

2022-03-18T04:03:04Z

Ichench:

File:Line 91 check quizquestionanire.png

2022-03-18T03:39:42Z

Ichench: Ichench uploaded a new version of File:Line 91 check quizquestionanire.png

File:Line 91 check quizquestionanire.png

2022-03-18T03:36:23Z

Ichench: