CSC/ECE 517 Spring 2025 - E2514. Reimplement student quizzes controller.rb

From Expertiza_Wiki
Jump to navigation Jump to search

Introduction

Expertiza is an educational web application collaboratively developed and maintained by students and faculty at NCSU. As an open-source project built on the Ruby on Rails platform, its code is accessible on GitHub. The platform enables students to provide peer reviews and refine their work based on feedback.

Project Overview

Quizzes in Expertiza are designed to ensure that reviewers comprehend the material they are evaluating. When an assignment includes quizzes, submitting teams create these quizzes based on their work. Reviewers must complete the quizzes before reviewing to demonstrate their understanding. If a reviewer performs poorly, their review can be discounted to maintain quality.

The student_quizzes_controller.rb manages quiz-related actions, including quiz creation, scoring, and recording responses for both students and reviewers. However, the existing implementation violates several key Rails principles, including the DRY (Don't Repeat Yourself) principle and the improper placement of business logic within the controller. Instead, this logic should reside in model classes, in adherence to the MVC (Model-View-Controller) architecture.

Previous Implementation

The previous implementation of the student_quizzes_controller.rb contained several design issues. While some progress was made, such as moving calculate_score and process_answers to the ResponseMap model and replacing role ID checks with Role model methods, several key issues remained. Business logic was still embedded in the controller, violating the Single Responsibility Principle (SRP). Method names were unclear, like set_student_quiz, and resource-finding logic was incorrectly placed in the controller. Additionally, quiz retake policies and question-skipping lacked adequate support. Testing coverage was also insufficient, and documentation needed improvement. Fixing these issues will significantly enhance the code's maintainability, clarity, and overall structure.

Project Goals

This project focuses on reimplementing student_quizzes_controller.rb in the reimplementation-backend repository, addressing issues from the previous implementation. Key improvements will include:

  • Improving method names and readability to better align with their purposes
  • Refactoring to remove redundant code and consolidate functionality into reusable functions
  • Enhancing test coverage and documentation clarity

By addressing these issues, the project aims to produce a well-structured, maintainable, and scalable student_quizzes_controller.rb that follows Rails best practices, improves code organization, and enhances the overall maintainability of the Expertiza platform.

Files Modified

  • app/models/response_map.rb
  • app/controllers/api/v1/student_quizzes_controller.rb
  • app/services/find_resource_service.rb

Changes Implemented

1) Moving Find Resource Out of Controller 

   app/controllers/api/v1/student_quizzes_controller.rb  
   

   app/services/find_resource_service.rb


2) Ensured deleting a quiz is handled correctly in student_quizzes_controller.rb

'

3) Renamed and improved method names


4) Implement self.assessment in Review Response Map 

   app/models/review_response_map.rb

Test files

We have added the tests in the following files:

  • spec/requests/api/v1/student_quizzes_controller_spec.rb
  • spec/requests/api/v1/find_resource_service_spec.rb
  • spec/requests/api/v1/find_resource_service_spec.rb

Github Pull Request

https://github.com/expertiza/reimplementation-back-end/pull/180

Mentor

Team Members

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2025_-_E2514._Reimplement_student_quizzes_controller.rb&oldid=162762"