Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-12T04:06:44Z

Kpallav: /* Test Plan */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

Solution: Instead of response_map.score, we create a get_score method in ResponseMap model.

[[File:E2474 calculate score.png|600px]]

==== process_answers ====
This method attempts to edit the submitted_answer field in ResponseMap. This should be done by ResponseMap model instead of our controller.

Solution: We will fully move the process_answers method into the ResponseMap model.

[[File:E2474 process answer.png|600px]]

==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

Solution: Instead of "current_user.role_id == 2", we will make use of the instructor? method in Role to check if the current user is an instructor.

[[File:E2474 check instructor role.png|600px]]

==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

Solution: We will move this method into a separate concern that is included in this controller. This can be used in other controllers as well.

[[File:E2474_renaming_variables.png|600px]]

=== New Skippable Feature ===
We plan to add a new field for questions that allows the instructor to decide whether a question is required or skippable. This can be extended outside of quizzes.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: [https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd Link]
process_answers Commit: [https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5 Link]
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b Link]
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9 Link]
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd Link]
|-
|5
| <code> assign_quiz_to_student </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142 Link]
|}

== Implementation ==
=== Files Added or Changed ===
* Added student_quizzes_controller.rb
* Changed ResponseMap.rb
* Added resource_finder.rb
* Changed question.rb and questionnaire.rb

=== Changes Made ===

{| class="wikitable" style="width: 100%;
!  #  !! Change Description !! Old !! New
|-
|1
| Initially, we calculate_score directly called the score variable in the controller. We decided to implement a get score to adhere to SRP. We also implemented a new calculate_score as the old version did not implement a method that calculates anything.
| [[File:E2474 calculate score.png|600px]]
| [[File:E2474_calculate_score_new.png|600px]]
|-
|2
| We moved all of process_answer into ResponseMap to adhere with SRP.
| [[File:E2474 process answer.png|600px]]
| [[File:E2474 process answer new.png|600px]]
|-
|3
| find_resource_by_id was called frequently in this controller, so we moved this into a separate concern which is called in this controller. The file for this is resource_finder.rb.
| [[File:E2474_renaming_variables.png|600px]]
| [[File:E2474 find resource by id new.png|600px]]
|-
|4
| check_instructor_role used to check the role ID number, which violates SRP. We decided to use the instructor? method for role to determine if the current user is an instructor.
| [[File:E2474 check instructor role.png|600px]]
| [[File:E2474 check instructor role new.png|600px]]
|-
|5
| Added some new functionality to make questions skippable or not skippable in questionnaires. This includes changes in the database schema to add this new field.
| No old code.
| [[File:E2474 skippable.png|600px]]
|-
|6
| Clearer method names and method comments were added in this controller. One example is assign_quiz_to_student, which is shown in the images.
| [[File:E2474 assign quiz old.png|300px]]
| [[File:E2474 assign quiz new.png|300px]]
|}

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions. Examples of what we have done are shown below.

*POST /api/v1/students_quizzes: Endpoint to login as the instructor

[[File:Postman.png|500px]]

*POST /api/v1/students_quizzes: Endpoint to create a quiz

[[File:cQuiz.png|500px]]

*POST /api/v1/students_quizzes/assign: Endpoint to assign quiz to participant

[[File:AssignQuiz.png|500px]]

*POST /api/v1/students_quizzes/submit_quiz: Endpoint to submit answers

[[File:sAnswers.png|500px]]

*GET /api/v1/students_quizzes/7/get_score: Endpoint to get score and for this test use 7 as our response id

[[File:GetScore.png|500px]]

*PUT /api/v1/students_quizzes/9: Endpoint to update quiz

[[File:UQuiz.png|500px]]

*DEL /api/v1/students_quizzes/3: Endpoint to delete a quiz

[[File:DQuiz.png|500px]]

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Future Work ==
* More methods can be moved into other models to respect MVC including quiz_already_assigned?, find_response_map_for_current_user, etc.
* Some method names can be further improved.
* Some frontend changes may need to be added to include the new skippable feature added.
* More testing can be added to test new features that have been added thoroughly.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

File:DQuiz.png

2024-12-12T04:06:04Z

Kpallav:

File:UQuiz.png

2024-12-12T04:05:16Z

Kpallav:

File:GetScore.png

2024-12-12T04:04:05Z

Kpallav:

File:SAnswers.png

2024-12-12T04:03:35Z

Kpallav:

File:AssignQuiz.png

2024-12-12T04:02:36Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-12T04:01:54Z

Kpallav: /* Test Plan */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

Solution: Instead of response_map.score, we create a get_score method in ResponseMap model.

[[File:E2474 calculate score.png|600px]]

==== process_answers ====
This method attempts to edit the submitted_answer field in ResponseMap. This should be done by ResponseMap model instead of our controller.

Solution: We will fully move the process_answers method into the ResponseMap model.

[[File:E2474 process answer.png|600px]]

==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

Solution: Instead of "current_user.role_id == 2", we will make use of the instructor? method in Role to check if the current user is an instructor.

[[File:E2474 check instructor role.png|600px]]

==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

Solution: We will move this method into a separate concern that is included in this controller. This can be used in other controllers as well.

[[File:E2474_renaming_variables.png|600px]]

=== New Skippable Feature ===
We plan to add a new field for questions that allows the instructor to decide whether a question is required or skippable. This can be extended outside of quizzes.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: [https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd Link]
process_answers Commit: [https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5 Link]
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b Link]
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9 Link]
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd Link]
|-
|5
| <code> assign_quiz_to_student </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142 Link]
|}

== Implementation ==
=== Files Added or Changed ===
* Added student_quizzes_controller.rb
* Changed ResponseMap.rb
* Added resource_finder.rb
* Changed question.rb and questionnaire.rb

=== Changes Made ===

{| class="wikitable" style="width: 100%;
!  #  !! Change Description !! Old !! New
|-
|1
| Initially, we calculate_score directly called the score variable in the controller. We decided to implement a get score to adhere to SRP. We also implemented a new calculate_score as the old version did not implement a method that calculates anything.
| [[File:E2474 calculate score.png|600px]]
| [[File:E2474_calculate_score_new.png|600px]]
|-
|2
| We moved all of process_answer into ResponseMap to adhere with SRP.
| [[File:E2474 process answer.png|600px]]
| [[File:E2474 process answer new.png|600px]]
|-
|3
| find_resource_by_id was called frequently in this controller, so we moved this into a separate concern which is called in this controller. The file for this is resource_finder.rb.
| [[File:E2474_renaming_variables.png|600px]]
| [[File:E2474 find resource by id new.png|600px]]
|-
|4
| check_instructor_role used to check the role ID number, which violates SRP. We decided to use the instructor? method for role to determine if the current user is an instructor.
| [[File:E2474 check instructor role.png|600px]]
| [[File:E2474 check instructor role new.png|600px]]
|-
|5
| Added some new functionality to make questions skippable or not skippable in questionnaires. This includes changes in the database schema to add this new field.
| No old code.
| [[File:E2474 skippable.png|600px]]
|-
|6
| Clearer method names and method comments were added in this controller. One example is assign_quiz_to_student, which is shown in the images.
| [[File:E2474 assign quiz old.png|300px]]
| [[File:E2474 assign quiz new.png|300px]]
|}

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions. Examples of what we have done are shown below.

*POST /api/v1/students_quizzes: Endpoint to login as the instructor

[[File:Postman.png|500px]]

*POST /api/v1/students_quizzes: Endpoint to create a quiz

[[File:cQuiz.png|500px]]

*POST /api/v1/students_quizzes/assign: Endpoint to assign quiz to participant

image

*POST /api/v1/students_quizzes/submit_quiz: Endpoint to submit answers

image

*GET /api/v1/students_quizzes/7/get_score: Endpoint to get score and for this test use 7 as our response id

image

*PUT /api/v1/students_quizzes/9: Endpoint to update quiz

image

*DEL /api/v1/students_quizzes/3: Endpoint to delete a quiz

image

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Future Work ==
* More methods can be moved into other models to respect MVC including quiz_already_assigned?, find_response_map_for_current_user, etc.
* Some method names can be further improved.
* Some frontend changes may need to be added to include the new skippable feature added.
* More testing can be added to test new features that have been added thoroughly.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

File:CQuiz.png

2024-12-12T04:00:41Z

Kpallav:

File:CreateQuiz.png

2024-12-12T03:28:51Z

Kpallav: Kpallav uploaded a new version of File:CreateQuiz.png

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-12T03:28:04Z

Kpallav: /* Test Plan */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

Solution: Instead of response_map.score, we create a get_score method in ResponseMap model.

[[File:E2474 calculate score.png|600px]]

==== process_answers ====
This method attempts to edit the submitted_answer field in ResponseMap. This should be done by ResponseMap model instead of our controller.

Solution: We will fully move the process_answers method into the ResponseMap model.

[[File:E2474 process answer.png|600px]]

==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

Solution: Instead of "current_user.role_id == 2", we will make use of the instructor? method in Role to check if the current user is an instructor.

[[File:E2474 check instructor role.png|600px]]

==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

Solution: We will move this method into a separate concern that is included in this controller. This can be used in other controllers as well.

[[File:E2474_renaming_variables.png|600px]]

=== New Skippable Feature ===
We plan to add a new field for questions that allows the instructor to decide whether a question is required or skippable. This can be extended outside of quizzes.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: [https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd Link]
process_answers Commit: [https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5 Link]
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b Link]
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9 Link]
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd Link]
|-
|5
| <code> assign_quiz_to_student </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142 Link]
|}

== Implementation ==
=== Files Added or Changed ===
* Added student_quizzes_controller.rb
* Changed ResponseMap.rb
* Added resource_finder.rb
* Changed question.rb and questionnaire.rb

=== Changes Made ===

{| class="wikitable" style="width: 100%;
!  #  !! Change Description !! Old !! New
|-
|1
| Initially, we calculate_score directly called the score variable in the controller. We decided to implement a get score to adhere to SRP. We also implemented a new calculate_score as the old version did not implement a method that calculates anything.
| [[File:E2474 calculate score.png|600px]]
| [[File:E2474_calculate_score_new.png|600px]]
|-
|2
| We moved all of process_answer into ResponseMap to adhere with SRP.
| [[File:E2474 process answer.png|600px]]
| [[File:E2474 process answer new.png|600px]]
|-
|3
| find_resource_by_id was called frequently in this controller, so we moved this into a separate concern which is called in this controller. The file for this is resource_finder.rb.
| [[File:E2474_renaming_variables.png|600px]]
| [[File:E2474 find resource by id new.png|600px]]
|-
|4
| check_instructor_role used to check the role ID number, which violates SRP. We decided to use the instructor? method for role to determine if the current user is an instructor.
| [[File:E2474 check instructor role.png|600px]]
| [[File:E2474 check instructor role new.png|600px]]
|-
|5
| Added some new functionality to make questions skippable or not skippable in questionnaires. This includes changes in the database schema to add this new field.
| No old code.
| [[File:E2474 skippable.png|600px]]
|-
|6
| Clearer method names and method comments were added in this controller. One example is assign_quiz_to_student, which is shown in the images.
| [[File:E2474 assign quiz old.png|300px]]
| [[File:E2474 assign quiz new.png|300px]]
|}

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions. Examples of what we have done are shown below.

*POST /api/v1/students_quizzes: Endpoint to login as the instructor

[[File:Postman.png|500px]]

*POST /api/v1/students_quizzes: Endpoint to create a quiz

image

*POST /api/v1/students_quizzes/assign: Endpoint to assign quiz to participant

image

*POST /api/v1/students_quizzes/submit_quiz: Endpoint to submit answers

image

*GET /api/v1/students_quizzes/7/get_score: Endpoint to get score and for this test use 7 as our response id

image

*PUT /api/v1/students_quizzes/9: Endpoint to update quiz

image

*DEL /api/v1/students_quizzes/3: Endpoint to delete a quiz

image

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Future Work ==
* More methods can be moved into other models to respect MVC including quiz_already_assigned?, find_response_map_for_current_user, etc.
* Some method names can be further improved.
* Some frontend changes may need to be added to include the new skippable feature added.
* More testing can be added to test new features that have been added thoroughly.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-12T03:14:33Z

Kpallav: /* Test Plan */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

Solution: Instead of response_map.score, we create a get_score method in ResponseMap model.

[[File:E2474 calculate score.png|600px]]

==== process_answers ====
This method attempts to edit the submitted_answer field in ResponseMap. This should be done by ResponseMap model instead of our controller.

Solution: We will fully move the process_answers method into the ResponseMap model.

[[File:E2474 process answer.png|600px]]

==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

Solution: Instead of "current_user.role_id == 2", we will make use of the instructor? method in Role to check if the current user is an instructor.

[[File:E2474 check instructor role.png|600px]]

==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

Solution: We will move this method into a separate concern that is included in this controller. This can be used in other controllers as well.

[[File:E2474_renaming_variables.png|600px]]

=== New Skippable Feature ===
We plan to add a new field for questions that allows the instructor to decide whether a question is required or skippable. This can be extended outside of quizzes.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: [https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd Link]
process_answers Commit: [https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5 Link]
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b Link]
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9 Link]
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd Link]
|-
|5
| <code> assign_quiz_to_student </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142 Link]
|}

== Implementation ==
=== Files Added or Changed ===
* Added student_quizzes_controller.rb
* Changed ResponseMap.rb
* Added resource_finder.rb
* Changed question.rb and questionnaire.rb

=== Changes Made ===

{| class="wikitable" style="width: 100%;
!  #  !! Change Description !! Old !! New
|-
|1
| Initially, we calculate_score directly called the score variable in the controller. We decided to implement a get score to adhere to SRP. We also implemented a new calculate_score as the old version did not implement a method that calculates anything.
| [[File:E2474 calculate score.png|600px]]
| [[File:E2474_calculate_score_new.png|600px]]
|-
|2
| We moved all of process_answer into ResponseMap to adhere with SRP.
| [[File:E2474 process answer.png|600px]]
| [[File:E2474 process answer new.png|600px]]
|-
|3
| find_resource_by_id was called frequently in this controller, so we moved this into a separate concern which is called in this controller. The file for this is resource_finder.rb.
| [[File:E2474_renaming_variables.png|600px]]
| [[File:E2474 find resource by id new.png|600px]]
|-
|4
| check_instructor_role used to check the role ID number, which violates SRP. We decided to use the instructor? method for role to determine if the current user is an instructor.
| [[File:E2474 check instructor role.png|600px]]
| [[File:E2474 check instructor role new.png|600px]]
|-
|5
| Added some new functionality to make questions skippable or not skippable in questionnaires. This includes changes in the database schema to add this new field.
| No old code.
| [[File:E2474 skippable.png|600px]]
|-
|6
| Clearer method names and method comments were added in this controller. One example is assign_quiz_to_student, which is shown in the images.
| [[File:E2474 assign quiz old.png|300px]]
| [[File:E2474 assign quiz new.png|300px]]
|}

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions. Examples of what we have done are shown below.

*POST /api/v1/students_quizzes: Endpoint to login as the instructor

[[File:Postman.png|500px]]

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Future Work ==
* More methods can be moved into other models to respect MVC including quiz_already_assigned?, find_response_map_for_current_user, etc.
* Some method names can be further improved.
* Some frontend changes may need to be added to include the new skippable feature added.
* More testing can be added to test new features that have been added thoroughly.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

File:Postman.png

2024-12-12T03:10:10Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-12T02:56:59Z

Kpallav: /* Main Methods to Create or Enhance */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

Solution: Instead of response_map.score, we create a get_score method in ResponseMap model.

[[File:E2474 calculate score.png|600px]]

==== process_answers ====
This method attempts to edit the submitted_answer field in ResponseMap. This should be done by ResponseMap model instead of our controller.

Solution: We will fully move the process_answers method into the ResponseMap model.

[[File:E2474 process answer.png|600px]]

==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

Solution: Instead of "current_user.role_id == 2", we will make use of the instructor? method in Role to check if the current user is an instructor.

[[File:E2474 check instructor role.png|600px]]

==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

Solution: We will move this method into a separate concern that is included in this controller. This can be used in other controllers as well.

[[File:E2474_renaming_variables.png|600px]]

=== New Skippable Feature ===
We plan to add a new field for questions that allows the instructor to decide whether a question is required or skippable. This can be extended outside of quizzes.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: [https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd Link]
process_answers Commit: [https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5 Link]
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b Link]
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9 Link]
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd Link]
|-
|5
| <code> assign_quiz_to_student </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' [https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142 Link]
|}

== Implementation ==
=== Files Added or Changed ===
* Added student_quizzes_controller.rb
* Changed ResponseMap.rb
* Added resource_finder.rb
* Changed question.rb and questionnaire.rb

=== Changes Made ===

{| class="wikitable" style="width: 100%;
!  #  !! Change Description !! Old !! New
|-
|1
| Initially, we calculate_score directly called the score variable in the controller. We decided to implement a get score to adhere to SRP. We also implemented a new calculate_score as the old version did not implement a method that calculates anything.
| [[File:E2474 calculate score.png|600px]]
| [[File:E2474_calculate_score_new.png|600px]]
|-
|2
| We moved all of process_answer into ResponseMap to adhere with SRP.
| [[File:E2474 process answer.png|600px]]
| [[File:E2474 process answer new.png|600px]]
|-
|3
| find_resource_by_id was called frequently in this controller, so we moved this into a separate concern which is called in this controller. The file for this is resource_finder.rb.
| [[File:E2474_renaming_variables.png|600px]]
| [[File:E2474 find resource by id new.png|600px]]
|-
|4
| check_instructor_role used to check the role ID number, which violates SRP. We decided to use the instructor? method for role to determine if the current user is an instructor.
| [[File:E2474 check instructor role.png|600px]]
| [[File:E2474 check instructor role new.png|600px]]
|-
|5
| Added some new functionality to make questions skippable or not skippable in questionnaires. This includes changes in the database schema to add this new field.
| No old code.
| [[File:E2474 skippable.png|600px]]
|-
|6
| Clearer method names and method comments were added in this controller. One example is assign_quiz_to_student, which is shown in the images.
| [[File:E2474 assign quiz old.png|300px]]
| [[File:E2474 assign quiz new.png|300px]]
|}

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Future Work ==
* More methods can be moved into other models to respect MVC including quiz_already_assigned?, find_response_map_for_current_user, etc.
* Some method names can be further improved.
* Some frontend changes may need to be added to include the new skippable feature added.
* More testing can be added to test new features that have been added thoroughly.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-11T05:19:32Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9
|-
|4
| <code> build_response_map </code>
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/9b3c0342c6a407766e38ea2cb860434cbf10efcd
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Student quizzes Controller contains APIs which allows the instructor to create a new quiz and perform other CRUD operations on quiz. It allows the students to submit answers to the quizzes and check their scores. Our implementation plan includes reimplementing existing methods and adding new methods. Student quizzes Controller does now adhere to best practices while ensuring that existing functionalities remain unchanged.

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-11T05:17:03Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/55d860747ff08506aea134e182d98119eadc58e9
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| ''' Commit: '''
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Student quizzes Controller contains APIs which allows the instructor to create a new quiz and perform other CRUD operations on quiz. It allows the students to submit answers to the quizzes and check their scores. Our implementation plan includes reimplementing existing methods and adding new methods. Student quizzes Controller does now adhere to best practices while ensuring that existing functionalities remain unchanged.

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-11T05:09:36Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| Placeholder for Commit.
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| Placeholder for Commit.
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Student quizzes Controller contains APIs which allows the instructor to create a new quiz and perform other CRUD operations on quiz. It allows the students to submit answers to the quizzes and check their scores. Our implementation plan includes reimplementing existing methods and adding new methods. Student quizzes Controller does now adhere to best practices while ensuring that existing functionalities remain unchanged.

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/141
* '''Demo Video Link:''' https://youtu.be/hi_4GVLCpdY

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-04T04:58:36Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, set_student_quiz, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]
==== Other methods ====
* Multiple methods have code repetition that can be reduced in this controller. These include find_or_initialize_response and assign_quiz_to_student.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| Placeholder for Commit.
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, <code> set_student_quiz </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| Placeholder for Commit.
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Student quizzes Controller contains APIs which allows the instructor to create a new quiz and perform other CRUD operations on quiz. It allows the students to submit answers to the quizzes and check their scores. Our implementation plan includes reimplementing existing methods and adding new methods. Student quizzes Controller does now adhere to best practices while ensuring that existing functionalities remain unchanged.

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' (placeholder for later)

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-04T04:16:57Z

Kpallav: /* Main Methods to Create or Enhance */

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, set_student_quiz, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]
==== Other methods ====
* Multiple methods have code repetition that can be reduced in this controller. These include find_or_initialize_response and assign_quiz_to_student.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
|''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| Placeholder for Commit.
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, <code> set_student_quiz </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| Placeholder for Commit.
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Section to place our work in (Placeholder).

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' (placeholder for later)

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-04T04:16:35Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, set_student_quiz, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]
==== Other methods ====
* Multiple methods have code repetition that can be reduced in this controller. These include find_or_initialize_response and assign_quiz_to_student.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
| ''' calculate_score Commit: https://github.com/neerua08/reimplementation-back-end/commit/c1dd8c817d842df0817bde8fa408d760fb0a6fdd
''' process_answers Commit: https://github.com/neerua08/reimplementation-back-end/commit/dacecb623bbfa8cfff89a3c6deaa8affd8eaf0f5
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| Placeholder for Commit.
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, <code> set_student_quiz </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| Placeholder for Commit.
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Section to place our work in (Placeholder).

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' (placeholder for later)

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-04T04:12:01Z

Kpallav:

This wiki page is about E2474 Phase 2 for Expertiza.

== Background ==
[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. The Expertiza project is software for creating reusable learning objects through peer review. It also supports team projects and the submission of almost any document type, including URLs and wiki pages. The goal is to foster team collaboration through projects and provide a robust way to give feedback for these projects.

== Problem Statement ==
For this project, we are expected to reimplement the student_quizzes_controller.rb file in the reimplementation-backend repository of Expertiza. This controller handles scoring, creating, and recording responses for quizzes that are done by students or reviewers for an assignment. The main issue with the previous implementation is that it violates several Rails design principles such as DRY violations. Along with this, various other issues that need to be addressed include code repetition, unclear method comments, and ambiguous variable names. The overall idea of this project is to ensure that we maintain the previous functionality while adhering to the best design practices.

=== Specific Issues ===
* Single-Responsibility Principle - Various functionalities are done in the student_quizzes_controller.rb that should be deferred to other models or controllers.
* DRY Violations - There is a good amount of code repetition in the code that could be consolidated to a method.
* Unclear Method and Variable Names - There are ambiguous methods names and variable names that should be changed. We can also add method comments to help explain functionality.

== Design Plan ==
=== Single-Responsibility Principle ===
==== calculate_score ====
This method gets a response map and then gets the score from that response map. We can instead ask the ResponseMap model to get this information.

[[File:E2474 calculate score.png|600px]]
==== process_answers ====
This method attempts to edit the submitted_answer field in response map. This should be done by ResponseMap model instead of our controller.

[[File:E2474 process answer.png|600px]]
==== check_instructor_role ====
The goal of this method is to get the role ID of the user to make sure they are an instructor. We want to let the Role model check this instead of checking it in the controller.

[[File:E2474 check instructor role.png|600px]]
==== Other methods ====
* Several methods could be moved into the model classes in adherence to MVC architecture. This includes create_questionaire, build_response_map, set_student_quiz, etc.

=== DRY Violations ===
==== find_resource_by_id ====
This is a method that is frequently called in this controller. We plan to separate this functionality into a concern or a shared utility function.

[[File:E2474_renaming_variables.png|600px]]
==== Other methods ====
* Multiple methods have code repetition that can be reduced in this controller. These include find_or_initialize_response and assign_quiz_to_student.

=== Renaming Method and Variable Names ===
* Rename the methods for assign_quiz_to_student and submit_answer to clarify their purpose. We can also add method comments to help with this.
* Refactor variable names to better reflect their purpose. The image below shows that model is not the best name along with find_resource_by_id
[[File:E2474_renaming_variables.png|600px]]

== Main Methods to Create or Enhance ==

{| class="wikitable" style="width: 100%;
!  #  !! Method !! Purpose !! Description !! Commit
|-
|1
| <code> calculate_score </code>, <code> process_answers </code>
| Ensure MVC compliance and adherence to the Single-Responsibility Principle
| Move both <code>calculate_score</code> and <code>process_answers</code> to the <code>ResponseMap</code> model, allowing the controller to focus only on handling requests and delegating logic to models.
| Placeholder for Commit.
|-
|2
| <code> find_resource_by_id </code>
| Reduce DRY violations
| Implement this as a shared utility function to eliminate duplicate code and streamline resource retrieval in the controller.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/0dc53dd139caa7d18d380c98d51578d98911ef3b
|-
|3
| <code> check_instructor_role </code>
| Improve code readability
| Move the <code>check_instructor_role</code> method to the <code>Role</code> model, ensuring that role-related logic resides within the model rather than the controller.
| Placeholder for Commit.
|-
|4
| <code> create_questionnaire </code>, <code> build_response_map </code>, <code> set_student_quiz </code>, etc.
| Improve modularity
| Transfer these methods from the controller to appropriate model classes, which aligns with the MVC pattern and keeps controller methods concise.
| Placeholder for Commit.
|-
|5
| <code> assign_quiz_to_student </code>, <code> submit_answer </code>
| Improve code readability
| Rename these methods to more descriptive names and add comments to explain functionality, making the codebase easier to understand and maintain.
| ''' Commit: ''' https://github.com/neerua08/reimplementation-back-end/commit/865857ea2dcc0eb73d87cff87e1610bf8ba6d142
|}

== Implementation ==
Section to place our work in (Placeholder).

== Test Plan ==
As we are reimplementing this file from scratch, we plan to do some manual testing to verify our code. If time permits, we can add some automated tests. Currently, we plan to use a variety of tools to test our code including:

* Postman - Test our API calls for the controller to ensure their functionality. The main purpose is to validate the behavior of the controller. This can be done by testing all relevant CRUD operations for quiz creation, submission, and scoring, verifying that the controller responds with appropriate status codes, ensure that all input validations are working as expected including edge cases, and validate that the controller adheres to any role-based access restrictions.

* Automated RSpec Tests - Test the various methods in our controller to determine if they are functioning as expected. The main purpose is to verify the internal logic of the controller and related methods ensuring they are functioning as expected. This can be done by creating unit tests for methods within the controller especially methods that will be refactored or moved to the model, creating model tests for if any logic is moved to the models to verify that the new functionality works correctly, and create controller tests to ensure that the controller actions work as expected like assigning quizzes to students, submitting answers and recording results, and calculating scores correctly.

* Black Box Testing - Running through the application to determine if any errors or inconsistent functionalities occur. The main purpose is to ensure the overall functionality of the system from the perspective of an end user.

* Test Coverage - Using SimpleCov to ensure sufficient test coverage of all key methods and code paths, preventing any untested code from being deployed. We can do this by integrating SimpleCov to measure code coverage across the entire application, create coverage goals and aim for like a high code coverage (e.g., 90% or higher) to ensure all key methods in the controller and related models are thoroughly tested, monitor coverage reports to identify any untested methods or areas of the codebase and add tests for those areas as needed, and refactor based on coverage so if we see significant gaps in test coverage, we can refactor the tests or implementation to ensure better coverage.

We don't plan on adding new scenarios but instead we plan on retesting scenarios: creating a new student quiz, handling invalid student quiz creation, calculating quiz score, assigning quiz to student, submitting quiz answers, and updating a student quiz to see if those scenarios still work when we reimplement student_quizzes_controller.rb as a whole. We might add multiple scenarios as we go.

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)
# Aarya Rajoju (arajoju@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2420._Reimplement_student_quizzes_controller This wiki page] contains detailed information on the previous team's work on this feature.
* '''Github Repository:''' https://github.com/neerua08/reimplementation-back-end
* '''Pull Request:''' (placeholder for later)

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-12-04T04:09:53Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T02:33:17Z

Kpallav: /* Test Plan */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T02:11:39Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T02:04:03Z

Kpallav: /* Test Plan */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:58:28Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:34:00Z

Kpallav: /* Test Plan */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:32:10Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:20:38Z

Kpallav: /* Main Methods to Create or Enhance */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:17:52Z

Kpallav: /* Main Methods to Create or Enhance */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:16:16Z

Kpallav: /* New and enhanced methods */

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T01:06:49Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T00:57:20Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2474. Reimplement student quizzes controller.rb

2024-11-13T00:48:30Z

Kpallav:

CSC/ECE 517 Fall 2024 - E2453. Refactor review mapping helper.rb

2024-10-30T03:31:14Z

Kpallav:

This wiki page is about E2453 for Expertiza.

== Background ==
Expertiza is software that uses Ruby on Rails to manage a website for managing assignments, teams, submissions, and reviews. This web application is managed by students and faculty at NC State, offering instructors full control over class assignments. Expertiza supports a variety of functions, including topic creation, group assignments, and peer review, making it a robust tool for handling diverse types of assignments. For a complete overview of Expertiza's capabilities, visit the Expertiza wiki.

== Problem Statement ==
The review_mapping_helper.rb file has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. The cyclomatic complexity of most of the methods is way too high as per the standard defined in Code Climate. The scope of this project is to refactor the review_mapping_helper.rb to make it more readable and reduce complexity. This file is generally used to hold helper methods for review frontend pages.

== Requirements ==

=== Complexity ===
There are several methods that exceed cyclomatic complexity and ABC complexity. This is the main priority for our refactoring.

=== Refactor for readability ===
* Several methods have confusing variable names and method names
* Some comments are unnecessary or are ambiguous.
* Some inconsistent formatting in the code.

== Files Modified ==
Only three files were changed as this file is not called in many other places. These are:
* app/helpers/review_mapping_helpers.rb
* app/views/reports/_review_report.html.erb
* spec/helpers/review_mapping_helper_spec.rb

== Changes Made ==

=== Cyclomatic Complexity ===

==== get_team_color ====

Old code:

[[File:E2453_old_get_team_color.png|700px]]

New code:

[[File:E2453_new_get_team_color.png|700px]]

This code exceeded cyclomatic complexity due to the nesting if statements. We can split the if statements into separate methods as they represent their own functionalities. This also reduces the ABC complexity as well.

==== check_submission_state ====

Old code:

[[File:E2453_old_check_submission_state.png|700px]]

New code:

[[File:E2453_new_check_submission_state.png|700px]]

This code exceeded cyclomatic complexity due to the nesting if statements. Along with this, the conditional is complicated enough to be its own method. We can split this into many methods to ensure the method is not doing too much.

Along with this, this method has 5 parameters, which is too much. We removed the colors parameter and decided to use colors outside the method so that we could push strings into it.

It also had an ABC complexity of 16.79 so the method split reduces this.

=== ABC Complexity ===

==== list_hyperlink_submission ====

Old code:

[[File:E2453_old_list_hyperlink_submission.png|700px]]

New code:

[[File:E2453_new_list_hyperlink_submission.png|700px]]

This code exceeded ABC complexity. Looking at this method, we can see that it is doing several functionalities at once. We can separate this into multiple methods for readability and reduced complexity.

==== sort_reviewer_by_review_volume_desc ====

Old code:

[[File:E2453_old_sort_reviewer_by_review_volume_desc.png|700px]]

New code:

[[File:E2453_new_sort_reviewer_by_review_volume_desc.png|700px]]

This method was the hardest to refactor as it was doing too much in one method. Initially, this had an ABC Complexity of 32.7, which is very high. We split the functionalities for getting volumes for each review and the average volume into its own private methods. This significantly reduced the ABC complexity of this method.

=== Renaming Variable Names and Methods ===
Several variables were ambiguously named. For example, rspan was supposed to represent the row number, but this is not obvious so we changed it to row_number.

Another example is using r to represent a reviewer. We change this to reviewer as it is more readable.

Along with this, we changed various method names as they can be ambiguous in terms of the intended function of these methods.

=== Consistent Formatting ===
There was a big portion of code that was indented inconsistently compared to the rest of the code. This was fixed.

Also, there was inconsitent spacing between methods, so we changed this spacing to be one line between each method.

=== Reformatting Test File ===
As we changed method names, we had to refactor the test file to match the new method names.

Along with this, get_team_color had a massive change in output, so we had to change the test to match the new version of the method.

== Testing ==
All of the tests pass for helpers. This is shown in the image below. We did not significantly alter the testing from the previous iteration.

[[File:E2453_testing.png]]

== Future Scope ==

# spec/helpers/review_mapping_helper_spec.rb has repetitive code that can be combined into a method
# There are parts of review_mapping_helper with long JSON data that exceeds line count. This could be migrated to a JSON file instead of storing it in the code. One example of this is the data variable from method display_volume_metric_chart.
# In review_mapping_helper.rb, there is a method get_css_style_for_calibration_report that should be moved to a different file.
# review_mapping_helper.rb can always use more refactoring for variable and method names

== Team Members ==
# Akhilesh Neeruganti (asneerug@ncsu.edu)
# Krishna Pallavalli (kpallav@ncsu.edu)

Mentor: Richard Li (rli14@ncsu.edu)

== Relevant Links ==
Github Pull Request - https://github.com/expertiza/expertiza/pull/2886

Github Repo - https://github.com/neerua08/Expertiza_Refactor_ReviewMappingHelper

[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2024_-_E2406_Refactor_review_mapping_helper.rb] contains detailed information on the previous team's work on this feature.