Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-29T04:05:56Z

Psengo: /* Important Links */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# Too much specific information on metrics is encoded into the text. While some of the info is in configuration files, the help text for the info buttons is in the code.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

[[File:ResponseOld.PNG|1200px|thumb|center]]

[[File:ResponseNew.PNG|1200px|thumb|center]]

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://youtu.be/oN7qCNTFBE8

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

File:ResponseNew.PNG

2021-11-28T23:42:54Z

Psengo:

File:ResponseOld.PNG

2021-11-28T23:42:43Z

Psengo: Psengo uploaded a new version of File:ResponseOld.PNG

File:ResponseOld.PNG

2021-11-28T23:40:22Z

Psengo:

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-28T23:39:57Z

Psengo: /* Refactoring (removing duplicate api values) */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# Too much specific information on metrics is encoded into the text. While some of the info is in configuration files, the help text for the info buttons is in the code.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

[[File:ResponseOld.PNG|1200px|thumb|center]]

[[File:ResponseNew.PNG|1200px|thumb|center]]

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://www.youtube.com/watch?v=OYZvNVa3GZ8&feature=youtu.be (Youtube video for previous implementation)

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-28T23:38:53Z

Psengo: /* Refactoring (Removing Hardcoded Values) */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# Too much specific information on metrics is encoded into the text. While some of the info is in configuration files, the help text for the info buttons is in the code.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://www.youtube.com/watch?v=OYZvNVa3GZ8&feature=youtu.be (Youtube video for previous implementation)

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-28T23:38:12Z

Psengo: /* Refactoring (Removing Hardcoded Values) */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# Too much specific information on metrics is encoded into the text. While some of the info is in configuration files, the help text for the info buttons is in the code.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config3 File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://www.youtube.com/watch?v=OYZvNVa3GZ8&feature=youtu.be (Youtube video for previous implementation)

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

File:Config File.PNG

2021-11-28T23:37:13Z

Psengo:

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-28T23:36:50Z

Psengo: /* Implementation */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# Too much specific information on metrics is encoded into the text. While some of the info is in configuration files, the help text for the info buttons is in the code.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://www.youtube.com/watch?v=OYZvNVa3GZ8&feature=youtu.be (Youtube video for previous implementation)

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-28T18:21:46Z

Psengo:

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-02T21:09:14Z

Psengo:

== Description ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time students learn from the reviews they receive to improve their own performance. In order to make this happen,it would be good to have everyone give quality reviews instead of generic ones. Currently Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services.

== Tasks ==
There are Several tasks that we are looking to address by the end of the project which are seen below:

# When a student submits a review (in the response_controller), we would like to call this web service with the student’s review as the input. We would then want to tell the student whether their reviews contain suggestions or not, so they can make improvements based on the results of the webservice.
#* The response_controller should pass a text string (the comments field of each Answer object) to the web service.
#* In fact, the response_controller could pass this string to a whole set of metrics (volume, sentiment, problem detection, suggestion counter).
# We would also like to evaluate how much time this API is taking and if possible work a way out to improve it. We don’t want the system to be terribly slow.
# We also have a web service for problem detection. That should be integrated too.

== Issues to be Addressed ==
# Update how current implementation gets data from the web service.
#* Yulin's code calls another module that grabs the data from web services in bulk, and divvies it out one item at a time.
#* How would you call it to get suggestion confidence and problem-detection confidence level, etc.?
# Reading a data structure that tells which metrics we are interested in now, and therefore which need to be shown in the view.
#* For example, the data structure may say, For this assignment, we are interested in
#** problem detection
#** suggestions, and
#** sentiment analysis.
#* For another assignment, it might be
#** localization and
#** helpfulness
#Displaying the information in an appropriate view.

== Comments on Prior Teams Implementation ==
* The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form.
** So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment
* There is too much specific information on metrics that is encoded into the text.
** While some of the info is in configuration files, the help text for the info buttons is in the code. Also, calls for each metric are programmed into the code, though, depending on how diverse they are, this is perhaps unavoidable
* The code can be more modularized.
** Currently there are many repetitive blocks of code. For ex; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there. So it might be more beneficial to store the API link in the config file and use the variable in the function

== API Endpoints==
* https://peer-reviews-nlp.herokuapp.com/all for all metrics at once
* https://peer-reviews-nlp.herokuapp.com/volume for volume metrics only
* https://peer-reviews-nlp.herokuapp.com/sentiment for sentiment metrics only
* https://peer-reviews-nlp.herokuapp.com/suggestions for suggestions metrics only

== JSON Formatting ==
* Input Text is passed in the following JSON format
{
"text" : "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire ()

* Divyang Doshi ()

* Srujan ()

== Relevant Links ==
* https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2112._Integrate_Suggestion_Detection_Algorithm
* https://github.com/expertiza/expertiza/pull/1952
* https://github.com/harshkachhadia/expertiza/tree/beta
* https://youtu.be/OYZvNVa3GZ8

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-02T20:47:55Z

Psengo:

CSC/ECE 517 Fall 2021

2021-11-02T20:27:22Z

Psengo: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2129. Refactor auth_controller.rb & password_retrieval_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2123. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2144. Refactor delayed mailer and scheduled task]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]
* [[CSC/ECE 517 Fall 2021 - E2146. Introduce a Student View for instructors]]
* [[CSC/ECE 517 Fall 2021 - Refactor Evaluation of SQL Queries]]
* [[CSC/ECE 517 Fall 2021 - E2135. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2021 - E2168. Testing - Reputations]]
* [[CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades]]
* [[CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations]]

== Final Projects ==
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2150._Integrate_suggestion_detection_algorithm#Description_about_project CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2152._Revision_planning_tool#Description_about_project CSC/ECE 517 Fall 2021 - E2152. Revision_planning_tool]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2170._Testing_-_Response_Maps#Description_about_project CSC/ECE 517 Fall 2021 - E2170. Testing - Response Maps]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza#Description_about_project CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper CSC/ECE 517 Fall 2021 - E2162. Further refactoring and improvement of review mapping helper]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2165._Fix_teammate-review_view CSC/ECE 517 Fall 2021 - E2165. Fix teammate review view ]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2158._Grading_audit_trail CSC/ECE 517 Fall 2021 - E2158. Grading audit trail ]

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-02T20:24:48Z

Psengo: Created page with "To be created..."

To be created...

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:22:26Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:21:13Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

File:Success task2 part2.png

2021-10-20T18:19:27Z

Psengo:

File:Success task2 part1.png

2021-10-20T18:18:04Z

Psengo:

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:17:30Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

[[File:Success_task2_part1.png]]

[[File:Success_task2_part2.png]]

However due to the fact that commenting out the MailHelper could result in cascading issues in other parts of the project we decided that the best action would be to not make changes and notify the mentors of this issue until a proper resolution could be made.

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T18:14:07Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

To resolve this the following lines were commented out in the following files :

'''Changed files:''' app/controllers/users_controller.rb

'''''122''''' if @user.save
'''''123''''' password = @user.reset_password
'''''124''''' # prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
'''''125''''' # prepared_mail.deliver
'''''126''''' flash[:success] = "A new password has been sent to new user's e-mail address."

'''Changed files:''' app/models/user.rb

'''''149''''' # Function which has a MailerHelper which sends the mail welcome email to the user after signing up
'''''150''''' def email_welcome
'''''151''''' # #this will send an account creation notification to user via email.
'''''152''''' # MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now prepared_mail.deliver
'''''153''''' end

This resolved the issues of being able to add an instructor with a newly created institution as seen in the images below

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T17:31:58Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

[[File:task2_issue.png]]

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

File:Task2 issue.png

2021-10-20T17:30:34Z

Psengo:

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T17:28:58Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below...

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T16:01:49Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a "No method error in Users#Create" occurs. However when running the program a different issue was seen below..

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions

2021-10-20T15:59:35Z

Psengo: /* Task2 */

== E2141. OSS project Finklestein: Instructors & Institutions ==

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows instructors to manager courses and assignments for students. Students can form up teams in Expertiza to work on different projects and assignments and do peer review about other students' submissions.

__TOC__

==Introduction==

* E2141 Project aims to fix the associations problems between the Institution and Instructor class.

* The forked git repository for this project can be found [https://github.com/psengo7/expertiza.git]

==Problem Statement==
The following tasks were accomplished in E2141 project:

* Task1: The institution list should be sorted alphabetically.
** Details: When creating a course, the drop-down list for selecting the institution does not show in alphabetical order.
[[File:E1971-Task1.png]]

* Task2: Adding a new institution during creation of an instructor profile.
** Details: The admin can attempt to create a new institution when creating a new instructor. But, after one types in the name of the institution & clicks create, it crashes.
[[File:E1971-Task2.png]]

* Task3: Listing of instructors should show their institutions on the same line as their new feature.
** Details: When listing users, there is currently no column to display the user’s associated institution.
[[File:E1971-Task3.png]]

====Task1====
As the issue is the Institution drop-down list is not alphabetically sorted. We simply added a step of sort when the Institution list was retrieved from the Database.
'''Changed files:''' _course.html.erb

'''''line3''''' <%= select("course", "institutions_id", Institution.all.order(:name).collect{ |c| [ c.name, c.id] }) %>

====Task2====
The original issue was that when an admin tries to create a new instructor with a new institution a

The issue occurs when the admin trying to create a new instructor with a new institution name. To fix this problem, we added a function to create a new institution and a confirmation prompt to alert the admin.

'''Changed files:''' app/controllers/users_controller.rb

'''''116''''' # if the user name already exists, register the user by email address
'''''117''''' check = User.find_by(name: params[:user][:name])
'''''118''''' params[:user][:name] = params[:user][:email] unless check.nil?
'''''119''''' if params[:user][:institution_id].empty?
'''''120''''' institution = Institution.find_or_create_by(name: params[:institution][:name])
'''''121''''' params[:user][:institution_id] = institution.id
'''''122''''' end
'''''123''''' @user = User.new(user_params)
'''''124''''' @user.institution_id = params[:user][:institution_id]
-------------------------------------------------------------------------------------------------
'''''142''''' else
'''''143''''' foreign
'''''144''''' flash[:error] = "Create Instructor Error!"
'''''145''''' render action: 'new'
'''''146''''' end

'''Changed files:''' app/views/users/new.html.erb

'''''8''''' <ρ style="color: red; font-weight: bold">* Please Make Sure All Information is Correct</ρ>
'''''9''''' <%= submit_tag "Create" %>

====Task3====
The issue is that the user page is not displaying the user's associated institution. To fix this issue, we added an 'institution' column in the HTML file retrieving the institution names of each user.
'''Changed files:''' app/models/user.rb

'''''111''''' def institution(ip_address = nil)
'''''112''''' if User.anonymized_view?(ip_address)
'''''113''''' self.role.name + ', ' + self.id.to_s
'''''114''''' else
'''''115''''' if self[:role_id] == 2
'''''116''''' self[:institution_id].nil? ? "" : Institution.find(self[:institution_id]).name
'''''117''''' end
'''''118''''' end
'''''119''''' end

'''Changed files:''' app/views/users/list.html.erb

'''''20''''' <tr>
'''''21''''' <th class="head">Name</th>
'''''22''''' <th class="head">Full Name</th>
'''''23''''' <th class="head">Institution</th>
'''''24''''' <th class="head">Email Address</th>
'''''25''''' <th class="head">Role</th>
'''''26''''' <th class="head">Parent</th>
'''''27''''' <th class="head">Review</th>
'''''28''''' <th class="head">Submission</th>
'''''29''''' <th class="head">Metareview</th>
'''''30''''' </tr>
'''''31''''' <% for user in @users %>
'''''32''''' <% if ((params[:show] != 'true' && !user.name(session[:ip]).include?("_hidden")) || params[:show] == 'true')%>
'''''33''''' <tr class="exp">
'''''34''''' <td><%= link_to user.name(session[:ip]), impersonate_impersonate_path(:user => {:name => user.name(session[:ip])}), :method => :post %></td>
'''''35''''' <td><%= link_to user.fullname(session[:ip]), :controller=> 'users', :action => 'show', :id => user.id %></td>
'''''36''''' <td><%= user.institution(session[:ip]) %></td>
'''''37''''' <td><%= user.email(session[:ip]) %></td>
'''''38''''' <td><%= link_to user.role.name, :controller => 'roles', :action => 'show', :id => user.role.id %></td>
'''''39''''' <td align="center"><%= user.parent.try :name %></td>
'''''40''''' <td><%= User.yesorno(user.email_on_review) %></td>
'''''41''''' <td><%= User.yesorno(user.email_on_submission) %></td>
'''''42''''' <td><%= User.yesorno(user.email_on_review_of_review) %></td>
'''''43''''' </tr>
'''''44''''' <% end %>
'''''45''''' <% end -%>

==Task Demonstration==
====Task1====
[[File:Task1-new.png]]
====Task2====
[[File:Task2-new.png]]
[[File:Task2-2-new.png]]

====Task3====
[[File:Task2-2-new.png]]

==Test==
====Test for Task1====
We created 4 institutions and check if they are alphabetically sorted in the selection box
'''Changed files:''' spec/features/course_creation_spec.rb

'''''13''''' it "check if the courses are sorted alphabetically" do
'''''14''''' create(:superadmin, name: 'super_administrator2')
'''''15''''' login_as('super_administrator2')
'''''16''''' visit "/course/new?private=1"
'''''17''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[1]").text).to eq("A")
'''''18''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[2]").text).to eq("B")
'''''19''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[3]").text).to eq("C")
'''''20''''' expect(page.find(:xpath, "//*[@id=\"course_institutions_id\"]/option[4]").text).to eq("D")
'''''21''''' end

====Test for Task2====
We tried to create a new instructor6 with a new institution name
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''233''''' it 'save successfully with a new institution' do
'''''234''''' session = {user: admin}
'''''235''''' params = {
'''''236''''' user: {name: 'instructor6',
'''''237''''' crypted_password: 'password',
'''''238''''' role_id: 2,
'''''239''''' password_salt: 1,
'''''240''''' fullname: '6, instructor',
'''''241''''' email: 'yzhu48@ncsu.edu',
'''''242''''' parent_id: 1,
'''''243''''' private_by_default: false,
'''''244''''' mru_directory_path: nil,
'''''245''''' email_on_review: true,
'''''246''''' email_on_submission: true,
'''''247''''' email_on_review_of_review: true,
'''''248''''' is_new_user: false,
'''''249''''' master_permission_granted: 0,
'''''250''''' handle: 'handle',
'''''251''''' digital_certificate: nil,
'''''252''''' timezonepref: 'Eastern Time (US & Canada)',
'''''253''''' public_key: nil,
'''''254''''' copy_of_emails: nil,
'''''255''''' institution_id: 666,
'''''256''''' institution: {
'''''257''''' name: 'yzhu48'
'''''258''''' }
'''''259''''' }
'''''260''''' }
'''''261''''' post :create, params, session
'''''262''''' allow_any_instance_of(User).to receive(:undo_link).with('The user "instructor6" has been successfully created. ').and_return(true)
'''''263''''' expect(flash[:success]).to eq "A new password has been sent to new user's e-mail address."
'''''264''''' expect(response).to redirect_to('http://test.host/users/list')
'''''265''''' end

====Test for Task3====
We tested if the Institution column was on the page
'''Changed files:''' spec/controllers/users_controller_spec.rb

'''''18''''' it "check if instructors show their institutions on the same line as their new feature" do
'''''19''''' create(:superadmin, name: 'super_administrator2')
'''''20''''' login_as('super_administrator2')
'''''21''''' visit "/users/list"
'''''22''''' expect(page.has_content?("Institution")).to eq(true)
'''''23''''' end

==Process Video==
Video Demonstration for Testing Task1: [https://youtu.be/FXQu1fcbM20 Task1-Video]
Video Demonstration for Testing Task2: [https://youtu.be/3BIsI2UpNRo Task2-Video]
Video Demonstration for Testing Task3: [https://youtu.be/ZmLfvYLmLTo Task3-Video]

==Project Deployment==
[http://152.46.17.133:8080/ Expertiza_Team_4430]

==Team Information==
'''Team:'''
Kai Gao (kgao2@ncsu.edu)
psengo (psengo@ncsu.edu)
kyao (kyao@ncsu.edu)
'''Mentor:''' Yunkai Xiao (yxiao28@ncsu.edu)

==References==

[https://github.com/expertiza/expertiza Expertiza on GitHub]

[http://expertiza.ncsu.edu/ Expertiza website]

[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]

[https://github.com/YongjianZhu/expertiza GitHub Project Repository Fork]

[https://relishapp.com/rspec Rspec Documentation]