Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-05-01T23:56:41Z

Psvaidya: /* Future Work */

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Condition for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named "store_scores_to_db" which gets called when the above mentioned icon is clicked
** This method calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created store_scores_to_db method
** Note: Clicking on the icon twice for the same assignment saves the latest scores again, and while viewing the scores, only the latest entries from the local_db_scores table are considered

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

Some of the changes to models/on_the_fly_calc.rb. Changing model to class and methods to static methods by passing assignment parameter.

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The condition used for calling either OnTheFlyCalc or LocalDbCalc. This is similar in assignment_team.rb, assignment_participant.rb and participant.rb

[[File:S6.png]]

==Use Cases==

The project can be broken down into below use cases:

* Instructor wants to store the total scores for each response map, round for an assignment in the database. Instructor clicks on "save scores to db" icon and the scores are stored
* Instructor/User wants to view the scores for an assignment before storing the local scores. Total scores are calculated "on the fly" by adding score given for each question by each reviewer
* Instructor/user wants to view the scores for an assignment after storing the local scores. Scores are calculated by using the values stored in local_db_calc database

==Test Plan==

The above use cases can then be translated into three major scenarios that we need to test. The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| Instructor clicks on "save scores to db" for an assignment. The scores are calculated correctly and placed into the local_db_score table. First, set up an assignment with some review questions. Let a student answer the review questions. Call the store_total_scores method in LocalDbCalc and check if a new record has been added to local_db_scores table.
| Query the database and verify that a new record has been added to local_db_scores table
|-
| 2
| Local scores are not stored and user wants to view scores. For an assignment for which the scores are not calculated, click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using OnTheFlyCalc.
| Click on view scores for an assignment whose local scores are not stored and verify that the page displays the expected scores.
|-
| 3
| Local scores are stored and user wants to view scores. For an assignment, first click on save scores to db icon to store the total scores. Then click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using LocalDbCalc. This test will mainly be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| Click on view scores for an assignment whose local scores are stored and verify that the page displays the expected scores.
|}

==Future Work==
* Currently OnTheFlyCalc and LocalDbCalc are used to compute the total score for an assignment. More functionalities as below can be added to calculate/display the total scores for a team in an assignment or the total score given by each reviewer. The below mentioned additions/changes will heavily improve the response time.
** LocalDbCalc stores the total score for each response map for each round
*** These stored values in local_db_scores table can be used directly every time a student wants to view the total score they received from a particular reviewer in a particular round or when an instructor wants to see the total scores by each reviewer given to each team.
*** These stored values in local_db_scores table can also be used to calculate the total score received by each team, every time a team wants to view their total score or an instructor wants to view the total scores received by each team.
* Adding conditions to show the "save scores to db" icon only when an assignment has finished, and stop showing it again once the scores are stored.
** Currently this icon is present all the time and can be clicked on multiple times, even when an assignment is ongoing. So clicking on this adds the same/updated entries to the database. While viewing the scores, only the latest scores saved in database are considered.
** So, as a future work, this can be modified such that the icon is seen only when an assignment has finished and the scores are not yet stored. This will prevent the scores being stored multiple times or before an assignment has finished.
* Adding the functionality to remove the scores stored in the database. This will especially be useful after implementing the above mentioned future work because after the above future work functionality, the icon to store the scores will not be shown and if scores are updated somehow, they can't be stored again.
** In our current functionality, if the scores are updated, the latest scores can be stored again because the icon is always present.
* Add functionality to call OnTheFlyCalc to compute the scores of an assignment whose scores are already stored (if required).
** Currently, once the scores are stored in database for an assignment, every time LocalDbCalc will be used to view the scores of that assignment.

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-29T21:54:23Z

Psvaidya: /* Changes Done */

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Condition for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named "store_scores_to_db" which gets called when the above mentioned icon is clicked
** This method calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created store_scores_to_db method
** Note: Clicking on the icon twice for the same assignment saves the latest scores again, and while viewing the scores, only the latest entries from the local_db_scores table are considered

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

Some of the changes to models/on_the_fly_calc.rb. Changing model to class and methods to static methods by passing assignment parameter.

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The condition used for calling either OnTheFlyCalc or LocalDbCalc. This is similar in assignment_team.rb, assignment_participant.rb and participant.rb

[[File:S6.png]]

==Use Cases==

The project can be broken down into below use cases:

* Instructor wants to store the total scores for each response map, round for an assignment in the database. Instructor clicks on "save scores to db" icon and the scores are stored
* Instructor/User wants to view the scores for an assignment before storing the local scores. Total scores are calculated "on the fly" by adding score given for each question by each reviewer
* Instructor/user wants to view the scores for an assignment after storing the local scores. Scores are calculated by using the values stored in local_db_calc database

==Test Plan==

The above use cases can then be translated into three major scenarios that we need to test. The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| Instructor clicks on "save scores to db" for an assignment. The scores are calculated correctly and placed into the local_db_score table. First, set up an assignment with some review questions. Let a student answer the review questions. Call the store_total_scores method in LocalDbCalc and check if a new record has been added to local_db_scores table.
| Query the database and verify that a new record has been added to local_db_scores table
|-
| 2
| Local scores are not stored and user wants to view scores. For an assignment for which the scores are not calculated, click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using OnTheFlyCalc.
| Click on view scores for an assignment whose local scores are not stored and verify that the page displays the expected scores.
|-
| 3
| Local scores are stored and user wants to view scores. For an assignment, first click on save scores to db icon to store the total scores. Then click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using LocalDbCalc. This test will mainly be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| Click on view scores for an assignment whose local scores are stored and verify that the page displays the expected scores.
|}

==Future Work==
* Adding conditions to show the "save scores to db" icon only when an assignment has finished, and stop showing it again once the scores are stored.
** Currently this icon is present all the time and can be clicked on multiple times, even when an assignment is ongoing. So clicking on this adds the same/updated entries to the database. While viewing the scores, only the latest scores saved in database are considered.
** So, as a future work, this can be modified such that the icon is seen only when an assignment has finished and the scores are not yet stored. This will prevent the scores being stored multiple times or before an assignment has finished.
* Adding the functionality to remove the scores stored in the database. This will especially be useful after implementing the above mentioned future work because after the above future work functionality, the icon to store the scores will not be shown and if scores are updated somehow, they can't be stored again.
** In our current functionality, if the scores are updated, the latest scores can be stored again because the icon is always present.
* Add functionality to call OnTheFlyCalc to compute the scores of an assignment whose scores are already stored (if required).
** Currently, once the scores are stored in database for an assignment, every time LocalDbCalc will be used to view the scores of that assignment.

File:S3.png

2017-04-29T21:50:08Z

Psvaidya: uploaded a new version of "File:S3.png"

Amazon S3 Logo

File:S6.png

2017-04-29T21:47:25Z

Psvaidya: uploaded a new version of "File:S6.png"

File:S5.png

2017-04-29T21:45:57Z

Psvaidya: uploaded a new version of "File:S5.png"

File:S2.png

2017-04-29T21:44:44Z

Psvaidya: uploaded a new version of "File:S2.png"

File:S1.png

2017-04-29T21:44:23Z

Psvaidya: uploaded a new version of "File:S1.png"

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-29T01:46:49Z

Psvaidya:

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method
** Note: Clicking on the icon twice for the same assignment saves the latest scores again, and while viewing the scores, only the latest entries from the local_db_scores table are considered

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The new method in assignment.rb which gets called from the above local_db_cal method in assignment controller

[[File:S6.png]]

==Use Cases==

The project can be broken down into below use cases:

* Instructor wants to store the total scores for each response map, round for an assignment in the database. Instructor clicks on "save scores to db" icon and the scores are stored
* Instructor/User wants to view the scores for an assignment before storing the local scores. Total scores are calculated "on the fly" by adding score given for each question by each reviewer
* Instructor/user wants to view the scores for an assignment after storing the local scores. Scores are calculated by using the values stored in local_db_calc database

==Test Plan==

The above use cases can then be translated into three major scenarios that we need to test. The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| Instructor clicks on "save scores to db" for an assignment. The scores are calculated correctly and placed into the local_db_score table. First, set up an assignment with some review questions. Let a student answer the review questions. Call the store_total_scores method in LocalDbCalc and check if a new record has been added to local_db_scores table.
| Query the database and verify that a new record has been added to local_db_scores table
|-
| 2
| Local scores are not stored and user wants to view scores. For an assignment for which the scores are not calculated, click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using OnTheFlyCalc.
| Click on view scores for an assignment whose local scores are not stored and verify that the page displays the expected scores.
|-
| 3
| Local scores are stored and user wants to view scores. For an assignment, first click on save scores to db icon to store the total scores. Then click on View Scores as an instructor, or Your Scores as a student. The score displayed should be calculated correctly on the fly using LocalDbCalc. This test will mainly be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| Click on view scores for an assignment whose local scores are stored and verify that the page displays the expected scores.
|}

==Future Work==
* Adding conditions to show the "save scores to db" icon only when an assignment has finished, and stop showing it again once the scores are stored.
** Currently this icon is present all the time and can be clicked on multiple times, even when an assignment is ongoing. So clicking on this adds the same/updated entries to the database. While viewing the scores, only the latest scores saved in database are considered.
** So, as a future work, this can be modified such that the icon is seen only when an assignment has finished and the scores are not yet stored. This will prevent the scores being stored multiple times or before an assignment has finished.
* Adding the functionality to remove the scores stored in the database. This will especially be useful after implementing the above mentioned future work because after the above future work functionality, the icon to store the scores will not be shown and if scores are updated somehow, they can't be stored again.
** In our current functionality, if the scores are updated, the latest scores can be stored again because the icon is always present.
* Add functionality to call OnTheFlyCalc to compute the scores of an assignment whose scores are already stored (if required).
** Currently, once the scores are stored in database for an assignment, every time LocalDbCalc will be used to view the scores of that assignment.

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-28T07:02:54Z

Psvaidya:

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method
** Note: Clicking on the icon twice for the same assignment saves the latest scores again, and while viewing the scores, only the latest entries from the local_db_scores table are considered

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The new method in assignment.rb which gets called from the above local_db_cal method in assignment controller

[[File:S6.png]]

==Use Cases==

The project can be broken down into two primary use cases.

* The user wants to view the scores before the assignment is finished. Scores are calculated "on the fly" and presented to the user.
* The user wants to view the scores after the assignment is finished. Scores are calculated on assignment completion and stored in the database for quick retrieval.

==Test Plan==

The above two use cases can then be translated into three major scenarios we need to test. The use case where the assignment is completed and scores are stored into the database is broken down into two scenarios to test the data input and data retrieval parts separately.

The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| An assignment is finished and a score is calculated correctly and placed into the local_db_score table using the scheduled task feature. First, set up an assignment with some score information. Create a scheduled task to calculate the score and insert the score into the database upon assignment completion.
| Query the database and verify score is correct
|-
| 2
| Assignment is NOT finished and user wants to view scores. First, set up an assignment with a deadline in the future. Put in some score information. The score should be calculated correctly on the fly using OnTheFlyCalc.
| After the assignment is created, this test will run on the UI. The user will click the view scores link and the page should display the expected score.
|-
| 3
| Assignment is finished and the user wants to view scores. This test will mainly just be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| User clicks on view scores on a past assignment and sees the expected score on the UI
|}

The following diagrams show how the chosen scenarios above map to functionality.

[[File:E1731-scenario-1.jpg|frame|center]]

[[File:E1731-scenario-2-3.jpg|frame|center]]

==Future Work==
* We have created a new icon which saves the scores to database. This icon is present all the time and can be clicked on multiple times or even when an assignment is ongoing. So clicking on this causes the same entries to be added to the database more than once.
** So, one future work could be to show this icon only when an assignment has finished and remove it as soon as the local scores are calculated for this assignment. This will prevent the scores being scored multiple times or before an assignment has finished.
** Currently, if the icon is clicked again, it will store the latest scores in the database and use these latest entries while viewing the scores.
* Currently, once the scores are stored in the database, while computing the scores, always LocalDbCalc will get called.
** A future work could be to have a way to remove the scores from the database when required or a way to call OnTheFlyCalc instead of LocalDbCalc whenever the instructor wants.

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-28T03:44:35Z

Psvaidya: Future Work section added

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The new method in assignment.rb which gets called from the above local_db_cal method in assignment controller

[[File:S6.png]]

==Use Cases==

The project can be broken down into two primary use cases.

* The user wants to view the scores before the assignment is finished. Scores are calculated "on the fly" and presented to the user.
* The user wants to view the scores after the assignment is finished. Scores are calculated on assignment completion and stored in the database for quick retrieval.

==Test Plan==

The above two use cases can then be translated into three major scenarios we need to test. The use case where the assignment is completed and scores are stored into the database is broken down into two scenarios to test the data input and data retrieval parts separately.

The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| An assignment is finished and a score is calculated correctly and placed into the local_db_score table using the scheduled task feature. First, set up an assignment with some score information. Create a scheduled task to calculate the score and insert the score into the database upon assignment completion.
| Query the database and verify score is correct
|-
| 2
| Assignment is NOT finished and user wants to view scores. First, set up an assignment with a deadline in the future. Put in some score information. The score should be calculated correctly on the fly using OnTheFlyCalc.
| After the assignment is created, this test will run on the UI. The user will click the view scores link and the page should display the expected score.
|-
| 3
| Assignment is finished and the user wants to view scores. This test will mainly just be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| User clicks on view scores on a past assignment and sees the expected score on the UI
|}

The following diagrams show how the chosen scenarios above map to functionality.

[[File:E1731-scenario-1.jpg|frame|center]]

[[File:E1731-scenario-2-3.jpg|frame|center]]

==Future Work==
* We have created a new icon which saves the scores to database. This icon is present all the time and can be clicked on multiple times or even when an assignment is ongoing. So clicking on this causes the same entries to be added to the database more than once.
** So, one future work could be to show this icon only when an assignment has finished and remove it as soon as the local scores are calculated for this assignment. This will prevent the scores being scored multiple times or before an assignment has finished.
* Currently, once the scores are stored in the database, while computing the scores, always LocalDbCalc will get called.
** A future work could be to have a way to remove the scores from the database when required or a way to call OnTheFlyCalc instead of LocalDbCalc whenever the instructor wants.

File:S4.png

2017-04-28T03:36:34Z

Psvaidya: uploaded a new version of "File:S4.png"

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-28T03:35:13Z

Psvaidya: /* Some of these code snippets are attached below */

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"

[[File:S1.png]]

[[File:S2.png]]

[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx

[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.

[[File:S5.png]]

The new method in assignment.rb which gets called from the above local_db_cal method in assignment controller

[[File:S6.png]]

==Use Cases==

The project can be broken down into two primary use cases.

* The user wants to view the scores before the assignment is finished. Scores are calculated "on the fly" and presented to the user.
* The user wants to view the scores after the assignment is finished. Scores are calculated on assignment completion and stored in the database for quick retrieval.

==Test Plan==

The above two use cases can then be translated into three major scenarios we need to test. The use case where the assignment is completed and scores are stored into the database is broken down into two scenarios to test the data input and data retrieval parts separately.

The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| An assignment is finished and a score is calculated correctly and placed into the local_db_score table using the scheduled task feature. First, set up an assignment with some score information. Create a scheduled task to calculate the score and insert the score into the database upon assignment completion.
| Query the database and verify score is correct
|-
| 2
| Assignment is NOT finished and user wants to view scores. First, set up an assignment with a deadline in the future. Put in some score information. The score should be calculated correctly on the fly using OnTheFlyCalc.
| After the assignment is created, this test will run on the UI. The user will click the view scores link and the page should display the expected score.
|-
| 3
| Assignment is finished and the user wants to view scores. This test will mainly just be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| User clicks on view scores on a past assignment and sees the expected score on the UI
|}

The following diagrams show how the chosen scenarios above map to functionality.

[[File:E1731-scenario-1.jpg|frame|center]]

[[File:E1731-scenario-2-3.jpg|frame|center]]

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-28T03:34:31Z

Psvaidya: /* Changes Done */

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method

====Some of these code snippets are attached below====
The newly created LocalDbCalc class in models/local_db_calc.rb file with 2 static methods "compute_total_score" and "store_total_scores"
[[File:S1.png]]
[[File:S2.png]]
[[File:S3.png]]

The addition of the new icon on Manage Assignments page to save the scores to database. Filename: assets/javascripts/tree_display.jsx
[[File:S4.png]]

The new method in assignment_controller.rb which gets called when the newly created icon is clicked.
[[File:S5.png]]

The new method in assignment.rb which gets called from the above local_db_cal method in assignment controller
[[File:S6.png]]

==Use Cases==

The project can be broken down into two primary use cases.

* The user wants to view the scores before the assignment is finished. Scores are calculated "on the fly" and presented to the user.
* The user wants to view the scores after the assignment is finished. Scores are calculated on assignment completion and stored in the database for quick retrieval.

==Test Plan==

The above two use cases can then be translated into three major scenarios we need to test. The use case where the assignment is completed and scores are stored into the database is broken down into two scenarios to test the data input and data retrieval parts separately.

The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| An assignment is finished and a score is calculated correctly and placed into the local_db_score table using the scheduled task feature. First, set up an assignment with some score information. Create a scheduled task to calculate the score and insert the score into the database upon assignment completion.
| Query the database and verify score is correct
|-
| 2
| Assignment is NOT finished and user wants to view scores. First, set up an assignment with a deadline in the future. Put in some score information. The score should be calculated correctly on the fly using OnTheFlyCalc.
| After the assignment is created, this test will run on the UI. The user will click the view scores link and the page should display the expected score.
|-
| 3
| Assignment is finished and the user wants to view scores. This test will mainly just be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| User clicks on view scores on a past assignment and sees the expected score on the UI
|}

The following diagrams show how the chosen scenarios above map to functionality.

[[File:E1731-scenario-1.jpg|frame|center]]

[[File:E1731-scenario-2-3.jpg|frame|center]]

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-28T03:29:52Z

Psvaidya: /* Changes */ Added description of changes done

==Introduction==

<nowiki> Expertiza is an opensource web based platform developed to assist students in educational institutions to perform peer reviews and group projects. The reviewing is done through a mechanism where students will be sent request to review work and the system will analyze and publish a summarized report. The software is designed in MVC (Model-View-Controller) architecture using Ruby on Rails.
</nowiki>

==Problem Description==
===Current Scenario===
Today, Expertiza stores the scores based on each response to each criterion, but no holistic scores are stored. The "answers" table only contains the scores that user A has given user B on each criterion. This means that if we need to know what score A has given B based on 100, we have to rely on the code to calculate it every time the score is requested. This design slows down Expertiza as every time an instructor clicks on "View Scores", all the calculations are done to display the score. The situation is even worse if we want to weight the scores by the reputation of each reviewer, which is a measure of how closely that reviewer's scores match other reviewers. In this case, the system potentially has to do thousands of arithmetic calculations to display the score for a particular assignment.

===Proposed Solution===
We propose that we have two mechanisms to handle the holistic scores, depending on the current state of the assignment: This new approach will take the responses and the database will act as a storage environment.
* OnTheFlyCalc:
** Calculates holistic scores over a set of data: A set of records in answers table, namely the responses from user A to user B on each criterion.
** When an assignment is still ongoing, the reputations for each reviewer will be calculated and handled by OnTheFlyCalc
** This is similar to the current scenario
* LocalDBCalc:
** Calculates the holistic score over a single db query: "get the score that user A gives user B on assignment 999 on round 2"
** When an asignment has finished, all the reputations will be calculated by LocalDBCalc and stored, since they are finalized. So, when the scores are requested, they will be fetched using a single db query and displayed
** This will be a new addition to the code as currently there is no class.

In this project, our goal is to make the OnTheFlyCalc and LocalDBCalc work only for peer-review scores. As future projects will introduce other types of scores, the solution must be extensible.

==Design Plan==
* A new database table "local_db_scores" with following columns will be created to store the holistic scores:
** id: int
** score_type: string
** round: int
** score: int
** response_map_id: int (this will be reference to the response_map table)
* A new column "local_scores_calculated" with boolean type will be added to "assignments" table
** This has the default value false
** The value will change to true when the holistic scores for that assignment are stored in local_db_scores table
* A new icon will be added to the list of Assignments on the Manage Assignments page for instructor
** When this icon is clicked, the holistic scores will be calculated using store_total_score method in LocalDBCalc class and then inserted in this new table "local_db_score"
*** If the record to be inserted is a finalized peer-review score, the type stored in the database will be "ReviewLocalDBScore" and the reference_id will be the response_map id
*** The peer-review scores will be calculated and stored for each of the review rounds because it is possible that user A only reviews user B in one out of several rounds
* When a request is made to view the total scores, depending on whether local_scores_calculated column of the assignment is false or true, either OnTheFlyCalc or LocalDBCalc will be called to calculate the total score

To achieve this functionality, following classes will be created:
* OnTheFlyCalc:
** This class will contain a method "compute_total_scores" which will compute the total score for an assignment by summing the scores given on all questionnaires and return this total score when an instructor tries to view scores for an ongoing assignment
** It will also contain methods to calculate the average score and score range (min, max) for each reviewee(team) for peer-review
** Currently OnTheFlyCalc already exists as a module. As it is only used by assignments, we plan to change it into a class and change all its methods into static methods
* LocalDBCalc:
** This class will also contain a method "compute_total_scores". But this method will compute the total score by querying and summing the scores saved in local_db_scores table instead of summing the scores given on all questionnaires
** It will also contain a method "store_total_scores" which will be called when an instructor clicks on "Save Scores to db" icon for an assignment
*** This method will compute and save the total scores for all the response maps (reviewer -> reviewee) in the assignment for each round in local_db_scores table.

[[File:Design.png|frame|center]]
As seen in the above image, when a user A reviews another user B (or team), a response map is created containing individual scores and responses to questionnaires. When an instructor clicks on "Save Scores to DB" icon for an assignment, "store_total_scores" method is called in LocalDBCalc class which calculates the holistic scores for each response map from the individual scores and saves it in local_db_scores table. This also sets the "local_scores_calculated" attribute to true for the assignment. Now, the next time someone tries to view these scores, they are computed using the scores saved in local_db_scores.

[[File:Mechanism.png|frame|center]]
The above image shows the mechanism which will be followed. When an instructor tries to view scores for an assignment, 1st it will be checked if the local_scores_calculated attribute is true or false for the assignment. If it is false, compute_total_scores from OnTheFlyCalc class is called which will add the scores from the questionnaires. However, if it is true, compute_total_scores from LocalDbCalc class is called which will add the corresponding scores from local_db_scores table.

==Changes Done==

* Created a new table local_db_scores with columns id, score_type, round, score, response_map_id (foreign key to response_map table)

* Added a new boolean type column named "local_scores_calculated" with default value false to assignments table

* OnTheFlyCalc class:
** Changed "OnTheFlyCalc" module from on_the_fly_calc.rb file into a class
** Changed all its methods into static methods and passed assignment as a parameter for all the methods
** Removed the line "include OnTheFlyCalc" from assignment.rb file
** Made changes in all the places (eg. review_mapping_controller.rb) where any method of OnTheFlyCalc was called, so that the corresponding static method gets called now with assignment as a parameter

* LocalDbCalc class:
** Created a new file local_db_calc.rb with a new class "LocalDbCalc"
** Created a static method "compute_total_score" with assignment as parameter
*** This method calculates the total score by adding all the scores of the given assignment stored in local_db_scores table
** Created a static method "store_total_scores" with assignment as parameter
*** This method saves the total score of each response map of the given assignment for each round in local_db_scores table

* Logic for choosing LocalDbCalc/OnTheFlyCalc
** compute_total_scores is called from 3 files namely "assignment_team.rb", "assignment_participant.rb" and "participant.rb"
** Added a new condition in the scores method in these files which checks if the "local_scores_calculated" attribute is set (true) for the given assignment
*** If it is set (true), compute_total_scores from LocalDbCalc class is called
*** If it is not set (false), compute_total_scores from OnTheFlyCalc class is called

* Manage Assignments UI
** Created a new icon for each assignment. Clicking this icon stores the total scores for each response map of the assignment for each round in local_db_scores table. It then sets the local_scores_calculated attribute of the assignment to true
** The code for this is in assets/javascripts/tree_display.jsx
** Created a new method in assignments_controller.rb named local_db_cal which gets called when the above mentioned icon is clicked
** This method calls another newly created method "save_score_in_db" in assignment.rb which in turn calls the "store_total_scores" method in LocalDbCalc class
** A route is also created for this newly created local_db_cal method

[[File:S1.png]]

[[File:S2.png]]

[[File:S3.png]]

Icon added for storing into db:

[[File:S4.png]]

Storing into db:

[[File:S5.png]]

[[File:S6.png]]

==Use Cases==

The project can be broken down into two primary use cases.

* The user wants to view the scores before the assignment is finished. Scores are calculated "on the fly" and presented to the user.
* The user wants to view the scores after the assignment is finished. Scores are calculated on assignment completion and stored in the database for quick retrieval.

==Test Plan==

The above two use cases can then be translated into three major scenarios we need to test. The use case where the assignment is completed and scores are stored into the database is broken down into two scenarios to test the data input and data retrieval parts separately.

The following table contains the main scenarios we will cover when testing our project.

{| class="wikitable"
|-
! Scenario Number
! Description
! Expected Result for Pass
|-
| 1
| An assignment is finished and a score is calculated correctly and placed into the local_db_score table using the scheduled task feature. First, set up an assignment with some score information. Create a scheduled task to calculate the score and insert the score into the database upon assignment completion.
| Query the database and verify score is correct
|-
| 2
| Assignment is NOT finished and user wants to view scores. First, set up an assignment with a deadline in the future. Put in some score information. The score should be calculated correctly on the fly using OnTheFlyCalc.
| After the assignment is created, this test will run on the UI. The user will click the view scores link and the page should display the expected score.
|-
| 3
| Assignment is finished and the user wants to view scores. This test will mainly just be a check if clicking view scores on the UI will result in the expected value showing up on the UI. The interaction in getting the information in the database is already tested in Scenario 1.
| User clicks on view scores on a past assignment and sees the expected score on the UI
|}

The following diagrams show how the chosen scenarios above map to functionality.

[[File:E1731-scenario-1.jpg|frame|center]]

[[File:E1731-scenario-2-3.jpg|frame|center]]

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-27T00:10:33Z

Psvaidya: /* Design Plan */

File:Mechanism.png

2017-04-26T23:46:20Z

Psvaidya: uploaded a new version of "File:Mechanism.png"

File:Design.png

2017-04-26T23:36:04Z

Psvaidya: uploaded a new version of "File:Design.png"

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-26T22:54:29Z

Psvaidya: /* Design Plan */

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-12T19:29:35Z

Psvaidya: /* Design Plan */

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-12T19:21:52Z

Psvaidya: /* Design Plan */ Updated Design Plan

File:Design.png

2017-04-12T18:54:33Z

Psvaidya: uploaded a new version of "File:Design.png"

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-12T18:53:50Z

Psvaidya: /* Design Plan */

File:Mechanism.png

2017-04-12T18:53:19Z

Psvaidya:

File:Design.png

2017-04-12T18:51:32Z

Psvaidya: uploaded a new version of "File:Design.png"

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-07T00:07:45Z

Psvaidya: /* Problem Description */

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-06T23:55:07Z

Psvaidya: /* Design Plan */

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-06T23:25:36Z

Psvaidya: /* Design Plan */ basic design plan added

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-06T22:50:44Z

Psvaidya: /* Problem Description */ Current Scenario and Proposed Solution added

CSC/ECE 517 Spring 2017/E1731 Improve Score Calculation

2017-04-06T22:24:26Z

Psvaidya: Created the page with expertiza introduction

CSC/ECE 517 Spring 2017/Use Ajax to add Participants,TA and Edit Questionnaire

2017-04-03T21:17:09Z

Psvaidya: /* UI Testing */

==Introduction==

<nowiki> Expertiza is an opensource software developed to assist people in education institutions to perform peer reviews and group projects. It is exceptionally helpful to the students and instructors. The software is designed in MVC (Model-View-Controller) architecture using ruby on rails.
</nowiki>

==Problem Statement==
Expertiza provides many categories to manage for an instructor. Few of these categories are assignments, courses and questionnaires. Currently, to add/remove/update records, the entire page is submitted to save the record and the entire page is re-loaded back again to reflect the changes on the page. The task is to improve this functionality such that some of the records, specifically adding participants to courses or assignments, adding/removing teaching assistants to/from courses and adding questions to questionnaires, can be saved remotely and the page updated without submitting and reloading the entire page.
Additionally, on assign reviewers page for an assignment, there is no way to see the current status of reviews and there is no way for an instructor to unsubmit a submitted review. So, another task is to add this functionality such that review status is seen for each review and to unsubmit a submitted review without reloading the page.

==Proposed Solution==
This project proposes use of AJAX for the required pages to avoid page reloading at the time of adding and saving records. This solution will make sure that adding or saving of record is done remotely and the page is updated without reloading. It can be achieved by calling corresponding controller method, adding/saving the record remotely and rendering it back to JavaScript pages in the view instead of redirecting it to the same page. JavaScript pages in the view will update the page without reloading it, for example by appending the newly added record to the list of records. Thus, records are saved remotely and page refresh is avoided.
For the review status part, responses to the corresponding reviews on the page can be checked in the Response table and the review status shown as the status of the latest response. Unsubmitting a review can be done using AJAX without reloading the page.

==Tasks==
* Add Participant in the assignments section using AJAX
* Add/Remove TA in the courses section using AJAX
* Edit Questionnaire by using AJAX for adding questions in the Questionnaire section
* Show Review Status on assign reviewers page and allow to un-submit a review using AJAX

==Implementation==

===Adding participant===
'''Earlier scenario:''' When an instructor goes to "Manage Assignments -> Add Participants" page, he/she can add/remove new Participant to the assignment. The add page also displays list of participants above the form for new participant. Every time a new Participant is added, the page reloads to reflect the changes and render the updated list of participants, even in case of non-existing userid.

'''Updates/Changes:'''
This page has been updated such that an instructor can add a new Participant using [https://en.wikipedia.org/wiki/Ajax_(programming) AJAX]. After adding AJAX changes, the list gets updated without reloading the entire page. The changes made are below.

* Updated the ''shared_scripts/_user_list.html.erb'' file in views so that the Participants are listed by rendering another partial ''_participant.html.erb'' in participants controller. This change is to make it feasible to add AJAX to just append to the list without any extra formatting.
[[File:User_list.PNG]]

* Created a new file ''participants/add.js.erb'' for adding AJAX to render newly added participant in case of successful addition and display error in case of any error.
[[File:Javascript changes.PNG]]

* Updated the ''shared_scripts/_add_individual.html.erb'' form such that request should be through AJAX by setting remote flag to true.
[[File:Add_individual.PNG]]

* Updated the participants controller ''participant_controller.rb'' in controllers to render JavaScript when add method is invoked by the form submit action instead of redirect to list page.
[[File:Controller_changes.PNG]]

===Adding/Removing TA===
'''Earlier scenario:''' When an instructor goes to "Manage Courses -> Add TA" page, he/she can add/remove new TA to the course. Every time a new TA is added or removed, the page reloads to reflect the changes, even if the userid used does not exist.

'''Updates/Changes:''' This page has been updated such that an instructor can add a new TA or remove a new TA using AJAX. With these updates, the changes are reflected on the page without reloading the page, thus saving time.
* Updated the ''course/view_teaching_assistants.html.erb'' file in views so that the TAs are listed by rendering another partial ''_ta.html.erb''. This is done so that when a new TA has been added, AJAX call can be used to render the format required for the new TA in the list append to the already existing list without reloading the page.
[[File:View_teaching_assistants_html_erb.png]]

* Created a new file ''course/_ta.html.erb'' in views which is a partial as described above and contains the code to list the TAs. The link_to "Delete" line in this file is updated to use :remote=>:true, so that AJAX call can be made to remove the TA remotely without reloading the page.
<pre>
<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post, :remote => true, :class => 'remove_ta' %>
</pre>
[[File:Ta.png]]

* Updated the ''course/_add_individual.html.erb'' file in views to perform the form_tag action to Add a TA remotely using :remote=>:true. In the below code, ''form_action'' and ''remote'' are local variables passed to this partial from ''course/view_teaching_assistants.html.erb'' with the values "add_ta" and "true" respectively
[[File:Add_individual_html_erb.png]]

* Updated the ''course_controller.rb" file and replaced the redirect option in ''add_ta'' and ''remove_ta'' to render ''add_ta.js.erb'' and ''remove_ta.js.erb''. Also changed ''flash[:error]'' to ''flash.now[:error]'' so that the flash message is displayed now instead of after page reload.
[[File:Course_controller_rb1.png]]

* Added a new file ''course/add.js.erb'' and ''course/remove_ta.js.erb'' to views. The ''add_ta.js.erb'' file renders the newly added TA and appends it to the list of TAs. It also shows flash error message if the userid used to add TA does not exist. Similarly, ''remote_ta.js.erb'' file removes the deleted TA from the list.
[[File:add_remove_js_erb.png]]

===Edit Questionnaire===

'''Current scenario :''' page consists of different subsections for creating questionnaire,adding questions to the questionnaire and saving the questionnaire i.e.
*_questionnaire.html.erb

Adding questions feature is performed in the following method of ''questionnaires_controller.rb'' class

def add_new_questions
questionnaire_id = params[:id] unless params[:id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|
question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)
if question.is_a? ScoredQuestion
question.weight = 1
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
end
question.size = '50, 3' if question.is_a? Criterion
question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown
question.size = '60, 5' if question.is_a? TextArea
question.size = '30' if question.is_a? TextField
begin
question.save
rescue
flash[:error] = $ERROR_INFO
end
end
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end

This method invokes ''question.create'' method in ''questions_cotroller.rb'' and saves the created question to the database. Then it redirects to the ''edit.html.erb'' page which causes page refresh while adding questions.

'''Solution:''' This problem was tried to solve using AJAX by changing or adding the following classes and pages
* _question.html.erb (added) - displays added question

<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' <%= @question.id%> '">Remove</a></td>'
<td><input size="6" value="' <%= @question.seq%> '" name="question[' question.id %>'][seq]" id="question_' +<%=@question.id %> '_seq" type="text"></td>
<td><textarea cols="50" rows="1" name="question[' <%= @question.id%> '][txt]" id="question_' <%= @question.id%> '_txt" placeholder="Edit question content here">' <%= @question.txt%> '</textarea></td>
<td><input size="10" disabled="disabled" value="' <%= @question.type%> '" name="question[' <%= @question.id%>'][type]" id="question_' <%= @question.id%> '_type" type="text"></td>
<td></td>

* add_new_questions.js.erb (added) - appends the html content with added question in ''_question.html.erb'' to questions_table in ''_questionnaire.html.erb''

$("#questions_table").append("<%= j render :partial => 'question',
:locals => {question: @question, :id => @question.id, :controller => 'questions'} %>");

* edit.html.erb (modified : code removed) - following code is removed as it internally calls respective question header models and appends html string to questions_table internally.

<% for @question in @questionnaire.questions do%>
<%-# The following line call certain method of the object, which returns html string-%>
<%= @question.edit %>
<% end %>

@question.edit invokes ''QuestionHeader.rb'' model which adds html content
def edit(_count)
html = '<tr>'
html += '<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' + self.id.to_s + '">Remove</a></td>'
html += '<td><input size="6" value="' + self.seq.to_s + '" name="question[' + self.id.to_s + '][seq]" id="question_' + self.id.to_s + '_seq" type="text"></td>'
html += '<td><textarea cols="50" rows="1" name="question[' + self.id.to_s + '][txt]" id="question_' + self.id.to_s + '_txt" placeholder="Edit question content here">' + self.txt + '</textarea></td>'
html += '<td><input size="10" disabled="disabled" value="' + self.type + '" name="question[' + self.id.to_s + '][type]" id="question_' + self.id.to_s + '_type" type="text">''</td>'
html += '<td></td>'
html += '</tr>'
html.html_safe
end

* questionnaires_controller.rb (modified) - add_new_questions method is modified by replacing redire rendering ''add_new_questions.js.erb'' file

render :action=> 'add_new_questions.js.erb', :layout=>false, :question=> question
#redirect_to edit_questionnaire_path(questionnaire_id.to_sym)

'''Issue :''' But this solution is not working as AJAX can be applied to the browser side processing if the controller method is redirecting to the same page, which is not in this case as page gets redirected from question.html.erb to edit.html.erb. Another problem faced is the creation of questions which is called through ''_questionnaire.html.erb'' but not through ''_question.html.erb'' which makes it difficult to pass correct questionnaire id to the AJAX call.

'''Alternative Approach to Edit Questionnaire:''' Another approach to solve this issue is to create a seperate java-script function which handles the entire process of adding,saving,deleting questions and appending them. Call this function from ''_questionnaire.html.erb'' instead of invoking add_new_questions method. Questions can be saved and retrived from data using JavaScript Rest API calls. But, this approach not only needs to restructure entire questionnaire structure and many components in the Expertiza project but also violates the MVC design of the project.

===Un-submit reviews===
'''Earlier scenario:''' When an instructor/TA goes to "Manage Assignments -> Assign Reviewers" page, he/she can see a list of all the topics, the contributors and the reviewers for each topic. This page did not show the status of each review which can be in Assigned state or Saved state or Submitted state. Also, there was no way for the instructor/TA to un-submit an already submitted review.

'''New Additions:'''
* Updated the ''review_mappings/_list_review_mappings.html.erb'' file in views to display the status of each review by the reviewer. For each review_mapping, the code checks if there is a response in ''Response'' table with the same ''map_id'' used in the review_mappings on this page.
** If there is no such response, it means that the reviewer has not saved/submitted the review and it is currently in Assigned State. So, "Response Status: Saved" is shown for that review.
** If there is a response, the last (latest) response is checked as per requirement and the ''is_submitted'' attribute of this response is checked in the ''Response'' table.
*** If the attribute is false, the review has been saved but not submitted. So, "Response Status: Saved" is shown for that review.
*** If the attribute is true, the review has been submitted. So, "Response Status: Submitted" is shown for that review. Next to this, a link is created to un-submit the review. Clicking on this link changes the ''is_submitted'' attribute to false and updates the Response Status to Saved on the page by using AJAX call, without reloading the page
[[File:List_review_mappings_html_erb.png]]
* Added a new method "unsubmit_review" to the ''review_mapping_controller.rb'' file. In this, we first find the latest response and then update the ''is_submitted'' attribute to false. The flash message is created based on whether the response was updated correctly. After this, ''unsubmit_review.js.rb'' file is rendered which updates the response status for the corresponding review on the page to Saved, without reloading the page
[[File:Review_mapping_controller_rb.png]]
* Added a new file ''review_mappings/unsubmit_review.js.erb'' to views. This file just changes the response status for the corresponding review displayed on the page to Saved from Submit after the review has been un-submitted and also prints the corresponding success or error flash message.
[[File:Unsubmit_review_js_erb.png]]
* Added a new line to ''routes.rb'' page for unsubmit_review action
[[File:Routes_rb.png]]

==Test Plan==

===Log in details===

'''Username:''' instructor6
'''password:''' password

Some valid user id's are student5000, student5001, student5002 etc. These can be used while adding new Participant or TA as described below.

===Automated Testing===
* Created a helper module ''wait_for_ajax.rb'' with methods to wait for ajax requests to finish
[[File:Wait_ajax.png]]
* Updated the test "check to see if participants can be added" in ''assignment_creation_spec.rb'' to wait for AJAX calls to finish after adding a participant by using the helper module created
[[File:Assignment_create.png]]
* Added a new file ''course_creation_spec.rb'' to test adding and remove TA's
** This contains test named "should display newly created course" to check if the new course is successfully created (There was no such test earlier)
** This also contains a test named "check to see if TA can be added and removed" which checks if a new TA has gotten added after clicking on Add TA and and later removed after clicking on Delete
[[File:Add_ta.png]]
* Added a new test named "can unsubmit a review" in ''review_mapping_spec.rb''
** In this test, a new reviewer is added to review mapping, a new review is created and submitted, and then checked if unsubmit functionality is working correctly
[[File:Unsubmit_review.png]]

===UI Testing===

'''Steps to test adding participant: '''

* Login as instructor
* Go to Manage -> Assignments.
* Switch to Assignments tab incase you are on some other tab
* For any assignment, click on the 'Add Participant' icon to go on add new participant page
* Enter userid of the participant and click on Add to add the participant

'' Expected Output: '' When add button is clicked with valid userid, new participant should be added to the list without the page getting reloaded. In case of an attempt to add invalid user, the error should be displayed on top without page getting reloaded.

''' Steps to test adding/removing TA:'''

* Login as instructor
* Go to Manage -> Courses.
* Switch to Courses tab incase you are on some other tab
* For any course, click on the 'Add TA' icon to go on add new TA page
* Enter userid of the TA and click on Add to add the TA
* Click on 'remove_ta' link for any TA in the list to remove the TA

'' Expected Output: '' When add button is clicked with valid userid, new TA should be added to the list without the page getting reloaded. In case of an attempt to add invalid user, the error should be displayed on top without page getting reloaded. When remove_ta link is clicked for any TA in the list, that corresponding TA should be removed from the list without the page getting reloaded.

''' Steps to test adding question in questionnaire:'''

* Login as instructor
* Go to Manage -> Questionnaires. Create a new Review Questionnaire by clicking on the ‘New public item’ button for ‘Review’.
* Name the Questionnaire and click on create button
* Click on Edit for newly created questionnaire. You will now be navigated to page where you can add new questions to the questionnaire.
* Click on add button in "Questions" section.

''Expected output:'' When add button is clicked, question should be created and the questionnaire page should not get reloaded

''' Steps to test un-submit reviews'''

* Login as instructor
* Go to Manage -> Assignments.
* Switch to Assignments tab incase you are on some other tab
* For any assignment, click on the 'Assign reviewers' icon to go to the review mappings page
** Note: Some assignments might not have reviewers. So, try this for assignments with many reviewers
* For any review with Review Status = Submitted, click on 'unsubmit' button

''Expected output:'' For every review, the review status should be seen as either Assigned or Saved or Submitted. For submitted reviews, when unsubmit button is clicked, that review should be unsubmitted and status should change to Saved without page getting reloaded.

==Project Deployment==

Expertiza setup is done in VCL which is reserved for 30 days with Ubuntu 14.04 base. Started expertiza server publicly and link to access the server is:
http://152.7.99.101:3000

==Future work==

In future, we will try to implement the edit questionnaire part using alternative approach. We will try to implement testing using rspec framework and improve the UI design of the pages.

==References==

* https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg
* https://github.com/expertiza/expertiza
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation
* http://guides.rubyonrails.org/working_with_javascript_in_rails.html
* http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:Linux:Debian

File:Add ta.png

2017-04-01T06:45:49Z

Psvaidya: uploaded a new version of "File:Add ta.png"

CSC/ECE 517 Spring 2017/Use Ajax to add Participants,TA and Edit Questionnaire

2017-04-01T06:42:08Z

Psvaidya: /* Automated Testing */

==Introduction==

<nowiki> Expertiza is an opensource software developed to assist people in education institutions to perform peer reviews and group projects. It is exceptionally helpful to the students and instructors. The software is designed in MVC (Model-View-Controller) architecture using ruby on rails.
</nowiki>

==Problem Statement==
Expertiza provides many categories to manage for an instructor. Few of these categories are assignments, courses and questionnaires. Currently, to add/remove/update records, the entire page is submitted to save the record and the entire page is re-loaded back again to reflect the changes on the page. The task is to improve this functionality such that some of the records, specifically adding participants to courses or assignments, adding/removing teaching assistants to/from courses and adding questions to questionnaires, can be saved remotely and the page updated without submitting and reloading the entire page.
Additionally, on assign reviewers page for an assignment, there is no way to see the current status of reviews and there is no way for an instructor to unsubmit a submitted review. So, another task is to add this functionality such that review status is seen for each review and to unsubmit a submitted review without reloading the page.

==Proposed Solution==
This project proposes use of AJAX for the required pages to avoid page reloading at the time of adding and saving records. This solution will make sure that adding or saving of record is done remotely and the page is updated without reloading. It can be achieved by calling corresponding controller method, adding/saving the record remotely and rendering it back to JavaScript pages in the view instead of redirecting it to the same page. JavaScript pages in the view will update the page without reloading it, for example by appending the newly added record to the list of records. Thus, records are saved remotely and page refresh is avoided.
For the review status part, responses to the corresponding reviews on the page can be checked in the Response table and the review status shown as the status of the latest response. Unsubmitting a review can be done using AJAX without reloading the page.

==Tasks==
* Add Participant in the assignments section using AJAX
* Add/Remove TA in the courses section using AJAX
* Edit Questionnaire by using AJAX for adding questions in the Questionnaire section
* Show Review Status on assign reviewers page and allow to un-submit a review using AJAX

==Implementation==

===Adding participant===
'''Earlier scenario:''' When an instructor goes to "Manage Assignments -> Add Participants" page, he/she can add/remove new Participant to the assignment. The add page also displays list of participants above the form for new participant. Every time a new Participant is added, the page reloads to reflect the changes and render the updated list of participants, even in case of non-existing userid.

'''Updates/Changes:'''
This page has been updated such that an instructor can add a new Participant using [https://en.wikipedia.org/wiki/Ajax_(programming) AJAX]. After adding AJAX changes, the list gets updated without reloading the entire page. The changes made are below.

* Updated the ''shared_scripts/_user_list.html.erb'' file in views so that the Participants are listed by rendering another partial ''_participant.html.erb'' in participants controller. This change is to make it feasible to add AJAX to just append to the list without any extra formatting.
[[File:User_list.PNG]]

* Created a new file ''participants/add.js.erb'' for adding AJAX to render newly added participant in case of successful addition and display error in case of any error.
[[File:Javascript changes.PNG]]

* Updated the ''shared_scripts/_add_individual.html.erb'' form such that request should be through AJAX by setting remote flag to true.
[[File:Add_individual.PNG]]

* Updated the participants controller ''participant_controller.rb'' in controllers to render JavaScript when add method is invoked by the form submit action instead of redirect to list page.
[[File:Controller_changes.PNG]]

===Adding/Removing TA===
'''Earlier scenario:''' When an instructor goes to "Manage Courses -> Add TA" page, he/she can add/remove new TA to the course. Every time a new TA is added or removed, the page reloads to reflect the changes, even if the userid used does not exist.

'''Updates/Changes:''' This page has been updated such that an instructor can add a new TA or remove a new TA using AJAX. With these updates, the changes are reflected on the page without reloading the page, thus saving time.
* Updated the ''course/view_teaching_assistants.html.erb'' file in views so that the TAs are listed by rendering another partial ''_ta.html.erb''. This is done so that when a new TA has been added, AJAX call can be used to render the format required for the new TA in the list append to the already existing list without reloading the page.
[[File:View_teaching_assistants_html_erb.png]]

* Created a new file ''course/_ta.html.erb'' in views which is a partial as described above and contains the code to list the TAs. The link_to "Delete" line in this file is updated to use :remote=>:true, so that AJAX call can be made to remove the TA remotely without reloading the page.
<pre>
<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post, :remote => true, :class => 'remove_ta' %>
</pre>
[[File:Ta.png]]

* Updated the ''course/_add_individual.html.erb'' file in views to perform the form_tag action to Add a TA remotely using :remote=>:true. In the below code, ''form_action'' and ''remote'' are local variables passed to this partial from ''course/view_teaching_assistants.html.erb'' with the values "add_ta" and "true" respectively
[[File:Add_individual_html_erb.png]]

* Updated the ''course_controller.rb" file and replaced the redirect option in ''add_ta'' and ''remove_ta'' to render ''add_ta.js.erb'' and ''remove_ta.js.erb''. Also changed ''flash[:error]'' to ''flash.now[:error]'' so that the flash message is displayed now instead of after page reload.
[[File:Course_controller_rb1.png]]

* Added a new file ''course/add.js.erb'' and ''course/remove_ta.js.erb'' to views. The ''add_ta.js.erb'' file renders the newly added TA and appends it to the list of TAs. It also shows flash error message if the userid used to add TA does not exist. Similarly, ''remote_ta.js.erb'' file removes the deleted TA from the list.
[[File:add_remove_js_erb.png]]

===Edit Questionnaire===

'''Current scenario :''' page consists of different subsections for creating questionnaire,adding questions to the questionnaire and saving the questionnaire i.e.
*_questionnaire.html.erb

Adding questions feature is performed in the following method of ''questionnaires_controller.rb'' class

def add_new_questions
questionnaire_id = params[:id] unless params[:id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|
question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)
if question.is_a? ScoredQuestion
question.weight = 1
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
end
question.size = '50, 3' if question.is_a? Criterion
question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown
question.size = '60, 5' if question.is_a? TextArea
question.size = '30' if question.is_a? TextField
begin
question.save
rescue
flash[:error] = $ERROR_INFO
end
end
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end

This method invokes ''question.create'' method in ''questions_cotroller.rb'' and saves the created question to the database. Then it redirects to the ''edit.html.erb'' page which causes page refresh while adding questions.

'''Solution:''' This problem was tried to solve using AJAX by changing or adding the following classes and pages
* _question.html.erb (added) - displays added question

<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' <%= @question.id%> '">Remove</a></td>'
<td><input size="6" value="' <%= @question.seq%> '" name="question[' question.id %>'][seq]" id="question_' +<%=@question.id %> '_seq" type="text"></td>
<td><textarea cols="50" rows="1" name="question[' <%= @question.id%> '][txt]" id="question_' <%= @question.id%> '_txt" placeholder="Edit question content here">' <%= @question.txt%> '</textarea></td>
<td><input size="10" disabled="disabled" value="' <%= @question.type%> '" name="question[' <%= @question.id%>'][type]" id="question_' <%= @question.id%> '_type" type="text"></td>
<td></td>

* add_new_questions.js.erb (added) - appends the html content with added question in ''_question.html.erb'' to questions_table in ''_questionnaire.html.erb''

$("#questions_table").append("<%= j render :partial => 'question',
:locals => {question: @question, :id => @question.id, :controller => 'questions'} %>");

* edit.html.erb (modified : code removed) - following code is removed as it internally calls respective question header models and appends html string to questions_table internally.

<% for @question in @questionnaire.questions do%>
<%-# The following line call certain method of the object, which returns html string-%>
<%= @question.edit %>
<% end %>

@question.edit invokes ''QuestionHeader.rb'' model which adds html content
def edit(_count)
html = '<tr>'
html += '<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' + self.id.to_s + '">Remove</a></td>'
html += '<td><input size="6" value="' + self.seq.to_s + '" name="question[' + self.id.to_s + '][seq]" id="question_' + self.id.to_s + '_seq" type="text"></td>'
html += '<td><textarea cols="50" rows="1" name="question[' + self.id.to_s + '][txt]" id="question_' + self.id.to_s + '_txt" placeholder="Edit question content here">' + self.txt + '</textarea></td>'
html += '<td><input size="10" disabled="disabled" value="' + self.type + '" name="question[' + self.id.to_s + '][type]" id="question_' + self.id.to_s + '_type" type="text">''</td>'
html += '<td></td>'
html += '</tr>'
html.html_safe
end

* questionnaires_controller.rb (modified) - add_new_questions method is modified by replacing redire rendering ''add_new_questions.js.erb'' file

render :action=> 'add_new_questions.js.erb', :layout=>false, :question=> question
#redirect_to edit_questionnaire_path(questionnaire_id.to_sym)

'''Issue :''' But this solution is not working as AJAX can be applied to the browser side processing if the controller method is redirecting to the same page, which is not in this case as page gets redirected from question.html.erb to edit.html.erb. Another problem faced is the creation of questions which is called through ''_questionnaire.html.erb'' but not through ''_question.html.erb'' which makes it difficult to pass correct questionnaire id to the AJAX call.

'''Alternative Approach to Edit Questionnaire:''' Another approach to solve this issue is to create a seperate java-script function which handles the entire process of adding,saving,deleting questions and appending them. Call this function from ''_questionnaire.html.erb'' instead of invoking add_new_questions method. Questions can be saved and retrived from data using JavaScript Rest API calls. But, this approach not only needs to restructure entire questionnaire structure and many components in the Expertiza project but also violates the MVC design of the project.

===Un-submit reviews===
'''Earlier scenario:''' When an instructor/TA goes to "Manage Assignments -> Assign Reviewers" page, he/she can see a list of all the topics, the contributors and the reviewers for each topic. This page did not show the status of each review which can be in Assigned state or Saved state or Submitted state. Also, there was no way for the instructor/TA to un-submit an already submitted review.

'''New Additions:'''
* Updated the ''review_mappings/_list_review_mappings.html.erb'' file in views to display the status of each review by the reviewer. For each review_mapping, the code checks if there is a response in ''Response'' table with the same ''map_id'' used in the review_mappings on this page.
** If there is no such response, it means that the reviewer has not saved/submitted the review and it is currently in Assigned State. So, "Response Status: Saved" is shown for that review.
** If there is a response, the last (latest) response is checked as per requirement and the ''is_submitted'' attribute of this response is checked in the ''Response'' table.
*** If the attribute is false, the review has been saved but not submitted. So, "Response Status: Saved" is shown for that review.
*** If the attribute is true, the review has been submitted. So, "Response Status: Submitted" is shown for that review. Next to this, a link is created to un-submit the review. Clicking on this link changes the ''is_submitted'' attribute to false and updates the Response Status to Saved on the page by using AJAX call, without reloading the page
[[File:List_review_mappings_html_erb.png]]
* Added a new method "unsubmit_review" to the ''review_mapping_controller.rb'' file. In this, we first find the latest response and then update the ''is_submitted'' attribute to false. The flash message is created based on whether the response was updated correctly. After this, ''unsubmit_review.js.rb'' file is rendered which updates the response status for the corresponding review on the page to Saved, without reloading the page
[[File:Review_mapping_controller_rb.png]]
* Added a new file ''review_mappings/unsubmit_review.js.erb'' to views. This file just changes the response status for the corresponding review displayed on the page to Saved from Submit after the review has been un-submitted and also prints the corresponding success or error flash message.
[[File:Unsubmit_review_js_erb.png]]
* Added a new line to ''routes.rb'' page for unsubmit_review action
[[File:Routes_rb.png]]

==Test Plan==

===Log in details===

'''Username:''' instructor6
'''password:''' password

Some valid user id's are student5000, student5001, student5002 etc. These can be used while adding new Participant or TA as described below.

===Automated Testing===
* Created a helper module ''wait_for_ajax.rb'' with methods to wait for ajax requests to finish
[[File:Wait_ajax.png]]
* Updated the test "check to see if participants can be added" in ''assignment_creation_spec.rb'' to wait for AJAX calls to finish after adding a participant by using the helper module created
[[File:Assignment_create.png]]
* Added a new file ''course_creation_spec.rb'' to test adding and remove TA's
** This contains test named "should display newly created course" to check if the new course is successfully created (There was no such test earlier)
** This also contains a test named "check to see if TA can be added and removed" which checks if a new TA has gotten added after clicking on Add TA and and later removed after clicking on Delete
[[File:Add_ta.png]]
* Added a new test named "can unsubmit a review" in ''review_mapping_spec.rb''
** In this test, a new reviewer is added to review mapping, a new review is created and submitted, and then checked if unsubmit functionality is working correctly
[[File:Unsubmit_review.png]]

===UI Testing===

'''Steps to test adding participant: '''

* Login as instructor
* Go to Manage -> Assignments.
* Switch to Assignments tab incase you are on some other tab
* For any assignment, click on the 'Add Participant' icon to go on add new participant page
* Enter userid of the participant and click on Add to add the participant

'' Expected Output: '' When add button is clicked with valid userid, new participant should be added to the list without the page getting reloaded. In case of an attempt to add invalid user, the error should be displayed on top without page getting reloaded.

''' Steps to test adding/removing TA:'''

* Login as instructor
* Go to Manage -> Courses.
* Switch to Courses tab incase you are on some other tab
* For any course, click on the 'Add TA' icon to go on add new TA page
* Enter userid of the TA and click on Add to add the TA
* Click on 'remove_ta' link for any TA in the list to remove the TA

'' Expected Output: '' When add button is clicked with valid userid, new TA should be added to the list without the page getting reloaded. In case of an attempt to add invalid user, the error should be displayed on top without page getting reloaded. When remove_ta link is clicked for any TA in the list, that corresponding TA should be removed from the list without the page getting reloaded.
Note: A duplicate TA is currently allowed. This was a part of original (earlier) functionality, and as this project involved changes to use AJAX and not changes to the actual functionality, this original functionality is not changed

''' Steps to test adding question in questionnaire:'''

* Login as instructor
* Go to Manage -> Questionnaires. Create a new Review Questionnaire by clicking on the ‘New public item’ button for ‘Review’.
* Name the Questionnaire and click on create button
* Click on Edit for newly created questionnaire. You will now be navigated to page where you can add new questions to the questionnaire.
* Click on add button in "Questions" section.

''Expected output:'' When add button is clicked, question should be created and the questionnaire page should not get reloaded

''' Steps to test un-submit reviews'''

* Login as instructor
* Go to Manage -> Assignments.
* Switch to Assignments tab incase you are on some other tab
* For any assignment, click on the 'Assign reviewers' icon to go to the review mappings page
** Note: Some assignments might not have reviewers. So, try this for assignments with many reviewers
* For any review with Review Status = Submitted, click on 'unsubmit' button

''Expected output:'' For every review, the review status should be seen as either Assigned or Saved or Submitted. For submitted reviews, when unsubmit button is clicked, that review should be unsubmitted and status should change to Saved without page getting reloaded.

==Project Deployment==

Expertiza setup is done in VCL which is reserved for 30 days with Ubuntu 14.04 base. Started expertiza server publicly and link to access the server is:
http://152.7.99.101:3000

==Future work==

In future, we will try to implement the edit questionnaire part using alternative approach. We will try to implement testing using rspec framework and improve the UI design of the pages.

==References==

* https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg
* https://github.com/expertiza/expertiza
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation
* http://guides.rubyonrails.org/working_with_javascript_in_rails.html
* http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:Linux:Debian

File:Add ta.png

2017-04-01T06:39:08Z

Psvaidya: uploaded a new version of "File:Add ta.png"

File:Unsubmit review.png

2017-04-01T06:37:29Z

Psvaidya: uploaded a new version of "File:Unsubmit review.png"

File:Assignment create.png

2017-04-01T06:36:26Z

Psvaidya: uploaded a new version of "File:Assignment create.png"

File:Wait ajax.png

2017-04-01T06:35:39Z

Psvaidya: uploaded a new version of "File:Wait ajax.png"

File:Routes rb.png

2017-04-01T06:34:14Z

Psvaidya: uploaded a new version of "File:Routes rb.png"

Updates to routes.rb file

File:Unsubmit review js erb.png

2017-04-01T06:33:42Z

Psvaidya: uploaded a new version of "File:Unsubmit review js erb.png"

Code from newly added file "views/review_mappings/unsubmit_review.js.erb"

File:Review mapping controller rb.png

2017-04-01T06:32:39Z

Psvaidya: uploaded a new version of "File:Review mapping controller rb.png"

The code changes in file "controller/review_mapping_controller.rb"

File:List review mappings html erb.png

2017-04-01T06:31:48Z

Psvaidya: uploaded a new version of "File:List review mappings html erb.png"

The code changes in file "views/_list_review_mappings.html.erb"

File:Course controller rb1.png

2017-04-01T06:31:02Z

Psvaidya: uploaded a new version of "File:Course controller rb1.png"

Updates to course controller file

File:Add remove js erb.png

2017-04-01T06:29:51Z

Psvaidya: uploaded a new version of "File:Add remove js erb.png"

File:Add individual html erb.png

2017-04-01T06:28:48Z

Psvaidya: uploaded a new version of "File:Add individual html erb.png"

File:Ta.png

2017-04-01T06:26:49Z

Psvaidya: uploaded a new version of "File:Ta.png"

File:View teaching assistants html erb.png

2017-04-01T06:25:48Z

Psvaidya: uploaded a new version of "File:View teaching assistants html erb.png"

Updates to file views/courses/view_teaching_assistants.html.erb

File:Controller changes.PNG

2017-04-01T06:23:59Z

Psvaidya: uploaded a new version of "File:Controller changes.PNG"

controller changes

File:Add individual.PNG

2017-04-01T06:23:11Z

Psvaidya: uploaded a new version of "File:Add individual.PNG"

File:Javascript changes.PNG

2017-04-01T06:22:18Z

Psvaidya: uploaded a new version of "File:Javascript changes.PNG"

javascript changes

File:User list.PNG

2017-04-01T06:20:58Z

Psvaidya: uploaded a new version of "File:User list.PNG"

user list

File:Unsubmit review.png

2017-04-01T06:18:11Z

Psvaidya: uploaded a new version of "File:Unsubmit review.png"