Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-12T02:53:34Z

Ethedla:

This page provides information about the documentation of E2241: Heatgrid fixes and improvements as part of CSC/ECE 517 Spring 2022 Final project.
__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
*Nicholas Himes (nnhimes)
<h3> Team Members (PinkPatterns) </h3>
* Eshwar Chandra Vidhyasagar Thedla (ethedla)
* Gokul Krishna Koganti (gkogant)
* Jyothi Sumer Goud Maduru (jmaduru)
* Suneha Bose (sbose2)

<h2> Heat Grid </h2>

Heat Grid refers to a part of view in Expertiza that shows review scores of all the reviews done for a particular assignment. It shows scores given for each rubric by peer reviewers. This is used by instructors to assign scores to individual assignments and by students to view review scores of their assignment. Our project scope involves dealing with fixing issues related to the heat grid and any subsequent bugs that might arrive.

<h2> Issues identified </h2>
<h3> Issue #2019: Restrict teammates from reviewing their own work</h3>
<p> There are some instances where a student was shown as reviewing his/her team even though the "Allow Self Review" checkbox was not checked by the instructor. This situation should not arise for practical purposes. Test cases must be extensively added so that we can be notified if the bug occurs again. </p>

[[File:Screen Shot 2022-04-06 at 10.37.56 PM.png|center|450px]]

<h3> Issue #1869: Deal with the metrics of the heat grid</h3>
<p> <b>metric-1</b> column name in the heat grid follows bad naming convention. It doesn't explain what the column refers to. This must be changed to make the column name more apt.</p>
<p> As of now, the heat grid uses only one metric (metric-1). We must facilitate the system for addition of new metrics. Instructors should be able to toggle between various metrics as per their preferences. This can be done by the use of a drop down menu.</p>

[[File:Screen Shot 2022-04-06 at 10.34.47 PM.png|center|550px]]

<h2> Plan of work </h2>
<h3> Issue #2019: Restrict teammates from reviewing their own work </h3>
<p>Relevant bug of this issue can’t be reproduced to deal with it. So comprehensive test cases must be written to be notified if the bug arises again. We are planning to add rspec unit tests covering the following cases:
</p>
<ul>
<li><b> If the instructor unchecks “ Allow self review” option</b></li>
<ol>
<li> Instructor should not be able to assign a student to review work that he/she has submitted. </li>
<li> Instructor should not be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should not be able to review work he/she has submitted.</li>
<li> Students should not be able to review work a teammate has submitted.</li>
</ol>
<li><b> If the instructor checks “ Allow self review” option</b></li>
<ol>
<li> Instructor should be able to assign a student to review work that he/she has submitted.</li>
<li> Instructor should be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should be able to review work he/she has submitted. </li>
<li> Students should be able to review work a teammate has submitted.</li>
</ol>
</ul>

<h3> Issue #1869: Deal with the metrics of the heat grid </h3>
<p>The new metrics can be added to the Metrics table that we will create. While creating an assignment/ editing an assignment, the instructor can select a metric from the Metrics table which will be available as a dropdown menu. We will retrieve the metric selected for the assignment by the instructor and display it in the Heatgrid Map of reviews.</p>

* In create/edit assignment, the instructor will see ‘Metric Type’ drop down which has list of metrics based on the values in the database
* Save the selected metric type and update the value in the database
* Retrieve the metric type from the assignment and calculate the value of the metric
* Display the values of the metric in the Heatgrid view

<h4> Proposed Control Flow </h4>

[[File:Proposed_Control_Flow.drawio.png]]

<h4>UML Diagram </h4>

[[File:UML diagram E2241.png|center|600px]]

<h2> Design Principle </h2>
For Issue #1869 we plan to use the Factory Design Pattern since we are dealing with the creation of multiple kinds of metrics. As part of our implementation, we plan on using a metric interface, which can be implemented by different concrete metric classes. A factory class acts as a middleman between the implementations and the main class that instantiates the objects. Based on the instructor's selection, the main class requests the metric object from the factory class, rather than dealing with the creation logic on its own. This pattern, therefore, enforces encapsulation and results in the low coupling, the principle which is our primary target for this project scope.
<h2> Files to be targeted </h2>

<h3>Issue #2019</h3>
<p> Test file for adding test cases to implement self-reviews checks </p>
* spec/controllers/grades_controller_spec.rb

<h3>Issue #1869</h3>
<p>For Heat grid view</p>
* app/views/grades/_view_heatgrid.html.erb
* app/views/grades/view_team.html.erb
* app/helpers/grades_helper.rb
* app/controllers/grades_controller.rb
* app/models/vm_question_response.rb
* app/models/vm_question_row.rb
* assets/view_team_in_grades.js
<p>For Assignment view</p>
* app/views/assignment/edit/_general.html.erb
* app/controllers/assignments_controller.rb

<h2> Test Plan </h2>

<h3>Video Demo</h3>

The video link will be provided after the final submission.

<h3>Primary Goal of Testing</h3>

* Capybara Test cases for testing the UI of heat grid view with the expected metric for the respective assignment and the UI of team view with relevant metric selected with all other metrics in the dropdown
* Spec test cases for testing the grades controller and assignment controller to check if they are returning the values as expected
* Unit test cases will be added to verify the logic behind the methods to calculate the values for their metrics

<h3>RSpec Tests</h3>

<h4>Functional Tests</h4>

<pre>
Scenario Visibility of Metric dropdown list in New Assignment
Given Instructor has logged in
When Instructor clicks on New Assignment button
Then Metric dropdown list is visible
</pre>

<pre>
Scenario: Visibility of Metric dropdown list in Edit Assignment
Given Instructor has logged in
When Instructor clicks on Edit Assignment button
Then Metric dropdown list is visible
</pre>

<pre>
Scenario: Visibility of selected metric in instructor's Assign Grade view
Given Instructor has logged in
When Instructor clicks on View Submission button
And Instructor clicks on Assign Grade button
Then Selected metric is visible in heatgrid map
</pre>

<pre>
Scenario: Visibility of selected metric in student's View Scores view
Given Student has logged in
When Student clicks on View Scores button
Then Selected metric is visible in heatgrid map
</pre>

<h4>Unit Tests</h4>

<pre>
Scenario: The output for the metric “Comment Count”
Given: Instructor is logged in
When: Instructor selects metric as “Comment Count” for an assignment
Then: outputs 15 for the comment “The team has documented everything on the wiki page very properly following all the guidelines”
</pre>

<pre>
Scenario: The output for the metric “Comment Count”
Given: Instructor is logged in
When: Instructor selects metric as “Comment Count” for an assignment
Then: outputs 0 for the comment “”
</pre>

<h3>Regression Tests</h3>

When the new functionalities are implemented and added, make sure the existing functionalities and test cases still pass.

<h2> Important Links </h2>
* GitHub repository link: https://github.com/EshwarCVS/expertiza
* Project Description Document: https://docs.google.com/document/d/1H0BjzMBz5it7Wckhegq4LXhMi8RVctTwVzP2x9gnFCo/edit#heading=h.tqdrrd12xs4x
* GitHub Issue #1869: https://github.com/expertiza/expertiza/issues/1869
* GitHub Issue #2019: https://github.com/expertiza/expertiza/issues/2019

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T03:02:57Z

Ethedla:

This page provides information about the refactoring work done on the reputation web service controller as part of the OSS project.

__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
*Nicholas Himes (nnhimes)
<h3> Team Members (PinkPatterns) </h3>
* Eshwar Chandra Vidhyasagar Thedla (ethedla)
* Gokul Krishna Koganti (gkogant)
* Jyothi Sumer Goud Maduru (jmaduru)
* Suneha Bose (sbose2)

<h2> Heat Grid </h2>

Heat Grid refers to a part of view in expertiza that shows review scores of all the reviews done for a particular assignment. It shows scores given for each rubric by peer reviewers. This is used by instructors to assign scores to individual assignments and by students to view review scores of their assignment. Our project scope involves dealing with fixing issues related to the heat grid and any subsequent bugs that might arrive.

<h2> Issues identified </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p> There are some instances where a student was shown as reviewing his/her team. This is impossible and is classified as a bug. This must be dealt with. Test cases must be extensively added so that we can be notified if the bug occurs again. </p>

[[File:Screen Shot 2022-04-06 at 10.37.56 PM.png|center|450px]]

<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p> <b>metric-1</b> column name in the heat grid follows bad naming convention. It doesn't explain what the column refers to. This must be changed to make the column name more apt.</p>
<p> As of now, the heat grid uses only one metric (metric-1). We must facilitate the system for addition of new metrics. Instructors should be able to toggle between various metrics as per their preferences. This can be done by the use of a drop down menu.</p>

[[File:Screen Shot 2022-04-06 at 10.34.47 PM.png|center|550px]]

<h2> Plan of work </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p>Relevant bug of this issue can’t be reproduced to deal with it. So comprehensive test cases must be written to be notified if the bug arises again. We are planning to add rspec unit tests covering the following cases:
</p>
<ul>
<li><b> If the instructor unchecks “ Allow self review” option</b></li>
<ol>
<li> Instructor should not be able to assign a student to review work that he/she has submitted. </li>
<li> Instructor should not be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should not be able to review work he/she has submitted.</li>
<li> Students should not be able to review work a teammate has submitted.</li>
</ol>
<li><b> If the instructor checks “ Allow self review” option</b></li>
<ol>
<li> Instructor should be able to assign a student to review work that he/she has submitted.</li>
<li> Instructor should be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should be able to review work he/she has submitted. </li>
<li> Students should be able to review work a teammate has submitted.</li>
</ol>
</ul>

<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p>The new metrics can be added to the Metrics table that we will create. While creating an assignment/ editing an assignment, the instructor can select a metric from the Metrics table which will be available as a dropdown menu. We will retrieve the metric selected for the assignment by the instructor and display it in the Heatgrid Map of reviews.</p>

* In create/edit assignment, the instructor will see ‘Metric Type’ drop down which has list of metrics based on the values in the database
* Save the selected metric type and update the value in the database
* Retrieve the metric type from the assignment and calculate the value of the metric
* Display the values of the metric in the Heatgrid view

<h4> Proposed Control Flow </h4>
[[File:Proposed_Control_Flow.drawio.png]]

<h2> Files to be targeted </h2>
<h3>Issue #1869</h3>
<p>For Heat grid</p>
* app/views/grades/_view_heatgrid.html.erb
* app/views/grades/view_team.html.erb
* app/helpers/grades_helper.rb
* app/controllers/grades_controller.rb
* app/models/vm_question_response.rb
* app/models/vm_question_row.rb
<p>For Assignment</p>
* app/views/assignment/edit/_general.html.erb
* app/controllers/assignments_controller.rb

<h2> Test Plan </h2>
* Capybara Test cases for testing the UI of heat grid view with the expected metric for the respective assignment and the UI of team view with relevant metric selected with all other metrics in the dropdown
* Spec test cases for testing the grades controller and assignment controller to check if they are returning the values as expected
* Unit test cases will be added to verify the logic behind the methods to calculate the values for their metrics

<h2> Important Links </h2>
* GitHub repository link: https://github.com/EshwarCVS/expertiza
* Project Description Document: https://docs.google.com/document/d/1H0BjzMBz5it7Wckhegq4LXhMi8RVctTwVzP2x9gnFCo/edit#heading=h.tqdrrd12xs4x
* GitHub Issue #1869: https://github.com/expertiza/expertiza/issues/1869
* GitHub Issue #2019: https://github.com/expertiza/expertiza/issues/2019

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:12:35Z

Ethedla:

This page provides information about the refactoring work done on the reputation web service controller as part of the OSS project.

__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
*Nicholas Himes (nnhimes)
<h3> Team Members (PinkPatterns) </h3>
* Eshwar Chandra Vidhyasagar Thedla (ethedla)
* Gokul Krishna Koganti (gkogant)
* Jyothi Sumer Goud Maduru (jmaduru)
* Suneha Bose (sbose2)

<h2> Heat Grid </h2>

Heat Grid refers to a part of view in expertiza that shows review scores of all the reviews done for a particular assignment. It shows scores given for each rubric by peer reviewers. This is used by instructors to assign scores to individual assignments and by students to view review scores of their assignment. Our project scope involves dealing with fixing issues related to the heat grid and any subsequent bugs that might arrive.

<h2> Issues identified </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p> There are some instances where a student was shown as reviewing his/her team. This is impossible and is classified as a bug. This must be dealt with. Test cases must be extensively added so that we can be notified if the bug occurs again. </p>
<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p> <b>metric-1</b> column name in the heat grid follows bad naming convention. It doesn't explain what the column refers to. This must be changed to make the column name more apt.</p>
<p> As of now, the heat grid uses only one metric (metric-1). We must facilitate the system for addition of new metrics. Instructors should be able to toggle between various metrics as per their preferences. This can be done by the use of a drop down menu.</p>

<h2> Plan of work </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p>Relevant bug of this issue can’t be reproduced to deal with it. So comprehensive test cases must be written to be notified if the bug arises again. We are planning to add rspec unit tests covering the following cases:
</p>
<ul>
<li><b> If the instructor unchecks “ Allow self review” option</b></li>
<ol>
<li> Instructor should not be able to assign a student to review work that he/she has submitted. </li>
<li> Instructor should not be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should not be able to review work he/she has submitted.</li>
<li> Students should not be able to review work a teammate has submitted.</li>
</ol>
<li><b> If the instructor checks “ Allow self review” option</b></li>
<ol>
<li> Instructor should be able to assign a student to review work that he/she has submitted.</li>
<li> Instructor should be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should be able to review work he/she has submitted. </li>
<li> Students should be able to review work a teammate has submitted.</li>
</ol>
</ul>

<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p>The new metrics can be added to the Metrics table that we will create. While creating an assignment/ editing an assignment, the instructor can select a metric from the Metrics table which will be available as a dropdown menu. We will retrieve the metric selected for the assignment by the instructor and display it in the Heatgrid Map of reviews.</p>

<h2> Files to be targeted </h2>
<h3>Issue #1869</h3>
<p>For Heat grid</p>
* app/views/grades/_view_heatgrid.html.erb
* app/views/grades/view_team.html.erb
* app/helpers/grades_helper.rb
* app/controllers/grades_controller.rb
* app/models/vm_question_response.rb
* app/models/vm_question_row.rb
<p>For Assignment</p>
* app/views/assignment/edit/_general.html.erb
* app/controllers/assignments_controller.rb

<h2> Test Plan </h2>
* Capybara Test cases for testing the UI of heat grid view with the expected metric for the respective assignment and the UI of team view with relevant metric selected with all other metrics in the dropdown
* Spec test cases for testing the grades controller and assignment controller to check if they are returning the values as expected
* Unit test cases will be added to verify the logic behind the methods to calculate the values for their metrics

<h2> Important Links </h2>
* GitHub repository link: https://github.com/EshwarCVS/expertiza
* Project Description Document: https://docs.google.com/document/d/1H0BjzMBz5it7Wckhegq4LXhMi8RVctTwVzP2x9gnFCo/edit#heading=h.tqdrrd12xs4x
* GitHub Issue #1869: https://github.com/expertiza/expertiza/issues/1869
* GitHub Issue #2019: https://github.com/expertiza/expertiza/issues/2019

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:11:58Z

Ethedla:

This page provides information about the refactoring work done on the reputation web service controller as part of the OSS project.

__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
*Nicholas Himes (nnhimes)
<h3> Team Members (PinkPatterns) </h3>
* Eshwar Chandra Vidhyasagar Thedla (ethedla)
* Gokul Krishna Koganti (gkogant)
* Jyothi Sumer Goud Maduru (jmaduru)
* Suneha Bose (sbose2)

<h2> Heat Grid </h2>

Heat Grid refers to a part of view in expertiza that shows review scores of all the reviews done for a particular assignment. It shows scores given for each rubric by peer reviewers. This is used by instructors to assign scores to individual assignments and by students to view review scores of their assignment. Our project scope involves dealing with fixing issues related to the heat grid and any subsequent bugs that might arrive.

<h2> Issues identified </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p> There are some instances where a student was shown as reviewing his/her team. This is impossible and is classified as a bug. This must be dealt with. Test cases must be extensively added so that we can be notified if the bug occurs again. </p>
<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p> <b>metric-1</b> column name in the heat grid follows bad naming convention. It doesn't explain what the column refers to. This must be changed to make the column name more apt.</p>
<p> As of now, the heat grid uses only one metric (metric-1). We must facilitate the system for addition of new metrics. Instructors should be able to toggle between various metrics as per their preferences. This can be done by the use of a drop down menu.</p>

<h2> Current Implementation </h2>

<h2> Plan of work </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p>Relevant bug of this issue can’t be reproduced to deal with it. So comprehensive test cases must be written to be notified if the bug arises again. We are planning to add rspec unit tests covering the following cases:
</p>
<ul>
<li><b> If the instructor unchecks “ Allow self review” option</b></li>
<ol>
<li> Instructor should not be able to assign a student to review work that he/she has submitted. </li>
<li> Instructor should not be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should not be able to review work he/she has submitted.</li>
<li> Students should not be able to review work a teammate has submitted.</li>
</ol>
<li><b> If the instructor checks “ Allow self review” option</b></li>
<ol>
<li> Instructor should be able to assign a student to review work that he/she has submitted.</li>
<li> Instructor should be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should be able to review work he/she has submitted. </li>
<li> Students should be able to review work a teammate has submitted.</li>
</ol>
</ul>

<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p>The new metrics can be added to the Metrics table that we will create. While creating an assignment/ editing an assignment, the instructor can select a metric from the Metrics table which will be available as a dropdown menu. We will retrieve the metric selected for the assignment by the instructor and display it in the Heatgrid Map of reviews.</p>

<h2> Files to be targeted </h2>
<h3>Issue #1869</h3>
<p>For Heat grid</p>
* app/views/grades/_view_heatgrid.html.erb
* app/views/grades/view_team.html.erb
* app/helpers/grades_helper.rb
* app/controllers/grades_controller.rb
* app/models/vm_question_response.rb
* app/models/vm_question_row.rb
<p>For Assignment</p>
* app/views/assignment/edit/_general.html.erb
* app/controllers/assignments_controller.rb

<h2> Test Plan </h2>
* Capybara Test cases for testing the UI of heat grid view with the expected metric for the respective assignment and the UI of team view with relevant metric selected with all other metrics in the dropdown
* Spec test cases for testing the grades controller and assignment controller to check if they are returning the values as expected
* Unit test cases will be added to verify the logic behind the methods to calculate the values for their metrics

<h2> Important Links </h2>
* GitHub repository link: https://github.com/EshwarCVS/expertiza
* Project Description Document: https://docs.google.com/document/d/1H0BjzMBz5it7Wckhegq4LXhMi8RVctTwVzP2x9gnFCo/edit#heading=h.tqdrrd12xs4x
* GitHub Issue #1869: https://github.com/expertiza/expertiza/issues/1869
* GitHub Issue #2019: https://github.com/expertiza/expertiza/issues/2019

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:10:42Z

Ethedla:

This page provides information about the refactoring work done on the reputation web service controller as part of the OSS project.

__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
*Nicholas Himes (nnhimes)
<h3> Team Members (PinkPatterns) </h3>
* Eshwar Chandra Vidhyasagar Thedla (ethedla)
* Gokul Krishna Koganti (gkogant)
* Jyothi Sumer Goud Maduru (jmaduru)
* Suneha Bose (sbose2)

<h2> Heat Grid </h2>

Heat Grid refers to a part of view in expertiza that shows review scores of all the reviews done for a particular assignment. It shows scores given for each rubric by peer reviewers. This is used by instructors to assign scores to individual assignments and by students to view review scores of their assignment. Our project scope involves dealing with fixing issues related to the heat grid and any subsequent bugs that might arrive.

<h2> Issues identified </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p> There are some instances where a student was shown as reviewing his/her team. This is impossible and is classified as a bug. This must be dealt with. Test cases must be extensively added so that we can be notified if the bug occurs again. </p>
<h3> Deal with the metrics of the heat grid (Issue #1869)</h3>
<p> <b>metric-1</b> column name in the heat grid follows bad naming convention. It doesn't explain what the column refers to. This must be changed to make the column name more apt.</p>
<p> As of now, the heat grid uses only one metric (metric-1). We must facilitate the system for addition of new metrics. Instructors should be able to toggle between various metrics as per their preferences. This can be done by the use of a drop down menu.</p>

<h2> Current Implementation </h2>

<h2> Plan of work </h2>
<h3> Restrict teammates from reviewing their own work (Issue #2019)</h3>
<p>Relevant bug of this issue can’t be reproduced to deal with it. So comprehensive test cases must be written to be notified if the bug arises again. We are planning to add rspec unit tests covering the following cases:
</p>
<ul>
<li><b> If the instructor unchecks “ Allow self review” option</b></li>
<ol>
<li> Instructor should not be able to assign a student to review work that he/she has submitted. </li>
<li> Instructor should not be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should not be able to review work he/she has submitted.</li>
<li> Students should not be able to review work a teammate has submitted.</li>
</ol>
<li><b> If the instructor checks “ Allow self review” option</b></li>
<ol>
<li> Instructor should be able to assign a student to review work that he/she has submitted.</li>
<li> Instructor should be able to assign a student to review work that their teammate has submitted.</li>
<li> Students should be able to review work he/she has submitted. </li>
<li> Students should be able to review work a teammate has submitted.</li>
</ol>
</ul>
<h2> Files to be targeted </h2>
<h3>Issue #1869</h3>
<p>For Heat grid</p>
* app/views/grades/_view_heatgrid.html.erb
* app/views/grades/view_team.html.erb
* app/helpers/grades_helper.rb
* app/controllers/grades_controller.rb
* app/models/vm_question_response.rb
* app/models/vm_question_row.rb
<p>For Assignment</p>
* app/views/assignment/edit/_general.html.erb
* app/controllers/assignments_controller.rb

<h2> Test Plan </h2>
* Capybara Test cases for testing the UI of heat grid view with the expected metric for the respective assignment and the UI of team view with relevant metric selected with all other metrics in the dropdown
* Spec test cases for testing the grades controller and assignment controller to check if they are returning the values as expected
* Unit test cases will be added to verify the logic behind the methods to calculate the values for their metrics

<h2> Important Links </h2>
* GitHub repository link: https://github.com/EshwarCVS/expertiza
* Project Description Document: https://docs.google.com/document/d/1H0BjzMBz5it7Wckhegq4LXhMi8RVctTwVzP2x9gnFCo/edit#heading=h.tqdrrd12xs4x
* GitHub Issue #1869: https://github.com/expertiza/expertiza/issues/1869
* GitHub Issue #2019: https://github.com/expertiza/expertiza/issues/2019

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:09:33Z

Ethedla:

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:03:55Z

Ethedla:

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T02:00:48Z

Ethedla:

CSC/ECE 517 Spring 2022 - E2241: Heatgrid fixes and improvements

2022-04-07T01:52:30Z

Ethedla:

CSC/ECE 517 Spring 2022 - E2220: Refactor reputation web service controller

2022-03-22T02:32:42Z

Ethedla:

This page provides information about the refactoring work done on the reputation web service controller as part of the OSS project.

__TOC__

<h2> Team </h2>
<h3> Mentor </h3>
* Naman Shrimali (nshrima)
<h3> Team Members (MissingSemicolon) </h3>
* Eshwar Chandra Vidhyasagar Theda (ethedla)
* Gokul Krishna Koganti (gkogant)
* Krishna Saurabh Vankadaru (kvankad)

<h2> Expertiza </h2>

Expertiza is an assignment management portal. This portal can be used by instructors to create assignments . It can be used by students to submit their academic works and peer review others' works. Expertiza allows students to
create, join and work in teams.

<h2> Background of reputation web service controller </h2>

Expertiza provides a way for students to peer review others' works. The motive of this provision is to encourage students to learn more while reviewing others' works and utilize the reviews to reflect on the grades. However, to depend on the peer reviews, the reviews' credibility has to be established. This credibility can be evaluated through reputation scores computed by reputation systems. These systems are deployed as web services and facilitate the calculation of past and present assignment scores for peer review research.

In the project's scope, we focus on the aspect of refactoring the file reputation_web_service_controller.rb. This is a controller file used for the calculation of reputation scores. This is measured based on how close the current review scores are to the other.

<h2> Issues identified </h2>
<ol>
<li> Some methods are violating the single responsibility principle, i.e, some methods are doing more than one tasks. These methods must be broken down such that each method performs only one task. </li>
<li> In send_post_request, references to specific assignments, such as 724, 735, and 756 are no longer relevant and must be removed. </li>
<li> Password for a private key is place in the code. As this code is open-sourced, this causes security concerns and must be handled.</li>
<li> Some method names followed bad naming convention. These method names are general and are in noun forms. Specific relevant names must be used as method names.</li>
<li> Detailed method descriptions are needed to be inserted into the code as comments.</li>
<li> Client is a bad method name and needs to be changed.</li>
<li> There is a lot of unused/commented code, which should be removed.</li>
<li> Some spelling mistakes are identified in the code.</li>
</ol>

<h2> Enhancements </h2>
<h3> Functionality Fixes</h3>
<ol>
<li> The case of when a post request to reputation web service fails is not handled properly, resulting in a long error message on the view. This error has been handled to display formatted error on the page. <br/>
<b>Commit link: </b> https://github.com/krishnasaurabh/expertiza/pull/15/commits/84c9f30f9ee29759b5a41c9d11cda53c298fe49b </li><br/>

<li> Commented out the part of encryption and decryption as the public key files are not available.<br/>
<b> Commit link: </b> https://github.com/krishnasaurabh/expertiza/pull/15/commits/db83d497dd284cf0700d219f1b225f2d6c508ac8 </li><br/>

<li> In send_post_request (old version, currently prepare_request_body), init_header has been removed and requested & response JSON has been displayed in the beautify JSON for the implemented algorithms. This is done by using constant objects instead of URL strings. <br/>
<b> Commit link: </b>https://github.com/krishnasaurabh/expertiza/pull/17/commits/f343438383d56d577648ef4dd91de4fc3501449a</li><br/>

<li> When the control is redirected to the client, in the older versions, the data was being passed through the use of instance variables. Now, the parameters are being passed using flash.<br/>
<b> Commit link: </b>https://github.com/krishnasaurabh/expertiza/pull/15/commits/bf2ab75eb7b25e6d0b79791610beb371383b6042</li>

</ol>
<h3> Refactoring </h3>
<h4> Introduced single responsibility principle to the functions</h4>
<p> All the functions are modified in a way to concur with the single responsibility principle i.e, each function performs only one considerable task.</p>
<p>The following functions violated SRP:</p><ol>
<li> The <b>db_query</b> method not only queries, but calculates sums.</li>
<li> The <b>json_generator</b>method not only generates json, but also queries the database based on the ‘type’ it receives.</li>
<li> The <b>send_post_request</b> not only sends a post request, but generates a body based on parameters received, encrypts the data, hits the post request, decrypts the response data, and updates participants.</li>
</ol>

<h4> Removed unnecessary references in the send_post_request body</h4>
<p>In send_post_request, there are references to specific assignments, such as 724, 735, and 756. They were put in to gather data for a paper published in 2015. They are no longer relevant and are removed. Relevant tests are also removed.</p>
<h4> Changed method names to be more meaningful</h4>
<h4> Function description</h4>
<p> In the older version, controller's functions did not have function descriptions. In the current version, a detailed functional description has been added to each method. Additionally, descriptions include what parameters are accepted and what is returned.</p>
<h4> Removed unnecessary code</h4>
<p>Commented code blocks that are unused are found and deleted from the controller's body. RSA Encryption and Decryption are not being used for now. Such code is commented out for potential future use. </p>
<h4> Corrected spelling mistakes </h4>
<p> Only one instance of spelling error has been identified i.e, dimention. It has been corrected.</p>

<h2> Manual Testing </h2>

[[File:Manual_Testing.png|800px]]

<p>Before sending the request, please assign values for assignment_id and round, choose an algorithm.</p>

<h2> Testing via rspec </h2>

<pre> rspec spec/controllers/reputation_web_service_controller_spec.rb </pre>

<h2> Future Work </h2>
<ol>
<li> Client view has checkboxes for choosing between the action to be performed. But only the first checked action is being considered. This has to be fixed by the use of radio buttons.
<li> Hamer and Lauw actions are not resulting in any functional implementations. These algorithms have to be implemented.</li>
</ol>

<h2> GitHub Repository and Pull Request links </h2>

Link to the Expertiza repository: https://github.com/expertiza/expertiza <br/>
Link to the forked repository: https://github.com/krishnasaurabh/expertiza/tree/beta <br/>
Link to the pull request: https://github.com/expertiza/expertiza/pull/2291 <br/>

CSC/ECE 517 Spring 2022 - E2220: Refactor reputation web service controller

2022-03-22T01:13:39Z

Ethedla:

CSC/ECE 517 Spring 2022 - E2220: Refactor reputation web service controller

2022-03-22T00:39:59Z

Ethedla:

File:Manual Testing.png

2022-03-22T00:37:36Z

Ethedla: Manual Testing

Manual Testing