https://wiki.expertiza.ncsu.edu/api.php?action=feedcontributions&feedformat=atom&user=Dmbhavsa 2026-08-08T00:22:30Z User contributions MediaWiki 1.41.0 https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124732 2019-04-27T03:50:52Z

<p>Dmbhavsa: /* Video Folder Link */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> * Also, placeholders are removed from the search text bars in advanced search because it looked ugly. Also, labels for each search text box has been added directly above it so that the user can easily identify what parameter that text field contains.<br /> * Also, code has been refactored because it was a lot of bad jumble in all the cases.<br /> * Comments have been extensively added throughout the code which are informative and helpful<br /> * Search functionality for Courses has been added as well.<br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ====Courses====<br /> *Search fields<br /> **Name<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> ** As extensive as these tests were, everything was found to be working correctly.<br /> ** Feedback was taken as to where changes needed to be made and respective changes were made where necessary.<br /> *Automated RSpec testing<br /> ** Tests were included for all the code refactoring done (making new subroutines and moving code.)<br /> ** Also, there were extensive tests written for the search functionality which was dependent on the user that was logged in. <br /> ** Basically, super admin were to be tested on different data than, TAs and instructors.<br /> ** As an example:-<br /> &lt;pre&gt;<br /> before(:each) do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.ta?&quot;) { false }<br /> allow(SuperAdministrator).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Instructor).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Ta).to receive(:get_user_list).and_return([user1, user2])<br /> end<br /> <br /> context 'when current user is super admin' do<br /> it 'fetches all users' do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> <br /> context 'when current user is an instructor' do<br /> it 'fetches all users in his/her course/assignment' do<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> ==Video Folder Link==<br /> [https://drive.google.com/drive/folders/1n2ad93BbOd1-0BffG_RyTuyZqyphDAdL?usp=sharing|video]<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124731 2019-04-27T03:50:00Z

<p>Dmbhavsa: </p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> * Also, placeholders are removed from the search text bars in advanced search because it looked ugly. Also, labels for each search text box has been added directly above it so that the user can easily identify what parameter that text field contains.<br /> * Also, code has been refactored because it was a lot of bad jumble in all the cases.<br /> * Comments have been extensively added throughout the code which are informative and helpful<br /> * Search functionality for Courses has been added as well.<br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ====Courses====<br /> *Search fields<br /> **Name<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> ** As extensive as these tests were, everything was found to be working correctly.<br /> ** Feedback was taken as to where changes needed to be made and respective changes were made where necessary.<br /> *Automated RSpec testing<br /> ** Tests were included for all the code refactoring done (making new subroutines and moving code.)<br /> ** Also, there were extensive tests written for the search functionality which was dependent on the user that was logged in. <br /> ** Basically, super admin were to be tested on different data than, TAs and instructors.<br /> ** As an example:-<br /> &lt;pre&gt;<br /> before(:each) do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.ta?&quot;) { false }<br /> allow(SuperAdministrator).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Instructor).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Ta).to receive(:get_user_list).and_return([user1, user2])<br /> end<br /> <br /> context 'when current user is super admin' do<br /> it 'fetches all users' do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> <br /> context 'when current user is an instructor' do<br /> it 'fetches all users in his/her course/assignment' do<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> ==Video Folder Link==<br /> [https://drive.google.com/drive/folders/1n2ad93BbOd1-0BffG_RyTuyZqyphDAdL?usp=sharing]<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124730 2019-04-27T03:46:43Z

<p>Dmbhavsa: /* Test Plan: */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> * Also, placeholders are removed from the search text bars in advanced search because it looked ugly. Also, labels for each search text box has been added directly above it so that the user can easily identify what parameter that text field contains.<br /> * Also, code has been refactored because it was a lot of bad jumble in all the cases.<br /> * Comments have been extensively added throughout the code which are informative and helpful<br /> * Search functionality for Courses has been added as well.<br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ====Courses====<br /> *Search fields<br /> **Name<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> ** As extensive as these tests were, everything was found to be working correctly.<br /> ** Feedback was taken as to where changes needed to be made and respective changes were made where necessary.<br /> *Automated RSpec testing<br /> ** Tests were included for all the code refactoring done (making new subroutines and moving code.)<br /> ** Also, there were extensive tests written for the search functionality which was dependent on the user that was logged in. <br /> ** Basically, super admin were to be tested on different data than, TAs and instructors.<br /> ** As an example:-<br /> &lt;pre&gt;<br /> before(:each) do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.ta?&quot;) { false }<br /> allow(SuperAdministrator).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Instructor).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Ta).to receive(:get_user_list).and_return([user1, user2])<br /> end<br /> <br /> context 'when current user is super admin' do<br /> it 'fetches all users' do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> <br /> context 'when current user is an instructor' do<br /> it 'fetches all users in his/her course/assignment' do<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124729 2019-04-27T03:45:27Z

<p>Dmbhavsa: /* Test Plan: */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> * Also, placeholders are removed from the search text bars in advanced search because it looked ugly. Also, labels for each search text box has been added directly above it so that the user can easily identify what parameter that text field contains.<br /> * Also, code has been refactored because it was a lot of bad jumble in all the cases.<br /> * Comments have been extensively added throughout the code which are informative and helpful<br /> * Search functionality for Courses has been added as well.<br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ====Courses====<br /> *Search fields<br /> **Name<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> ** As extensive as these tests were, everything was found to be working correctly.<br /> ** Feedback was taken as to where changes needed to be made and respective changes were made where necessary.<br /> *Automated RSpec testing<br /> ** Tests were included for all the code refactoring done (making new subroutines and moving code.)<br /> ** Also, there were extensive tests written for the search functionality which was dependent on the user that was logged in. <br /> ** Basically, super admin were to be tested on different data than, TAs and instructors.<br /> &lt;pre&gt;<br /> before(:each) do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { false }<br /> allow(user).to receive_message_chain(&quot;role.ta?&quot;) { false }<br /> allow(SuperAdministrator).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Instructor).to receive(:get_user_list).and_return([user1, user2])<br /> allow(Ta).to receive(:get_user_list).and_return([user1, user2])<br /> end<br /> <br /> context 'when current user is super admin' do<br /> it 'fetches all users' do<br /> allow(user).to receive_message_chain(&quot;role.super_admin?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> <br /> context 'when current user is an instructor' do<br /> it 'fetches all users in his/her course/assignment' do<br /> allow(user).to receive_message_chain(&quot;role.instructor?&quot;) { true }<br /> expect(user.get_user_list).to eq([user1, user2])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124717 2019-04-27T03:04:03Z

<p>Dmbhavsa: /* Proposed Code Changes */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> * Also, placeholders are removed from the search text bars in advanced search because it looked ugly. Also, labels for each search text box has been added directly above it so that the user can easily identify what parameter that text field contains.<br /> * Also, code has been refactored because it was a lot of bad jumble in all the cases.<br /> * Comments have been extensively added throughout the code which are informative and helpful<br /> * Search functionality for Courses has been added as well.<br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ====Courses====<br /> *Search fields<br /> **Name<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124709 2019-04-27T02:59:58Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124708 2019-04-27T02:59:19Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|border|700px]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|border|800px]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124706 2019-04-27T02:58:08Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|center|700px]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|center|800px]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124704 2019-04-27T02:57:30Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|center|500px]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|center|300px]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124701 2019-04-27T02:56:07Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png|center]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png|center]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124699 2019-04-27T02:55:17Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png]]<br /> * As seen in the image, the advanced search is closed at the start. When it is clicked on, it pops up as shown in the image below.<br /> * There is also an option of hiding the advanced search bar.<br /> [[Image:Screenshot (98).png]]<br /> * Important changes made in the pop-up of advanced search bar context was that, before when we tested the functionality it was found that if you had searched something prior in the advanced search bar, then if you hide the advanced search bar, the data remains persistent until it is removed manually.<br /> * Hence, if you search again now, it will take the prior advanced search criteria into consideration as well. <br /> * But now, the functionality has been changes to completely erase the data from the text boxes once it is hidden. So unwanted parameters are not included in the search.<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124697 2019-04-27T02:51:37Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png]]<br /> <br /> <br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124696 2019-04-27T02:51:23Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (101).png]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=File:Screenshot_(101).png&diff=124695 2019-04-27T02:50:00Z

<p>Dmbhavsa: </p> <hr /> <div></div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124694 2019-04-27T02:47:57Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Photo.png]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124692 2019-04-27T02:46:42Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:photo.png]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124691 2019-04-27T02:45:15Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (100).png]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124690 2019-04-27T02:44:15Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (100).jpg]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124689 2019-04-27T02:43:07Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (100)_Ll.jpg]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124688 2019-04-27T02:42:19Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (100)_Ll.png]]<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124687 2019-04-27T02:40:04Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124686 2019-04-27T02:39:52Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png|500px|Image:500 pixels]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124685 2019-04-27T02:39:33Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124684 2019-04-27T02:39:21Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png|500px]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124683 2019-04-27T02:39:09Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124682 2019-04-27T02:38:55Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124681 2019-04-27T02:38:44Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124680 2019-04-27T02:38:22Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png|500px]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124679 2019-04-27T02:38:12Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png|500px|File:500 pixels]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124678 2019-04-27T02:37:50Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124677 2019-04-27T02:37:39Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png|500px|Image:<br /> 500 pixels]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124676 2019-04-27T02:37:08Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[Image:Screenshot (98).png|500px|Image:500 pixels]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124675 2019-04-27T02:35:01Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png | 500px]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124672 2019-04-27T02:24:36Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot (98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124671 2019-04-27T02:24:15Z

<p>Dmbhavsa: /* Screenshots */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot(98).png]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124667 2019-04-27T02:22:47Z

<p>Dmbhavsa: </p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Screenshots==<br /> [[File:Screenshot(98).jpg]]<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=File:Screenshot_(98).png&diff=124665 2019-04-27T02:22:13Z

<p>Dmbhavsa: </p> <hr /> <div></div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=124196 2019-04-23T21:47:02Z

<p>Dmbhavsa: </p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu<br /> <br /> ==Pull Request==<br /> https://github.com/expertiza/expertiza/pull/1452</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=123702 2019-04-09T03:25:21Z

<p>Dmbhavsa: /* Contributors */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros<br /> *Yuzhe Zhu</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=123701 2019-04-09T03:20:40Z

<p>Dmbhavsa: </p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing<br /> <br /> ==Contributors==<br /> *Dharmang Bhavsar<br /> *Vismay Golwala<br /> *Jason Katsaros</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=123700 2019-04-09T03:12:09Z

<p>Dmbhavsa: /* Test Plan: */</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> *User Interface manual testing<br /> *Automated RSpec testing</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019&diff=123699 2019-04-09T03:10:51Z

<p>Dmbhavsa: </p> <hr /> <div>*[[CSC/ECE 517 Spring 2019 - Project E1930. Improving Search Facility in Expertiza]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1916. Fix Code Climate issues in controllers with names beginning with A through N]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project M1901 Implement missing WebAudio automation support]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1917. Fix Code Climate issues in controllers with names beginning with P through Z]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1921. Write tests for popup controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - M1902 Refactor bluetooth support for better maintainability]]<br /> *[[CSC/ECE 517 Spring 2019 - E1922. Write tests for assessment360 controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1907 Refactor response controller]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1903._Create_quiz_questionnaires_controller.rb]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1913. Refactor_review_mapping_helper.rb]]<br /> *[[CSC/ECE_517_Spring_2019_-_E1919_CodeClimate_Issues]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1912. Export_Tagged_Comments]]<br /> *[[CSC/ECE_517_Spring_2019/E1927_Let_Course_Staff_as_Well_as_Students_Do_Reviews]]<br /> *[[E1911_Refactor_Criterion]]<br /> *[[E1934 - Grading Audit Trail]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1925. Refactor E1858. Github metrics integration]]</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1930._Improving_Search_Facility_in_Expertiza&diff=123698 2019-04-09T03:10:31Z

<p>Dmbhavsa: Created page with &quot;==Introduction:== The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display informa...&quot;</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> ===User Interface manual testing<br /> ===Automated RSpec testing</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019&diff=123697 2019-04-09T02:59:20Z

<p>Dmbhavsa: </p> <hr /> <div>*[[CSC/ECE 517 Spring 2019 - Project E1909. Improving Search Facility in Expertiza]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1916. Fix Code Climate issues in controllers with names beginning with A through N]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project M1901 Implement missing WebAudio automation support]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1917. Fix Code Climate issues in controllers with names beginning with P through Z]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1921. Write tests for popup controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - M1902 Refactor bluetooth support for better maintainability]]<br /> *[[CSC/ECE 517 Spring 2019 - E1922. Write tests for assessment360 controller.rb]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1907 Refactor response controller]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1903._Create_quiz_questionnaires_controller.rb]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1913. Refactor_review_mapping_helper.rb]]<br /> *[[CSC/ECE_517_Spring_2019_-_E1919_CodeClimate_Issues]]<br /> *[[CSC/ECE_517_Spring_2019_-_Project_E1912. Export_Tagged_Comments]]<br /> *[[CSC/ECE_517_Spring_2019/E1927_Let_Course_Staff_as_Well_as_Students_Do_Reviews]]<br /> *[[E1911_Refactor_Criterion]]<br /> *[[E1934 - Grading Audit Trail]]<br /> *[[CSC/ECE 517 Spring 2019 - Project E1925. Refactor E1858. Github metrics integration]]</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1909._Improving_Search_Facility_in_Expertiza&diff=123696 2019-04-09T02:58:12Z

<p>Dmbhavsa: Created page with &quot;==Introduction:== The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display informa...&quot;</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> === UI Tests ===<br /> ====Search for User====<br /> Setup: create a user with name=&quot;student&quot; and userId=&quot;5000&quot;&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; in textbox enters name=&quot;student&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; advanced search-&gt;clicks on checkbox student id and enters &quot;5000&quot; and click &quot;ok&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> <br /> ====Search for Assignments====<br /> Setup create an assignment with name=&quot;assignment&quot; and set a due date&lt;br&gt;&lt;br&gt;<br /> Action : Instructor clicks on Manage -&gt; Assignments, in textbox enter &quot;assignment&quot; in relevant tab&lt;br&gt; <br /> Response : Relevant assignment should be displayed&lt;br&gt;<br /> <br /> Action : Instructor clicks on Manage -&gt; Assignments-&gt; drop down and apply filters for due date and enter date and click &quot;ok&quot;&lt;br&gt;<br /> Response : Relevant assignments should be displayed&lt;br&gt;<br /> <br /> ====Search for Questionnaires====<br /> Setup : Create a Questionnaire, add questions to it&lt;br&gt;<br /> Action : Log in as instructor, Manage -&gt; Questionnaires, in text box enter text&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Questionnaires, click advanced search and check creation date and enter value&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> ====Search for Reviews====<br /> Setup : Setup review for an assignment, login as student and then add review &lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Assignments, Click on Review Report icon on corresponding assignment&lt;br&gt;<br /> Result : Review should be seen&lt;br&gt;<br /> <br /> Action : Click Advanced search, check review by text and enter text&lt;br&gt; <br /> Result : Matching review should be visible&lt;br&gt;<br /> <br /> === Automated Tests ===<br /> Automated tests in RSpec will be added as we implement the search functionality for each Model &lt;br&gt;<br /> Most tests added will be unit tests that cover the test cases for each flow and changes in the model.&lt;br&gt;<br /> Test Details <br /> * User Model ( spec/models/user_spec.rb )<br /> # Search by user name<br /> # Search by user name that does not exist<br /> # Search by user email<br /> # Search by user email that does not exist<br /> # Search by user email containing a substring<br /> # Search by user full name<br /> # Search by user full name is empty<br /> # Search by user name and email</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=User_talk:Dmbhavsa&diff=123695 2019-04-09T02:53:01Z

<p>Dmbhavsa: </p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> === UI Tests ===<br /> ====Search for User====<br /> Setup: create a user with name=&quot;student&quot; and userId=&quot;5000&quot;&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; in textbox enters name=&quot;student&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; advanced search-&gt;clicks on checkbox student id and enters &quot;5000&quot; and click &quot;ok&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> <br /> ====Search for Assignments====<br /> Setup create an assignment with name=&quot;assignment&quot; and set a due date&lt;br&gt;&lt;br&gt;<br /> Action : Instructor clicks on Manage -&gt; Assignments, in textbox enter &quot;assignment&quot; in relevant tab&lt;br&gt; <br /> Response : Relevant assignment should be displayed&lt;br&gt;<br /> <br /> Action : Instructor clicks on Manage -&gt; Assignments-&gt; drop down and apply filters for due date and enter date and click &quot;ok&quot;&lt;br&gt;<br /> Response : Relevant assignments should be displayed&lt;br&gt;<br /> <br /> ====Search for Questionnaires====<br /> Setup : Create a Questionnaire, add questions to it&lt;br&gt;<br /> Action : Log in as instructor, Manage -&gt; Questionnaires, in text box enter text&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Questionnaires, click advanced search and check creation date and enter value&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> ====Search for Reviews====<br /> Setup : Setup review for an assignment, login as student and then add review &lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Assignments, Click on Review Report icon on corresponding assignment&lt;br&gt;<br /> Result : Review should be seen&lt;br&gt;<br /> <br /> Action : Click Advanced search, check review by text and enter text&lt;br&gt; <br /> Result : Matching review should be visible&lt;br&gt;<br /> <br /> === Automated Tests ===<br /> Automated tests in RSpec will be added as we implement the search functionality for each Model &lt;br&gt;<br /> Most tests added will be unit tests that cover the test cases for each flow and changes in the model.&lt;br&gt;<br /> Test Details <br /> * User Model ( spec/models/user_spec.rb )<br /> # Search by user name<br /> # Search by user name that does not exist<br /> # Search by user email<br /> # Search by user email that does not exist<br /> # Search by user email containing a substring<br /> # Search by user full name<br /> # Search by user full name is empty<br /> # Search by user name and email<br /> <br /> ==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> === UI Tests ===<br /> ====Search for User====<br /> Setup: create a user with name=&quot;student&quot; and userId=&quot;5000&quot;&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; in textbox enters name=&quot;student&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; advanced search-&gt;clicks on checkbox student id and enters &quot;5000&quot; and click &quot;ok&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> <br /> ====Search for Assignments====<br /> Setup create an assignment with name=&quot;assignment&quot; and set a due date&lt;br&gt;&lt;br&gt;<br /> Action : Instructor clicks on Manage -&gt; Assignments, in textbox enter &quot;assignment&quot; in relevant tab&lt;br&gt; <br /> Response : Relevant assignment should be displayed&lt;br&gt;<br /> <br /> Action : Instructor clicks on Manage -&gt; Assignments-&gt; drop down and apply filters for due date and enter date and click &quot;ok&quot;&lt;br&gt;<br /> Response : Relevant assignments should be displayed&lt;br&gt;<br /> <br /> ====Search for Questionnaires====<br /> Setup : Create a Questionnaire, add questions to it&lt;br&gt;<br /> Action : Log in as instructor, Manage -&gt; Questionnaires, in text box enter text&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Questionnaires, click advanced search and check creation date and enter value&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> ====Search for Reviews====<br /> Setup : Setup review for an assignment, login as student and then add review &lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Assignments, Click on Review Report icon on corresponding assignment&lt;br&gt;<br /> Result : Review should be seen&lt;br&gt;<br /> <br /> Action : Click Advanced search, check review by text and enter text&lt;br&gt; <br /> Result : Matching review should be visible&lt;br&gt;<br /> <br /> === Automated Tests ===<br /> Automated tests in RSpec will be added as we implement the search functionality for each Model &lt;br&gt;<br /> Most tests added will be unit tests that cover the test cases for each flow and changes in the model.&lt;br&gt;<br /> Test Details <br /> * User Model ( spec/models/user_spec.rb )<br /> # Search by user name<br /> # Search by user name that does not exist<br /> # Search by user email<br /> # Search by user email that does not exist<br /> # Search by user email containing a substring<br /> # Search by user full name<br /> # Search by user full name is empty<br /> # Search by user name and email</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=User_talk:Dmbhavsa&diff=123694 2019-04-09T02:52:44Z

<p>Dmbhavsa: Created page with &quot;==Introduction:== The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display informa...&quot;</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> === UI Tests ===<br /> ====Search for User====<br /> Setup: create a user with name=&quot;student&quot; and userId=&quot;5000&quot;&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; in textbox enters name=&quot;student&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; advanced search-&gt;clicks on checkbox student id and enters &quot;5000&quot; and click &quot;ok&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> <br /> ====Search for Assignments====<br /> Setup create an assignment with name=&quot;assignment&quot; and set a due date&lt;br&gt;&lt;br&gt;<br /> Action : Instructor clicks on Manage -&gt; Assignments, in textbox enter &quot;assignment&quot; in relevant tab&lt;br&gt; <br /> Response : Relevant assignment should be displayed&lt;br&gt;<br /> <br /> Action : Instructor clicks on Manage -&gt; Assignments-&gt; drop down and apply filters for due date and enter date and click &quot;ok&quot;&lt;br&gt;<br /> Response : Relevant assignments should be displayed&lt;br&gt;<br /> <br /> ====Search for Questionnaires====<br /> Setup : Create a Questionnaire, add questions to it&lt;br&gt;<br /> Action : Log in as instructor, Manage -&gt; Questionnaires, in text box enter text&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Questionnaires, click advanced search and check creation date and enter value&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> ====Search for Reviews====<br /> Setup : Setup review for an assignment, login as student and then add review &lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Assignments, Click on Review Report icon on corresponding assignment&lt;br&gt;<br /> Result : Review should be seen&lt;br&gt;<br /> <br /> Action : Click Advanced search, check review by text and enter text&lt;br&gt; <br /> Result : Matching review should be visible&lt;br&gt;<br /> <br /> === Automated Tests ===<br /> Automated tests in RSpec will be added as we implement the search functionality for each Model &lt;br&gt;<br /> Most tests added will be unit tests that cover the test cases for each flow and changes in the model.&lt;br&gt;<br /> Test Details <br /> * User Model ( spec/models/user_spec.rb )<br /> # Search by user name<br /> # Search by user name that does not exist<br /> # Search by user email<br /> # Search by user email that does not exist<br /> # Search by user email containing a substring<br /> # Search by user full name<br /> # Search by user full name is empty<br /> # Search by user name and email</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1905._Refactor_questionnaires_controller.rb&diff=123693 2019-04-09T02:50:27Z

<p>Dmbhavsa: Bug image fix</p> <hr /> <div>===Description of the project===<br /> The questionnaires controller had several issues; this project aimed to address some of them, including:<br /> <br /> * Remove or move logic that should reside elsewhere, e.g. in a model class.<br /> * Remove logic and references to logic that is no longer being used.<br /> <br /> ===Files modified in the project===<br /> # app/controllers/questionnaires_controller.rb<br /> # app/models/questionnaire.rb<br /> # app/views/questionnaires/_questionnaire.html.erb<br /> # app/views/questionnaires/edit_questionnaire.html.erb (deleted)<br /> # spec/controllers/questionnaires_controller_spec.rb<br /> # spec/models/questionnaire_spec.rb<br /> <br /> ===Issues and Improvements===<br /> <br /> ====The ''assign_instructor_id'' method====<br /> <br /> =====Problems=====<br /> This method had two issues:<br /> # Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.<br /> # It was delving into implementation details of the ''User'' class.<br /> <br /> =====Solution=====<br /> The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:<br /> &lt;pre&gt;<br /> session[:user].instructor_id<br /> &lt;/pre&gt;<br /> <br /> A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.<br /> <br /> ====The ''export'' and ''import'' methods and ''edit_questionnaires.html.erb''====<br /> <br /> =====Problems=====<br /> These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.<br /> <br /> =====Solution=====<br /> * The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.<br /> * The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.<br /> <br /> ====The 'copy' and 'copy_questionnaire_details' methods====<br /> <br /> =====Problems=====<br /> <br /> #There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.<br /> #There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.<br /> <br /> =====Solution=====<br /> * Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.<br /> * So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.<br /> * The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.<br /> * The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.<br /> <br /> ====Making code DRYer====<br /> <br /> =====Problems=====<br /> <br /> #There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb. <br /> <br /> =====Solution=====<br /> * To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.<br /> * Calls were made to this method wherever QuizQuestionChoice was made.<br /> <br /> === Test Plan ===<br /> There is no means of testing the removal of dead code, except to run the existing suite of test cases:<br /> &lt;pre&gt;<br /> rspec spec<br /> &lt;/pre&gt;<br /> Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:<br /> &lt;pre&gt;<br /> rspec spec/controllers/questionnaires_controller_spec.rb<br /> &lt;/pre&gt;<br /> Testing the method ''create_quiz_question_choice'' can likewise be done with this command. <br /> The logic associated with getting the instructor ID from a user is tested using<br /> &lt;pre&gt;<br /> rspec spec/models/user_spec.rb<br /> &lt;/pre&gt;<br /> The additions to the questionnaires model can be tested using<br /> &lt;pre&gt;<br /> rspec spec/models/questionnaire_spec.rb<br /> &lt;/pre&gt;<br /> Note: If you are having difficulties running the ''rspec'' command, try using<br /> &lt;pre&gt;<br /> bundle exec rspec<br /> &lt;/pre&gt;<br /> instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.<br /> <br /> Also, tests were included for the code movement from the questionnaires controller to the questionnaire model. Checks were being made for database calls in the controller rspec method, the same format was followed while writing tests for the moved methods.</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=User:Dmbhavsa&diff=123692 2019-04-09T02:40:40Z

<p>Dmbhavsa: E1909: Search functionality in Expertiza</p> <hr /> <div>==Introduction:==<br /> <br /> The Expertiza application running on Ruby on Rails is used for a variety of purposes by students and faculty members. There are many pages that display information about students, assignments, rubrics and reviews. The information is displayed with attributes like name, ID, due date etc. This project works on improving the search facility by adding search criteria in existing search bars, making it look elegant and adding search bars if not present.<br /> <br /> <br /> ==Problem Definition:==<br /> <br /> # An instructor or administrator can search for a user by name, user-ID, or other characteristics.<br /> # An instructor should be able to search for assignments by name, due date, or other characteristics.<br /> # 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.<br /> ## 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.<br /> ## One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.<br /> #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.<br /> #An instructor or administrator should be able to search for all the assignments that a particular user has participated in.<br /> #If more than one criteria needs to be specified, there should be an 'Advanced Search' button.<br /> <br /> <br /> ==Proposed Solution:==<br /> <br /> ===Search for User:===<br /> <br /> In the current system workflow the user is able to search for a particular user by entering a partial or a complete text that matches with the user name. In the proposed workflow searching by name, searching by User ID will also be supported. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Users<br /> :#Type the name of the user in the search box available below the ‘Users’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters. <br /> :#All the entries that match the given criteria will be returned.<br /> <br /> <br /> ===Search for Assignments:===<br /> <br /> In the current system implementation, searching via the name of the assignment is supported. In the proposed system, the user will be able to search for an assignment using additional filters such as date created, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for an assignment by creation date, the user can enter a time duration within which the assignment was created. All assignments that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update.<br /> <br /> Steps to reproduce the proposed workflow:<br /> :#Log in to expertiza to view the home page<br /> :#Go to Manage &gt; Assignments<br /> :#Type the name of the assignment in the search box available below the ‘Assignments’ tab<br /> :#In the dropdown list that opens up, click on the ‘Advanced Search’ button if you wish to apply more filters ( date of creation, date updated).<br /> :#All the entries that match the given criteria will be returned.<br /> <br /> ===Search for Questionnaires:===<br /> <br /> The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the question within a questionnaire, date of creation, date updated. The user will be able to apply multiple filters at a time and the output of the query will match all filter applied. If no results are found an empty list will be returned.<br /> <br /> To search for a course by creation date, the user can enter a time duration within which the course was created. All courses that were created within this date range and which match other filters will be returned. The procedure is same for searching by date of update. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.<br /> <br /> All the above will be available under Manage &gt; Questionnaires.<br /> <br /> <br /> ===Search for Reviews:===<br /> <br /> The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc.<br /> <br /> ==Use Case Diagram==<br /> [[File:Usecase search.png|center]]<br /> <br /> == Proposed Code Changes ==<br /> We though about 2 ways of adding the search functionality in the system <br /> :# Adding a search controller to the system <br /> :# Adding search functionality to individual models <br /> <br /> ===Adding a search controller ===<br /> If we followed this approach the search query would be like <br /> *localhost:port/search/user?name=&lt;&gt;<br /> *localhost:port/search/assignment?name=&lt;&gt;<br /> <br /> This would mean that we are thinking of search as a resource on the system which to us looked as a wrong approach<br /> <br /> <br /> ===Adding search functionality to individual models===<br /> <br /> If we followed this approach the search query would be like <br /> :#localhost:port/user/search?name=&lt;&gt;<br /> :#localhost:port/assignment/search?name=&lt;&gt;<br /> <br /> On discussions we concluded that that the latter was a more RESTFul design <br /> For most of the cases we have tried to minimize the changes required in the respective model by reuse<br /> We propose to add search methods in each model for corresponding changes. <br /> <br /> Therefore in order to perform search every entity required changes in all the three layers <br /> *View : Changes in view are changes added to UI, and it is used to pass search parameters to controller <br /> *Controller : Parses the changes from UI, essentially takes params[] hash.<br /> *Model : Bulk of search logic is implemented here, once the model gets the parameters for the search ( hash ), the query is incrementally built using all the params and then executed to get the list of objects. <br /> <br /> User changes have been handled differently than for Questionnaire, Assignments and Review because Users follows the traditional RoR scheme, where as others user React for UI. <br /> React based View changes are in app/assets/javascripts/tree_display.jsx. <br /> <br /> ====User====<br /> * Search fields<br /> ** username<br /> ** name<br /> ** email<br /> <br /> * Modified files:<br /> ** app/views/users/list.html.erb<br /> ** app/controllers/users_controller.rb<br /> ** app/models/user.rb<br /> <br /> * Modified functions<br /> ** UsersController#list : Parses the username, name and email from the params hash. <br /> ** User#get_user_list : Model returns list of users to the view, changes in this function uses regex to filter out the entries that do not match search params.<br /> <br /> ====Assignment====<br /> * Search fields <br /> ** name<br /> ** assignee_username<br /> ** assignee_name<br /> ** due_date_before<br /> ** due_date_after<br /> ** created_before<br /> ** created_after<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/assignment_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#initialize_fnode_update_children<br /> ** TreeDisplayController#update_fnode_children<br /> ** AssignmentNode.get<br /> <br /> ====Questionnaire====<br /> * Search fields<br /> ** name<br /> ** text<br /> ** course<br /> ** assignment<br /> <br /> * Modified files<br /> ** app/assets/javascripts/tree_display.jsx<br /> ** app/controllers/tree_display_controller.rb<br /> ** app/models/questionnaire_node.rb<br /> <br /> * Modified functions<br /> ** TreeDisplayController#get_tmp_res<br /> ** QuestionnaireNode.get<br /> <br /> ====Review====<br /> * Search fields<br /> ** team<br /> ** text<br /> ** min_score<br /> ** max_score<br /> <br /> * Modified files<br /> ** app/views/review_mapping/_searchbox.html.erb<br /> ** app/controllers/review_mapping_controller.rb<br /> ** app/helpers/summary_helper.rb<br /> <br /> * Modified functions<br /> ** ReviewMappingController#response_report<br /> ** SummaryHelper#summarize_reviews_by_reviewees<br /> <br /> ==Database Design==<br /> <br /> ===ER Diagram:===<br /> The simplified version of ER Diagram depicts relationships between the entity sets that are used in the system. Many-to-many relationships are identified by named-diamonds - teams_users, assignment_questionnaires, which are implemented as tables.<br /> [[File:ER diagram.png|center]]<br /> <br /> <br /> ===Relevant Tables===<br /> [[File:User table.png|center]]<br /> <br /> [[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]<br /> <br /> ==Test Plan: ==<br /> We plan to two types of testing <br /> === UI Tests ===<br /> ====Search for User====<br /> Setup: create a user with name=&quot;student&quot; and userId=&quot;5000&quot;&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; in textbox enters name=&quot;student&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> &lt;br&gt;<br /> Action: Instructor clicks on manage - &gt; users -&gt; advanced search-&gt;clicks on checkbox student id and enters &quot;5000&quot; and click &quot;ok&quot;&lt;br&gt;<br /> Response: Relevant details of student, name=&quot;student&quot; is displayed&lt;br&gt;<br /> <br /> ====Search for Assignments====<br /> Setup create an assignment with name=&quot;assignment&quot; and set a due date&lt;br&gt;&lt;br&gt;<br /> Action : Instructor clicks on Manage -&gt; Assignments, in textbox enter &quot;assignment&quot; in relevant tab&lt;br&gt; <br /> Response : Relevant assignment should be displayed&lt;br&gt;<br /> <br /> Action : Instructor clicks on Manage -&gt; Assignments-&gt; drop down and apply filters for due date and enter date and click &quot;ok&quot;&lt;br&gt;<br /> Response : Relevant assignments should be displayed&lt;br&gt;<br /> <br /> ====Search for Questionnaires====<br /> Setup : Create a Questionnaire, add questions to it&lt;br&gt;<br /> Action : Log in as instructor, Manage -&gt; Questionnaires, in text box enter text&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Questionnaires, click advanced search and check creation date and enter value&lt;br&gt;<br /> Response : Questionnaires matching text are shown&lt;br&gt;<br /> <br /> ====Search for Reviews====<br /> Setup : Setup review for an assignment, login as student and then add review &lt;br&gt;<br /> <br /> Action : Log in as instructor, Manage -&gt; Assignments, Click on Review Report icon on corresponding assignment&lt;br&gt;<br /> Result : Review should be seen&lt;br&gt;<br /> <br /> Action : Click Advanced search, check review by text and enter text&lt;br&gt; <br /> Result : Matching review should be visible&lt;br&gt;<br /> <br /> === Automated Tests ===<br /> Automated tests in RSpec will be added as we implement the search functionality for each Model &lt;br&gt;<br /> Most tests added will be unit tests that cover the test cases for each flow and changes in the model.&lt;br&gt;<br /> Test Details <br /> * User Model ( spec/models/user_spec.rb )<br /> # Search by user name<br /> # Search by user name that does not exist<br /> # Search by user email<br /> # Search by user email that does not exist<br /> # Search by user email containing a substring<br /> # Search by user full name<br /> # Search by user full name is empty<br /> # Search by user name and email</div>

Dmbhavsa https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2019_-_Project_E1905._Refactor_questionnaires_controller.rb&diff=123152 2019-04-02T16:05:05Z

<p>Dmbhavsa: </p> <hr /> <div>[[File:Example.jpg]]__TOC__<br /> <br /> ===Description of the project===<br /> The questionnaires controller had several issues; this project aimed to address some of them, including:<br /> <br /> * Remove or move logic that should reside elsewhere, e.g. in a model class.<br /> * Remove logic and references to logic that is no longer being used.<br /> <br /> ===Files modified in the project===<br /> # app/controllers/questionnaires_controller.rb<br /> # app/models/questionnaire.rb<br /> # app/views/questionnaires/_questionnaire.html.erb<br /> # app/views/questionnaires/edit_questionnaire.html.erb (deleted)<br /> # spec/controllers/questionnaires_controller_spec.rb<br /> # spec/models/questionnaire_spec.rb<br /> <br /> ===Issues and Improvements===<br /> <br /> ====The ''assign_instructor_id'' method====<br /> <br /> =====Problems=====<br /> This method had two issues:<br /> # Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.<br /> # It was delving into implementation details of the ''User'' class.<br /> <br /> =====Solution=====<br /> The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:<br /> &lt;pre&gt;<br /> session[:user].instructor_id<br /> &lt;/pre&gt;<br /> <br /> A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.<br /> <br /> ====The ''export'' and ''import'' methods====<br /> <br /> =====Problems=====<br /> These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.<br /> <br /> =====Solution=====<br /> * The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.<br /> * The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.<br /> <br /> ====The 'copy' and 'copy_questionnaire_details' methods====<br /> <br /> =====Problems=====<br /> <br /> #There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.<br /> #There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.<br /> <br /> =====Solution=====<br /> * Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.<br /> * So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.<br /> * The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.<br /> * The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.<br /> <br /> ====Making code DRYer====<br /> <br /> =====Problems=====<br /> <br /> #There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb. <br /> <br /> =====Solution=====<br /> * To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.<br /> * Calls were made to this method wherever QuizQuestionChoice was made.<br /> <br /> === Test Plan ===<br /> There is no means of testing the removal of dead code, except to run the existing suite of test cases:<br /> &lt;pre&gt;<br /> rspec spec<br /> &lt;/pre&gt;<br /> Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:<br /> &lt;pre&gt;<br /> rspec spec/controllers/questionnaires_controller_spec.rb<br /> &lt;/pre&gt;<br /> Testing the method ''create_quiz_question_choice'' can likewise be done with this command. <br /> The logic associated with getting the instructor ID from a user is tested using<br /> &lt;pre&gt;<br /> rspec spec/models/user_spec.rb<br /> &lt;/pre&gt;<br /> The additions to the questionnaires model can be tested using<br /> &lt;pre&gt;<br /> rspec spec/models/questionnaire_spec.rb<br /> &lt;/pre&gt;<br /> Note: If you are having difficulties running the ''rspec'' command, try using<br /> &lt;pre&gt;<br /> bundle exec rspec<br /> &lt;/pre&gt;<br /> instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.<br /> <br /> Also, tests were included for the code movement from the questionnaires controller to the questionnaire model. Checks were being made for database calls in the controller rspec method, the same format was followed while writing tests for the moved methods.</div>

Dmbhavsa